Opay via dLocal

Accept 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

Workflow	Supported
Payrails SDK	✔
Payrails API	✔
Delayed / Manual Capture	✖
Instant Capture	✔
Cancel / Void	✖
Refund / Reverse	✔
Save Instruments	✖
Merchant Initiated Transaction (MIT)	✖

Before you begin

Complete these steps before you send your first Opay payment through dLocal:

Set up a dLocal integration in your workspace. Follow the dLocal integration setup guide if you don’t have one yet.
Ask dLocal to enable Opay on your dLocal account for each country where you accept it.
In the Payrails Portal, go to Settings → Integrations, open your dLocal integration, select OPayWallet under Payment methods, and save.
Add Opay as a payment option in your workflow.

Request fields for dLocal

Send these fields in the authorize request, in addition to the standard authorize fields. 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 with oPayWallet as the paymentMethodCode. The response includes the redirect to the Opay payment page.

Authorize request

{
  "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 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.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for dLocal

Authorize an Opay payment

How dLocal handles Opay

​Supported workflows

​Before you begin

​Request fields for dLocal

​Authorize an Opay payment

​How dLocal handles Opay

Supported workflows

Before you begin

Request fields for dLocal

Authorize an Opay payment

How dLocal handles Opay