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

# List Payouts

> Retrieve a paginated list of payouts.

## List Payouts

Retrieve a paginated list of all payouts, with optional filtering by status and date range.

### Endpoint

```
GET /v1/payouts
```

### Query Parameters

| Parameter | Type    | Required | Description                                                       |
| --------- | ------- | -------- | ----------------------------------------------------------------- |
| `page`    | integer | No       | Page number (default: 1).                                         |
| `limit`   | integer | No       | Results per page (default: 20, max: 100).                         |
| `status`  | string  | No       | Filter by status: `pending`, `processing`, `completed`, `failed`. |
| `from`    | string  | No       | ISO 8601 start date for filtering.                                |
| `to`      | string  | No       | ISO 8601 end date for filtering.                                  |

### Request

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://api.thiqwave.com/v1/payouts?page=1&limit=20&status=completed" \
    -H "X-API-Key: your_api_key"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://api.thiqwave.com/v1/payouts?page=1&limit=20&status=completed',
    {
      method: 'GET',
      headers: {
        'X-API-Key': 'your_api_key',
      },
    }
  );

  const result = await response.json();
  console.log(result);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.thiqwave.com/v1/payouts',
      headers={'X-API-Key': 'your_api_key'},
      params={
          'page': 1,
          'limit': 20,
          'status': 'completed',
      }
  )

  result = response.json()
  print(result)
  ```
</CodeGroup>

### Response

```json theme={null}
{
  "data": [
    {
      "payout_id": "payout_1234567890",
      "quote_id": "quote_9876543210",
      "status": "completed",
      "source_currency": "USDT",
      "source_network": "ethereum",
      "source_amount": "500.00",
      "destination_currency": "AED",
      "destination_account": {
        "account_holder": "John Doe",
        "account_number": "0123456789",
        "bank_code": "ABUAAE3D",
        "country": "AE"
      },
      "destination_amount": 52250,
      "reference": "payout_ref_001",
      "created_at": "2026-04-09T14:30:00Z",
      "completed_at": "2026-04-09T14:35:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 87,
    "total_pages": 5
  }
}
```

### Response Fields

| Field              | Type    | Description              |
| ------------------ | ------- | ------------------------ |
| `data`             | array   | Array of payout objects. |
| `meta.page`        | integer | Current page number.     |
| `meta.limit`       | integer | Results per page.        |
| `meta.total`       | integer | Total number of payouts. |
| `meta.total_pages` | integer | Total number of pages.   |

## Notes

* Use pagination to retrieve large result sets efficiently.
* Filter by `status` to focus on specific payout states.
* Use `from` and `to` parameters to filter by date range.