Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
integer
required

The transfer amount in major units of the payout currency (5000 = NGN 5,000). Must be within your configured minimum and maximum limits.

Example:

5000

bank_code
string
required

The recipient's bank code from /v1/banks. 3-digit CBN codes for NGN, 6-digit universal branch codes for ZAR.

Example:

"058"

account_number
string
required

The recipient's account number. 10 digits for NGN, 7-11 digits for ZAR.

Example:

"0264341458"

reference
string
required

Your unique reference for this transfer, used for idempotency and tracking.

Example:

"txn_abc123xyz"

currency
enum<string>

Uppercase ISO code of the wallet to debit. Defaults to your business' home currency. Only currencies cleared for payouts are accepted.

Available options:
NGN,
ZAR
Example:

"ZAR"

account_name
string

The recipient's account name. Required for ZAR payouts, where no name enquiry rail exists. Ignored for NGN, which resolves the name through the provider.

Example:

"Thabo Mokoena"

account_type
enum<string>

The recipient's account type. Used for ZAR payouts only.

Available options:
savings,
current,
cheque
Example:

"savings"

Response

Success

status
string
Example:

"success"

message
string
Example:

"Transaction initiated successfully"

data
object