Get PAYOUT Status
Endpoint
- Method:
GET - Path:
/v1/payouts/:id - Purpose: Get status of a payout transaction
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Use transactionId from create response |
Request Payload
No request body.
Response
Success (200)
| Field | Type | Description |
|---|---|---|
id | string | Internal id |
transactionId | string | Public transaction id |
status | string | pending or success |
amount | string | Requested amount |
platformOrderId | string | Platform order reference |
recipient | object | Recipient info |
recipient.masked | string | Masked destination number |
createdAt | string (ISO datetime) | Creation timestamp |
completedAt | string | null (ISO datetime) | Completion timestamp |
{
"id": "uuid",
"transactionId": "uuid",
"status": "pending",
"amount": "100",
"platformOrderId": "...",
"recipient": { "masked": "****5678" },
"createdAt": "...",
"completedAt": null
}