> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# MyFatoorah

> Connect MyFatoorah to Payrails for cards, mada and Apple Pay, covering payment method IDs, the API key and the webhook.

<Note>
  **Who should use this guide**

  This 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
</Note>

***

## 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.

<Note>
  **About workspaces**

  Workspaces 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.
</Note>

***

## 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.

<img src="https://mintcdn.com/payrails-42074109/95dm67yuCOH_Jo0o/images/docs/myfatoorah-image-01.png?fit=max&auto=format&n=95dm67yuCOH_Jo0o&q=85&s=1778e68d28a5dcffeab4d750fc24af4f" alt="A screenshot showing MyFatoorah selected as the provider." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/myfatoorah-image-01.png" />

***

## Step 3: Configure your MyFatoorah integration

<Tip>
  **What you'll need from MyFatoorah**

  Before 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.
</Tip>

***

### 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`.

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/orchestration/integrations/shared/integration-instance-name.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=470be58979509680650b0cbf8b5eecc4" alt="A screenshot showing the integration instance name field." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/orchestration/integrations/shared/integration-instance-name.png" />

***

### MyFatoorah payment method identifiers

**In Payrails**

Enter the MyFatoorah ID for each payment method you accept. Payrails picks the ID for each payment:

| Field | When Payrails uses it |
| :- | :- |
| **Visa/MasterCard ID** | Visa and Mastercard payments without 3D Secure |
| **Visa/MasterCard-3DS ID** | Visa and Mastercard payments with 3D Secure, when your request sets `meta.risk.threeDSMode` to `Force` |
| **Mada ID** | Mada cards |
| **Apple Pay ID** | Apple Pay payments |

<img src="https://mintcdn.com/payrails-42074109/95dm67yuCOH_Jo0o/images/docs/myfatoorah-image-02.png?fit=max&auto=format&n=95dm67yuCOH_Jo0o&q=85&s=8e2a713629fcb86468deca3e1f196a73" alt="A screenshot showing the MyFatoorah payment method identifier fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/myfatoorah-image-02.png" />

***

### 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](#webhooks-or-notifications).

**In Payrails**

| Field | Value |
| :- | :- |
| **API key** | Your MyFatoorah API key |
| **Notifications Key** | Your MyFatoorah webhook secret key. Payrails uses it to verify notifications from MyFatoorah. |

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.

<img src="https://mintcdn.com/payrails-42074109/95dm67yuCOH_Jo0o/images/docs/myfatoorah-image-03.png?fit=max&auto=format&n=95dm67yuCOH_Jo0o&q=85&s=874debece837669fbc2912c7b86118b4" alt="A screenshot showing the MyFatoorah credential fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/myfatoorah-image-03.png" />

***

### Payment methods

**In Payrails**

* Select **Card**, **Apple Pay** or both.

<img src="https://mintcdn.com/payrails-42074109/95dm67yuCOH_Jo0o/images/docs/myfatoorah-image-04.png?fit=max&auto=format&n=95dm67yuCOH_Jo0o&q=85&s=5bb0d08167ca40aa7fff75faa5e30549" alt="A screenshot showing the MyFatoorah payment method selection." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/myfatoorah-image-04.png" />

***

### Webhooks or notifications

<Info>
  Payrails uses provider webhooks or notifications to receive asynchronous
  payment status updates.
</Info>

<Warning>
  Create webhooks in the same mode (test or live) as your Payrails integration.
</Warning>

**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](/reference/authorizeaction) 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](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to MyFatoorah as the invoice value and display currency. |
| `meta.order.placement.country.code` | Required | Picks the MyFatoorah region in live mode, for example `SA` or `QA`. Send it on captures, cancels and refunds too. |
| `meta.customer.name`, `email`, `language`, `reference` | Optional | Sent as the customer name, email, language and reference. |
| `meta.customer.phone.number` | Optional | Sent as the customer mobile. |
| `meta.order.billingAddress` | Optional | Sent as the customer address: `area` (block), `street` and `doorNumber` (house or building number). |
| `meta.risk.threeDSMode` | Optional | `Force` runs 3D Secure with the **Visa/MasterCard-3DS ID**. Otherwise Payrails uses the **Visa/MasterCard ID** without 3D Secure. |

***

## 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](/docs/orchestration/payment-acceptance/test-payments)


## Related topics

- [Integrations](/docs/orchestration/integrations.md)
- [FawryPay via Flutterwave](/docs/orchestration/payment-methods/fawrypay/flutterwave.md)
- [mTLS Configuration](/docs/account-setup/mtls-configuration.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.