Payouts
Retrieve Payout
Retrieve a payout by ID.
GET
/
admin
/
payouts
/
{id}
curl 'http://localhost:9000/admin/payouts/pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { payout } = await client.admin.payouts.$id.query({
$id: "pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"payout": {
"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" }
}
}
Returns a single payout with its payout account and seller details.
Path parameters
string
required
The payout’s ID.
Query parameters
string
Comma-separated fields to include in the response.
Response
object
Show properties
Show properties
string
The payout’s ID.
number
Human-readable payout number.
number
The payout amount.
string
The payout currency.
string
The payout status.
object | null
Provider-specific payout data.
object
The payout account, with
id and status.object
The seller, with
id, name, and handle.string
Creation timestamp.
string
Last update timestamp.
curl 'http://localhost:9000/admin/payouts/pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { payout } = await client.admin.payouts.$id.query({
$id: "pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"payout": {
"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" }
}
}
⌘I
curl 'http://localhost:9000/admin/payouts/pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { payout } = await client.admin.payouts.$id.query({
$id: "pout_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"payout": {
"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" }
}
}