Skip to main content
GET
/
payouts
/
{id}
cURL
curl --request GET \
  --url https://sandbox.onconsul.com/v1/payouts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": "queued",
  "total_amount": "<string>",
  "total_items": 123,
  "completed_at": "2023-11-07T05:31:56Z"
}
Retrieve a payout by ID, including its overall status, total amount, and item count.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

OK

​
created_at
string<date-time>
required
​
id
string
required
​
status
enum<string>
required
Available options:
queued,
awaiting_transfer,
processing,
completed,
failed,
cancelled,
expired,
pending_claim
​
total_amount
string<decimal>
required
​
total_items
integer<int64>
required
​
completed_at
string<date-time>