POST
Create payout

Authorizations

x-api-key
string
header
required

Your secret key. It starts with sk_test_ or sk_live_.

Headers

Idempotency-Key
string
required

Body

application/json
sourceCurrency
enum<string>
required
Available options:
NGN,
GHS,
KES
destinationCurrency
enum<string>
required
Available options:
NGN,
GHS,
KES
amount
number
required

Amount in minor units

Example:

100000

method
enum<string>
required
Available options:
bank_transfer,
card,
mobile_money,
eft,
cash_pickup,
virtual_account
beneficiary
object
required
merchantReference
string
Maximum string length: 255
quoteId
string
narration
string
Maximum string length: 255
metadata
object
idempotencyKey
string

Per-item idempotency key for safe bulk retries

Maximum string length: 255

Response

Payout received and being processed