Skip to main content
GET
/
admin
/
payouts
curl 'http://localhost:9000/admin/payouts?status=completed&limit=20' \
  -H 'Authorization: Bearer <token>'

{
  "payouts": [
    {
      "id": "pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "display_id": 42,
      "amount": 1250,
      "currency_code": "usd",
      "status": "completed",
      "data": null,
      "account": { "id": "pacc_01HXYZ", "status": "active" },
      "seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" }
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}
Returns payouts with their payout account and seller details.

​
Query parameters

​
limit
number
default:"50"
Maximum number of records to return.
​
offset
number
default:"0"
Number of records to skip.
​
order
string
Field to sort by, prefix with - for descending order.
​
fields
string
Comma-separated fields to include in the response.
​
id
string | string[]
Filter by payout ID(s).
​
status
string | string[]
Filter by payout status.
​
account_id
string | string[]
Filter by payout account ID(s).
​
created_at
object
Filter by creation date using operators like $gte and $lte.
​
updated_at
object
Filter by update date using operators like $gte and $lte.

​
Response

​
payouts
object[]
​
count
number
Total number of matching payouts.
​
offset
number
Number of records skipped.
​
limit
number
Maximum number of records returned.
curl 'http://localhost:9000/admin/payouts?status=completed&limit=20' \
  -H 'Authorization: Bearer <token>'

{
  "payouts": [
    {
      "id": "pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "display_id": 42,
      "amount": 1250,
      "currency_code": "usd",
      "status": "completed",
      "data": null,
      "account": { "id": "pacc_01HXYZ", "status": "active" },
      "seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" }
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}