Initiate Payout

⚠️ Important Notes

  • Bank code should be same as the one used for name inquiry

    Ensure consistency between the bank code used during name enquiry and payout initiation.

  • You need to keep our response. This is what will be used to query the transaction

    Store the response (especially the reference ID) from the payout initiation. You'll need it to check status or handle reconciliation.

Transaction Statuses Explained

Status
Meaning

pending

Transaction has been received but not yet processed.

processing

The transaction is currently being handled by the system or bank.

completed

The transaction was successful and funds were delivered.

failed

The transaction was not successful. See error details for more context.

ℹ️ Only completed should be treated as a successful transaction.

Initiate a payout

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
X-CLIENTIDstringRequired

Client identifier for the API.

Example: sdfgfd-sdfgf4d-sdfgfdsd-sdfgfds
Body
currencystringOptional

The currency of the payout.

Example: NGN
amountnumberOptional

The amount to be paid out.

Example: 100
narrationstringOptional

A description or reason for the payout.

Example: Test Payout
merchant_referencestringOptional

The reference for the merchant's payout request.

Example: ptest020
webhook_urlstringOptional

URL for webhook notifications related to this payout.

Example: https://webhook.site/3419fdea-d111-4045-a8c1-17df102cb3c4
Responses
200

Payout initiated successfully.

application/json
post
/v1/payment/initiate-payout/
POST /v1/payment/initiate-payout/ HTTP/1.1
Host: disbuzapi.celergate.net
Authorization: Bearer YOUR_SECRET_TOKEN
X-CLIENTID: text
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "currency": "NGN",
  "amount": 100,
  "narration": "Test Payout",
  "merchant_reference": "ptest020",
  "beneficiary": {
    "account_number": "1049368760",
    "bank_code": "033",
    "bank_name": "UBA",
    "account_name": "John Doe"
  },
  "webhook_url": "https://webhook.site/3419fdea-d111-4045-a8c1-17df102cb3c4"
}
{
  "status": "Processing",
  "reference": "txn_12345",
  "amount": "100.00"
}
PreviousName EnquiryNextWebhook

Last updated