Opay

Currencies & Countries Supported

Supported Transaction Types

• Authorisation

• Capture

• Purchase

• Refunds

• Withdrawal*

• Void

Integrations Supported

For the Deposit flow:

• Hosted Payment Page

• Direct Connect ( server-to-server)

For the Withdrawal flow:

• Hosted Payment Page

• Direct Connect ( server-to-server) - Bank Transfer and Opay wallet options available.

Additional attributes to process via Opay

You must include the following JSON Attributes to the payload. These attributes inform us to proceed with the redirection to the relevant payment method in order to finalize the payment process.

Deposit

Refer to our API Reference Document here to create a Hosted Payment Page, use the below mandatory tags to process a deposit.

A sample request can be found below

{
  "TransactionType": "PURC",
  "Currency": "NGN",
  "Amount": 10,
  "OrderReference": "test",
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "FailRedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "Country": "NGA",
    "City": "Valletta",
    "IPAddress": "127.0.0.1"
  },
   "Routing": {
    "ForcePayment": "OPAY"
  },
  "IsTest": true
}

Withdrawals via Bank Transfer

Withdrawals are processed via Direct Connect. The API reference to request a payout can be found here.

Below are the mandatory fields required to process a payout via Opay for Bank Transfer

A sample request can be found here:

{
  "TransactionType": "ORIGINALCREDIT",
  "Currency": "NGN",
  "Amount": "10",
  "OrderReference": "test",
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "FailRedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "City": "MagicCity",
    "IPAddress": "127.0.0.1"
  },
  "Routing": {
    "ForcePayment": "OPAY"
  },
  "PaymentMethodData": {
    "PayoutType": "BankTransfer",
    "BankCode": "033",
    "BeneficiaryAccountNumber": "2215381176"
  },
  "IsTest": true
}

Withdrawals via Opay Wallet

Withdrawals are processed via Direct Connect. The API reference to request a payout can be found here.

Below are the mandatory fields required to process a payout via Opay for Opay Wallet

A sample request can be found here:

{
  "TransactionType": "ORIGINALCREDIT",
  "Currency": "NGN",
  "Amount": "10",
  "OrderReference": "test",
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "FailRedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "Country": "NGA",
    "MobileNo": "002349876543210",
    "City": "MagicCity",
    "IPAddress": "127.0.0.1"
  },
  "Routing": {
    "ForcePayment": "OPAY"
  },
  "PaymentMethodData": {
    "PayoutType": "OpayWallet"
  },
  "IsTest": true
}