Payouts

Retrieve a payout with its attempts and provider references

GET/v1/payouts/{id}

Parameters

idstringin pathrequired

Responses

200The payout
400Invalid request
401Missing, invalid or revoked API key
404not_found
429More than 100 requests in this minute for this keyRetry-After
500Internal error

Error bodies and every code are listed under Errors; limits under Rate limits and Idempotency.

{ "id": "mo_01JB8Q4Z2N5V7K3M9P6R0T1W8X", "object": "payout", "livemode": false, "status": "pending_approval", "amount": 125000, "currency": "KES", "beneficiary": { "id": "obj_01JB8Q4Z2N5V7K3M9P6R0T1W8X", "name": "name", "phone": "+254708374149" }, "reason": "reason", "source_ref": "source ref", "connection_id": "con_01JB8Q4Z2N5V7K3M9P6R0T1W8X", "provider_ref": "provider ref", "receiver_name": "receiver name", "failure_code": "failure code", "failure_message": "failure message", "attempts": [ { "attempt": 1, "channel": "api", "status": "pending", "provider_ref": "provider ref", "provider_code": "provider code", "provider_message": "provider message", "started_at": "2026-10-22T09:30:00.000Z", "finished_at": "2026-10-22T09:30:00.000Z" } ], "created_at": "2026-10-22T09:30:00.000Z", "completed_at": "2026-10-22T09:30:00.000Z" }

Retrieve a payout with its attempts and provider references

GET/v1/payouts/{id}

Parameters

idstringin pathrequired

Responses

200The payout
400Invalid request
401Missing, invalid or revoked API key
404not_found
429More than 100 requests in this minute for this keyRetry-After
500Internal error

Error bodies and every code are listed under Errors; limits under Rate limits and Idempotency.