Skip to main content
POST
BANK WITHDRAWAL
This API handles payout to bank, supporting South Africa, Kenya, and Nigeria. For Nigeria, bankCode needs its leading zeros preserved — send it as a string.

Authorizations

Authorization
string
header
required

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

Body

application/json
bankDetails
object
required
currency
string
required

The currency of the transaction

Example:

"ZAR"

amount
number
required

The amount of the transaction

Example:

100

referenceId
string
required

The reference id of the transaction

Example:

"1234567890"

callbackUrl
string

Callback URL to receive withdrawal status updates

Example:

"https://your-domain.com/webhook"

Response

success
boolean
Example:

true

message
string
Example:

"Withdrawal has been successfully created."

data
object