Skip to main content
POST
Create payout

Authorizations

Authorization
string
header
required

Secret key: Authorization: Bearer sk_test_... or sk_live_.... Business and live/test mode are inferred from the key.

Body

application/json
reference
string
required

Required unique payout reference. Omit → 422. Reuse → 409.

Example:

"wd_order_98234"

amount
integer
required

Amount to debit from the wallet in minor units

Required range: x >= 1
Example:

500000

currency
enum<string>
required

Wallet currency to debit

Available options:
usd,
ngn
Example:

"ngn"

method
enum<string>
required
Available options:
crypto,
bank_transfer
Example:

"crypto"

destination
object
required
description
string
Maximum string length: 500
metadata
object

Response

Payout created

message
string
Example:

"Success"

data
object | null