Skip to navigation
Settlement Payouts

Check Payout Status

View as Markdown

Polls the current status of a payout — use this after receiving a 202 from Send Payout, or any time you want to confirm a payout’s outcome.

status is one of: PENDING (still resolving — check back or wait for the webhook), success, or failed.

Path parameter: id (string, required) - the payout reference (= verify_id).

Behaviour notes

  • status is PENDING, success or failed. Internal SUBMITTING / PROCESSING states are reported as PENDING.
  • fee is the payout fee charged on top of amount (both NGN).
  • A verify_id that was validated but never used for a payout also shows PENDING, with amount: 0 and fee: 0.
  • Unknown id: 404 { "error": "Transfer not found" }.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Path parameters

idstringRequired

The payout reference (verify_id used in Send Payout, i.e. the reference field on its response).

Response

Pending / Success / Failed

dataobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error