1. Payout
API
English
  • Español
  • English
  • Introduction
    • Kambia API
    • Credentials
    • Authentication
    • Verification
      POST
  • Services
    • Code catalog
    • Payout
      • Notifications
      • Create payout
        POST
      • Get payout
        GET
    • Direct debit
      • Affiliation
      • Charge
  1. Payout

Get payout

GET
/{{api_version}}/payout/{{merchant_id}}/{payout_id}
Description
Checks the status of a payout by its payout_id (the id returned by Create payout).
Authentication
See the section here. With no body, the string to sign is merchant_id + timestamp.
Response
The same format as the notification, plus status_code:
SUCCESS: the bank processed the payout. Includes receipt_url if the receipt is available (valid for 1 hour).
REJECTED: the bank rejected it; message carries the same text as the notification. No money was sent.
PENDING: still in progress.
Also works with demo mode payouts.

Request

Path Params

Responses

🟢200Payout status
application/json
Bodyapplication/json

🟠404Payout not found
Response Response Example
200 - Example 1
{
    "status_code": 0,
    "status": "SUCCESS",
    "message": "string",
    "timestamp": "string",
    "payout": {
        "id": "string",
        "country": "string",
        "amount": "string",
        "currency": "string",
        "order_id": "string",
        "bank_code": "string",
        "account_number": "string",
        "name": "string",
        "receipt_url": "string"
    }
}
Modified at 2026-10-03 01:09:07
Previous
Create payout
Next
Affiliation
Built with