Skip to main content
GET
Check Payout Status

Request Headers

string
required
Bearer token for authentication. Format: Bearer <token>
string
default:"application/json"
Expected response format. Use application/json.

Path Parameters

string
required
Unique identifier of the payout transaction.

Example Request

cURL

Response

boolean
Indicates whether the request was successful.
string
Human-readable response message.
string
Current payout status (pending, paid, failed, or cancelled).
string
Latest payout event (for example, payout.completed or payout.failed).
string
Unique identifier of the payout transaction.
string
Payout method (mobile or ach).
string
Payout amount.
string
Transaction fee charged for the payout.
string
Recipient phone number (for mobile payouts).
string
Mobile network provider (for example, airtel, vodacom, tigo).
string
Recipient bank account number (for ACH payouts).
string
Bank name (for ACH payouts).
string
Bank Identifier Code (for ACH payouts).
string
ISO 8601 timestamp when the payout was completed.
string
Reason for payout failure (only present for failed payouts).

Example Responses

Mobile Payout (Paid)

Bank Payout (Paid)

Payout Failed

Poll this endpoint using the transaction ID to monitor payout progress until the transaction reaches a final state (paid, failed, or cancelled).