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

# FawryPay via Fawry

> Set up FawryPay payments directly through Fawry in Payrails, including the order lines and language Fawry requires.

<picture noZoom>
  ![FawryPay logo](https://assets.payrails.io/img/logos/fawrypay/logo.svg)
</picture>

<picture noZoom>
  ![Fawry logo](https://assets.payrails.io/img/logos/fawry/logo-full-bleed.svg)
</picture>

Accept [FawryPay](https://docs.payrails.com/docs/integrations/payment-methods/fawrypay) payments from customers in Egypt with [Fawry](https://www.fawry.com/) as the payment service provider (PSP). The customer selects FawryPay, gets a FawryPay reference on the Fawry page and pays it later at a Fawry outlet or in the myFawry app.

Fawry also processes [card](https://docs.payrails.com/docs/integrations/payment-methods/cards) payments in Egypt through the same integration.

## Supported workflows

<table>
  <thead>
    <tr><th>Workflow</th><th>Supported</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✖</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✔</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✖</td></tr>
  </tbody>
</table>

## Before you begin

Complete these steps before you send your first FawryPay payment through Fawry:

1. Get your merchant code and API key from Fawry.
2. Set up a Fawry integration in your workspace with your merchant code and API key. Follow the [Fawry integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/fawry.md) if you don't have one yet.
3. Choose whether Payrails sends its notification URL to Fawry on each payment. Turn on this account setting if you don't configure the Payrails notification URL in your Fawry account.
4. In the Payrails Portal, go to **Settings → Integrations**, open your Fawry integration, select **Fawry Pay** under **Payment methods**, and save.
5. Add FawryPay as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in your workflow.

To try the flow before you go live, follow the [Fawry testing guide](https://developer.fawrystaging.com/docs/testing/testing).

## Request fields for Fawry

Send these fields in the authorize request, in addition to the standard [authorize fields](https://docs.payrails.com/reference/authorizeaction.md). **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to the PSP when you include them.

| Field | Status | Description |
| - | - | - |
| `meta.order.lines` | Required | At least one order line. Sent to Fawry as the charge items. |
| `meta.order.lines[].unitPrice` | Required | The price of one item. |
| `meta.order.lines[].quantity` | Required | Must be one or more. |
| `meta.order.lines[].id` | Required | Sent to Fawry as the item ID. |
| `meta.clientContext.language` | Required | Sent to Fawry as the payment language, for example `en-gb`. |
| `meta.customer.email` | Required | Sent to Fawry as the customer's email. |
| `meta.customer.phone.number` | Optional | Sent to Fawry as the customer's mobile number. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent to Fawry as the customer's name. |
| `meta.customer.reference` | Optional | Sent to Fawry as the customer profile ID. |
| `meta.order.description` | Optional | Sent to Fawry as the payment description. |
| `meta.order.lines[].description` | Optional | Sent to Fawry as the item description. |

## Authorize a FawryPay payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `fawryPay` as the `paymentMethodCode`. The response includes the redirect to the Fawry page.

```json Authorize request theme={null}
{
  "amount": {
    "value": "250.00",
    "currency": "EGP"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "fawryPay",
      "amount": {
        "value": "250.00",
        "currency": "EGP"
      }
    }
  ],
  "meta": {
    "customer": {
      "email": "nour.hassan@example.com",
      "name": "Nour",
      "lastName": "Hassan",
      "phone": {
        "countryCode": "+20",
        "number": "1001234567"
      }
    },
    "order": {
      "description": "Example Store order",
      "lines": [
        {
          "id": "item-1",
          "description": "Wireless headphones",
          "quantity": 1,
          "unitPrice": {
            "value": "250.00",
            "currency": "EGP"
          }
        }
      ]
    },
    "clientContext": {
      "language": "en-gb"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

After the customer gets their FawryPay reference, Fawry returns them to your `success` or `error` URL. The payment is still pending at that point. Confirm the result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status before you fulfill the order.

## How Fawry handles FawryPay

* The payment stays pending until the customer pays the reference. When the customer pays, Fawry notifies Payrails, and Payrails records the authorization and the capture together.
* If the customer leaves the Fawry page before generating a reference, the payment stays pending.
* To stop an unpaid reference, [cancel](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md) the FawryPay payment. Send `meta.clientContext.language` on the cancel request too: Payrails returns an error without it.
* Refunds use the Fawry reference of the paid payment. Fawry supports full and partial refunds.


## Related topics

- [FawryPay](https://docs.payrails.com/docs/integrations/payment-methods/fawrypay.md)
- [FawryPay via Flutterwave](https://docs.payrails.com/docs/integrations/payment-methods/fawrypay/flutterwave.md)
- [FawryPay via dLocal](https://docs.payrails.com/docs/integrations/payment-methods/fawrypay/dlocal.md)


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