POST
Send a payout

Authorizations

x-api-key
string
header
required

Your business API key, generated from the dashboard. Required on every business-facing endpoint.

Body

application/json
amount
string
required
Example:

"500"

fromCurrency
enum<string>
required

Fiat currencies: NGN, EUR, GBP, USD, KES, UGX, GHS, CAD, XOF, XAF. Crypto currencies: USDT, USDC.

Available options:
NGN,
EUR,
GBP,
USD,
USDT,
USDC,
KES,
UGX,
GHS,
CAD,
XOF,
XAF
toCurrency
enum<string>
required

Fiat currencies: NGN, EUR, GBP, USD, KES, UGX, GHS, CAD, XOF, XAF. Crypto currencies: USDT, USDC.

Available options:
NGN,
EUR,
GBP,
USD,
USDT,
USDC,
KES,
UGX,
GHS,
CAD,
XOF,
XAF
narration
string
required
Example:

"Vendor payment"

sessionId
string
required

A unique ID you generate for this payout attempt.

Example:

"payout-9931"

rateKey
string

Required whenever fromCurrency differs from toCurrency.

accountNumber
string

Required when toCurrency is a fiat destination (NGN, KES, UGX, USD, GBP).

accountName
string

Required when toCurrency is a fiat destination (NGN, KES, UGX, USD, GBP).

bankName
string

Required when toCurrency is a fiat destination (NGN, KES, UGX, USD, GBP).

bankCode
string

Required when toCurrency is NGN, KES, or UGX.

address
string

Wallet address. Required when toCurrency is crypto (USDT/USDC).

network
string

Network for a same-currency crypto payout.

fromNetwork
string

Source network for crypto-to-crypto or crypto-to-fiat payouts.

toNetwork
string

Destination network for crypto-to-crypto payouts.

transitNumber
string

Required when toCurrency is CAD.

institutionNumber
string

Required when toCurrency is CAD.

sortCode
string

Required when toCurrency is GBP.

swiftCode
string

Required when toCurrency is EUR or GBP.

recipientName
string

Response

Payout submitted.

message
string
Example:

"Payout successful"

sessionId
string
Example:

"payout-9931"