Initiate Payout
⚠️ Important Notes
Transaction Statuses Explained
Status
Meaning
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
X-CLIENTIDstringRequiredExample:
Client identifier for the API.
sdfgfd-sdfgf4d-sdfgfdsd-sdfgfdsBody
currencystringOptionalExample:
The currency of the payout.
NGNamountnumberOptionalExample:
The amount to be paid out.
100narrationstringOptionalExample:
A description or reason for the payout.
Test Payoutmerchant_referencestringOptionalExample:
The reference for the merchant's payout request.
ptest020webhook_urlstringOptionalExample:
URL for webhook notifications related to this payout.
https://webhook.site/3419fdea-d111-4045-a8c1-17df102cb3c4Responses
200
Payout initiated successfully.
application/json
statusstringOptionalExample:
The status of the payout initiation.
Processingtransaction_idstringOptionalExample:
Unique ID of the payout transaction.
txn_12345messagestringOptionalExample:
Amount Paid.
100.00400
Bad Request - Invalid data or missing required fields.
application/json
401
Unauthorized - Missing or invalid credentials.
application/json
500
Server error
application/json
post
/v1/payment/initiate-payout/Last updated