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

# Opay via dLocal

> Set up Opay wallet payments through dLocal in Payrails for customers in Nigeria and Egypt, and see the request fields dLocal requires.

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

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

Accept [Opay](https://docs.payrails.com/docs/integrations/payment-methods/opay) payments from customers in Nigeria and Egypt with dLocal as the payment service provider (PSP). The customer selects Opay, confirms the payment from their Opay wallet and returns to your site.

## 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 Opay payment through dLocal:

1. Set up a dLocal integration in your workspace. Follow the [dLocal integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/dlocal.md) if you don't have one yet.
2. Ask dLocal to enable Opay on your dLocal account for each country where you accept it.
3. In the Payrails Portal, go to **Settings → Integrations**, open your dLocal integration, select **OPayWallet** under **Payment methods**, and save.
4. Add Opay as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in your workflow.

## Request fields for dLocal

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.customer.country.code` | Required | `NG` or `EG`. Payrails rejects Opay requests to dLocal with any other country code. |
| `meta.customer.name` | Required | Sent to dLocal as the payer name, together with `meta.customer.lastName` when you send it. |
| `meta.customer.email` | Required | Sent to dLocal as the payer email. |
| `amount.currency` | Required | Sent to dLocal unchanged. Use `NGN` for Nigeria or `EGP` for Egypt. |
| `meta.customer.lastName` | Optional | Added to the payer name. |
| `meta.clientContext.ipAddress` | Optional | Sent to dLocal as the payer IP address. |
| `meta.customer.identityCardNumber` | Optional | Sent to dLocal as the payer document. |
| `meta.customer.phone` | Optional | Sent to dLocal as the payer phone number. |
| `meta.customer.reference` | Optional | Sent to dLocal as the payer user reference. |
| `meta.order.description` | Optional | Sent to dLocal as the payment description. |

## Authorize an Opay payment

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

```json Authorize request theme={null}
{
  "amount": {
    "value": "250.00",
    "currency": "EGP"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "oPayWallet",
      "amount": {
        "value": "250.00",
        "currency": "EGP"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Nour",
      "lastName": "Hassan",
      "email": "nour.hassan@example.com",
      "country": {
        "code": "EG"
      }
    },
    "clientContext": {
      "ipAddress": "203.0.113.10"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

After the customer confirms the payment, dLocal returns them to your `success` or `error` URL. 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 dLocal handles Opay

* Payrails picks the dLocal Opay variant from `meta.customer.country.code`: one for Nigeria and one for Egypt. A missing country code returns an error, and any value other than `NG` or `EG` returns an error.
* The payment stays pending until dLocal reports the result. If the customer doesn't complete the payment in time, dLocal expires it and Payrails marks it as failed.


## Related topics

- [Opay](https://docs.payrails.com/docs/integrations/payment-methods/opay.md)
- [Khipu via dLocal](https://docs.payrails.com/docs/integrations/payment-methods/khipu/dlocal.md)
- [BCP via dLocal](https://docs.payrails.com/docs/integrations/payment-methods/bcp/dlocal.md)


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