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

> Accept Opay wallet payments from customers in Nigeria and Egypt, and check the PSPs that process Opay through Payrails.

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

Opay is a digital wallet used in Nigeria and Egypt. Customers pay from their Opay wallet balance and confirm each payment with Opay.

Payrails processes Opay through two payment service providers (PSPs). The flow is the same with each one, but the supported countries and the required request fields differ. Pick a PSP below for its setup steps and request examples.

## How an Opay payment works

Opay is a redirect wallet payment method:

1. The customer selects Opay at checkout.
2. Payrails returns a redirect URL from the PSP, and the customer goes to the Opay payment page.
3. The customer confirms the payment from their Opay wallet.
4. The PSP sends the customer back to your `returnInfo` URL.
5. Payrails receives the final result from the PSP and updates the payment.

Each payment is single-use: the customer confirms every payment on its own. Payrails captures Opay payments immediately, so a successful payment is final. To return funds, [refund the payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md).

## Supported currencies and countries

The supported countries depend on the PSP:

* **dLocal** supports Nigeria and Egypt.
* **Flutterwave** supports Nigeria only, with NGN (Nigerian naira) as the currency.

Opay is available to customers based in:

<table>
  <thead>
    <tr><th>Regions</th><th>Countries</th></tr>
  </thead>

  <tbody>
    <tr><td>**Africa**</td><td>🇪🇬 Egypt🇳🇬 Nigeria</td></tr>
  </tbody>
</table>

## Integrate Opay

Choose the PSP that processes Opay for you. Each guide covers the PSP-side setup, the Payrails configuration and the request fields that PSP requires.

> [card]
>
> dLocal logo
>
> dLocalOpay via dLocal
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/opay/dlocal.md)

> [card]
>
> Flutterwave logo
>
> FlutterwaveOpay via Flutterwave
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/opay/flutterwave.md)

## Check PSPs

<table>
  <thead>
    <tr><th>Workflow</th><th>[dLocal](https://docs.payrails.com/docs/integrations/payment-methods/opay/dlocal.md)</th><th>[Flutterwave](https://docs.payrails.com/docs/integrations/payment-methods/opay/flutterwave.md)</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</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><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><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✖</td><td>✖</td></tr>
  </tbody>
</table>

Each Opay payment is a new customer-initiated payment.

## Ways to integrate Opay

* **Payrails SDK:** the [Web SDK](https://docs.payrails.com/docs/sdks/web.md) shows Opay when your workflow returns it as a payment option, and redirects the customer to the Opay payment page. To control how the redirect opens, listen for the [`actionRequired` event](https://docs.payrails.com/docs/sdks/web/guides/action-required-event).
* **Payrails API:** call [lookup payment options](https://docs.payrails.com/docs/orchestration/payment-acceptance/lookup-payment-options.md), then authorize with `oPayWallet` as the `paymentMethodCode`. Each PSP guide lists the `meta` fields that PSP requires.

In both cases, confirm the final result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status. Don't treat the customer's return to your `success` URL as proof of payment.


## Related topics

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


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