Initiate Payout

This API lets you make payouts to bank accounts, mobile money wallets, and crypto/stablecoin wallets. The payout category is determined by the paymentDestination field — see the request examples for each category.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample Payload

{
  "sourceCurrency": "NGN",
  "destinationCurrency": "NGN",
  "amount": "5000",
  "description": "Payment for services",
  "paymentDestination": "bank_account",
  "beneficiary": {
    "firstName": "John",
    "lastName": "Doe",
    "accountHolderName": "John Doe",
    "type": "individual",
    "accountNumber": "0123456789",
    "bankCode": "044"
  }
}

Body Params
string
enum
required
Defaults to NGN

The currency which is used to fund the payout

string
enum
required
Defaults to NGN

The currency in which the recipient will be receiving funds

string
required
Defaults to 5000

The value that is to be transferred from the source currency wallet.

string
required

The unique Identifier of the parent business

string
required
Defaults to Payment for services

The description of the payout

string
required

The transaction's unique identifier on your system. Customer references prevent duplicate transactions.

string
enum
required
Defaults to bank_account

The type of account you want to send the payout to. Use bank_account for bank transfers, mobile_money_wallet for mobile money payouts, and crypto_wallet for stablecoin/crypto payouts.

Allowed:
string
enum

The payment scheme relevant to the destination currency payment network. Required for cross-border and crypto payouts; optional for local bank transfers (e.g. NGN to NGN).

string

This is the reference generated for FX quote. This is required for cross-currency payouts.

beneficiary
object
required

The recipient of the payout. The fields you provide depend on the paymentDestination: bank account fields for bank_account, phone/mobile money fields for mobile_money_wallet, and wallet fields for crypto_wallet.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json