Skip to main content
POST
Initiate a payout

Authorizations

Authorization
string
header
required

Paste your secret key as the bearer token: sk_test_… (test) or sk_live_… (live). That is all a normal API call needs. OAuth access tokens from POST /v1/oauth/token also work, but a client id/secret is only for platforms acting on another tenant's behalf, not for your own integration.

Body

application/json
amount
integer
required

Minor units (kobo); must not exceed the available balance.

Example:

500000

accountId
string

A saved bank account. Provide this, or bankCode + accountNumber.

bankCode
string
accountNumber
string
Pattern: ^\d{10}$
accountName
string

Optional; resolved automatically when omitted.

Response

Payout queued (status: processing)

id
string
amount
integer
currency
string
status
enum<string>
Available options:
processing,
completed,
failed
bankCode
string
bankName
string | null
accountNumber
string
accountName
string | null
reference
string
nombaReference
string | null
failureReason
string | null
createdAt
string
completedAt
string | null