Skip to main content
Who should use this guideThis guide is intended for merchants who:
  • Use Payrails as a payment orchestrator
  • Use MyFatoorah for card, mada and Apple Pay processing in the Gulf region
  • Have an active MyFatoorah account with API access

Create a MyFatoorah integration in Payrails

  1. Log in to the Payrails portal.
  2. Go to Settings → Integrations.
  3. Select Add instance to create a new integration configuration.
  4. Select the workspaces where this integration should be available.
About workspacesWorkspaces determine where this integration is available. They let you isolate provider setups by region or business line, or share the same configuration across multiple workspaces.

Step 1: Choose the integration type

  • Select Payment.
  • Continue to the next step.

Step 2: Choose the provider

  • Select MyFatoorah.
  • Continue to the next step.
A screenshot showing MyFatoorah selected as the provider.

Step 3: Configure your MyFatoorah integration

What you’ll need from MyFatoorahBefore you begin, make sure you have your MyFatoorah API key, the webhook secret key, and the payment method IDs MyFatoorah assigns to your account. MyFatoorah returns the IDs from its InitiatePayment API, or your MyFatoorah account manager can share them.

Integration instance name

An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for different regions, currencies, or business needs. Choose a clear, consistent name, as it is used in routing.
In Payrails
  • Enter an Instance name for your integration, for example merchant_myfatoorah.
A screenshot showing the integration instance name field.

MyFatoorah payment method identifiers

In Payrails Enter the MyFatoorah ID for each payment method you accept. Payrails picks the ID for each payment: A screenshot showing the MyFatoorah payment method identifier fields.

Credentials

In MyFatoorah
  • In the MyFatoorah portal, copy your API key, and the secret key of the webhook you create. Refer to Webhooks or notifications.
In Payrails Payrails sends requests to the MyFatoorah test environment in test mode. In live mode, it sends them to MyFatoorah’s API for the order’s country: Saudi Arabia, Qatar or the main region. A screenshot showing the MyFatoorah credential fields.

Payment methods

In Payrails
  • Select Card, Apple Pay or both.
A screenshot showing the MyFatoorah payment method selection.

Webhooks or notifications

Payrails uses provider webhooks or notifications to receive asynchronous payment status updates.
Create webhooks in the same mode (test or live) as your Payrails integration.
In Payrails
  • Copy the Notification URL shown under Account configuration at the top of the integration form.
In MyFatoorah
  1. In the MyFatoorah portal, open the webhook settings and enable webhooks.
  2. Enter the Payrails notification URL, and subscribe to transaction status changes and refund status changes.
  3. Copy the webhook secret key into Notifications Key in Payrails.

Request fields for MyFatoorah

Send these fields in the authorize request for card payments, in addition to the standard authorize fields. Required fields must be present for the payment to succeed. Payrails sends Optional fields to MyFatoorah when you include them. For more about meta fields, refer to Meta fields.

Enable the integration

In Payrails
  • Select Save account to enable the integration.
  • Confirm the integration shows as Enabled.
Your MyFatoorah integration is now ready to process payments.

Next steps

  1. Run a test payment in the MyFatoorah test environment.
  2. Verify that:
    • The payment appears in the MyFatoorah portal.
    • The payment status updates correctly in Payrails.
  3. Once verified in test mode, repeat the setup in live mode.
→ Continue to: Test a payment
Last modified on October 6, 2026