> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mercurjs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Payouts

> Retrieve a paginated list of payouts across all sellers.

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).

**seller\_id** `string | string[]`

Filter by the seller(s) owning the payout account.

**order\_id** `string | string[]`

Filter by order 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[]`

**properties**

**id** `string`

The payout's ID.

**display\_id** `number`

Human-readable payout number.

**amount** `number`

The payout amount.

**currency\_code** `string`

The payout currency.

**status** `string`

The payout status.

**status\_reason** `string | null`

Why the payout is `on_hold`, `failed` or `aborted`: a `PayoutStatusReason` code such as `order_not_ready` or `provider_error`. The details behind it are in `data.status_detail`.

**data** `object | null`

Payout data: `attempts`, `status_detail`, and the provider's response under `provider`.

**account** `object`

The payout account, with `id` and `status`.

**seller** `object`

The seller, with `id`, `name`, and `handle`.

**created\_at** `string`

Creation timestamp.

**updated\_at** `string`

Last update timestamp.

**count** `number`

Total number of matching payouts.

**offset** `number`

Number of records skipped.

**limit** `number`

Maximum number of records returned.

```bash cURL theme={null}
curl 'http://localhost:9000/admin/payouts?status=completed&limit=20' \
  -H 'Authorization: Bearer <token>'
```

```ts JS Client theme={null}
const { payouts, count } = await client.admin.payouts.query({
  status: "completed",
  limit: 20,
})
```

```json 200 theme={null}
{
  "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
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.