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

# List Payouts

> List cash outs across your program, for reconciliation.

Every cash out a user makes in the widget creates a payout. Use this to reconcile them, or to find one by user or status.

## Configuration

### Header Parameters

<ParamField required header="x-api-key" type="string">
  Your ZBD API key.
</ParamField>

### Query Parameters

<ParamField query="user_id" type="string">
  Only payouts to this user.
</ParamField>

<ParamField query="status" type="string">
  Only payouts in this status.
</ParamField>

<ParamField query="reference_id" type="string">
  Only the payout with your reference.
</ParamField>

<ParamField query="project_id" type="string">
  Only payouts in this project.
</ParamField>

<ParamField query="from" type="string">
  ISO 8601 start of the date range.
</ParamField>

<ParamField query="to" type="string">
  ISO 8601 end of the date range.
</ParamField>

<ParamField query="limit" type="integer">
  Page size.
</ParamField>

<ParamField query="cursor" type="string">
  The `next_cursor` from the previous page.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.zbdpay.com/api/v1/payouts?status=COMPLETED&from=2026-10-01T00:00:00Z" \
    -H "x-api-key: YOUR_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "message": "Payouts retrieved.",
    "data": {
      "payouts": [
        {
          "payout_id": "po_8f2c41d7-3b9e-4a10-b6f2-91de0c7a5e44",
          "status": "COMPLETED",
          "origin": "api",
          "user_id": "4ac4fd8a-cc2c-4d03-af09-a76f4e89d652",
          "amount": 2500,
          "currency": "USD",
          "fee_amount": 50,
          "net_amount": 2450,
          "reference_id": "creator_payout_2026_10",
          "project_id": null
        }
      ],
      "next_cursor": null
    },
    "error": null
  }
  ```
</ResponseExample>

## Response

<ResponseField name="payouts" type="object[]">
  Payouts matching your filters, newest first. Each has the same fields as [Get a Payout](/embedded-accounts/apis/get-payout#response).
</ResponseField>

<ResponseField name="next_cursor" type="string | null">
  Pass this as `cursor` to get the next page. `null` when there are no more results.
</ResponseField>


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