List Payouts

GET

admin

payouts

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

const { payouts, count } = await client.admin.payouts.query({
  status: "completed",
  limit: 20,
})

{
  "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

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated fields to include in the response.

string | string[]

Filter by payout ID(s).

string | string[]

Filter by payout status.

string | string[]

Filter by payout account ID(s).

object

Filter by creation date using operators like $gte and $lte.

object

Filter by update date using operators like $gte and $lte.

Response

object[]

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.

number

Total number of matching payouts.

number

Number of records skipped.

number

Maximum number of records returned.

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

const { payouts, count } = await client.admin.payouts.query({
  status: "completed",
  limit: 20,
})

{
  "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
}

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

const { payouts, count } = await client.admin.payouts.query({
  status: "completed",
  limit: 20,
})

{
  "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
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response