Skip to main content
POST
Create a payout from the merchant master NGN wallet

Authorizations

x-api-key
string
header
required

Headers

X-Idempotency-Key
string
required

Unique key for this logical payout. Idempotency-Key is also accepted; if both headers are sent, they must match.

Maximum string length: 255

Body

application/json
amount
integer
required

Amount the beneficiary receives in NGN.

Required range: x >= 1
currency
enum<string>
required
Available options:
NGN
reference
string
required
Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._:-]+$
destinationBankCode
string
required
Required string length: 1 - 100
destinationBankName
string
required
Required string length: 1 - 199
destinationAccountName
string
required
Required string length: 1 - 199
destinationAccountNumber
string
required
Required string length: 1 - 199
remarks
string
Maximum string length: 255
metadata
object

Optional merchant data limited to 4,096 UTF-8 bytes and returned unchanged.

Response

Payout accepted, completed synchronously, or idempotently replayed

status
string
required
Allowed value: "success"
statusCode
enum<integer>
required
Available options:
200,
202
message
string
required
data
object
required