Skip to main content
POST

Error responses

Authorizations

x-api-key
string
header
required

Body

application/json

Payout to a Nigerian bank account (NGN).

quoteId
string
required

The unique identifier for the quote (valid for 10 minutes).

recipient
NGN Payout · object
required

Recipient details for a payout to Nigeria (NGN).

reason
enum<string>

The purpose of the transfer.

Available options:
FAMILY_SUPPORT,
GIFT,
SALARY_PAYMENT,
EDUCATIONAL_FEES,
BUSINESS_INVOICE,
OTHER
invoice
string

Optional invoice file ID (returned from the file upload endpoint).

remark
string

An optional note about the transaction. Use fail in sandbox to trigger a failed payout webhook.

Response

Payout transaction created successfully.

status
string
required
Example:

"success"

message
string
required
Example:

"Transaction created successfully."

data
object
required