Skip to main content
POST

Authorizations

Authorization
string
header
required

API key authentication using Bearer token

Body

application/json
reference
string
required

Unique idempotency reference for this payout. Used to prevent duplicate transfers.

Required string length: 1 - 100
Example:

"payout-li"

amount
number
required
Example:

100

currency
string
required

Currency code for the transfer

Example:

"NGN"

destination
object
required
narration
string
Example:

".."

Response

Withdrawal initiated successfully

amount
number<double>
Example:

100

currency
string
Example:

"NGN"

destination
object
providerStatus
string

Status of the transaction with the upstream provider.

Example:

"PROCESSING"

reference
string

Unique transaction reference.

Example:

"TRF-a633516c526a40c4b2ebc6e3c249c5f5"

status
string

Internal processing status.

Example:

"PROCESSING"