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

# List payments

> List of payments

<Warning>
  **Confirm your deployment before running this request.** This page describes an API contract;
  a published reference does not establish hosted availability. Check the dated
  [host report](/api-reference/hosts) and obtain your deployment URL and credentials.
  Replace the example host if your provisioned service uses a different URL.
</Warning>

### Query parameters

<ParamField query="limit" type="integer (int32)">
  Maximum number of results to return (default: 50).
</ParamField>

<ParamField query="offset" type="integer (int32)">
  Number of results to skip (default: 0).
</ParamField>

<ParamField query="order_id" type="string">
  Filter by order ID (UUID).
</ParamField>

<ParamField query="customer_id" type="string">
  Filter by customer ID (UUID).
</ParamField>

<ParamField query="status" type="string">
  Filter by payment status (pending, authorized, captured, failed, refunded, `partially_refunded`, voided).
</ParamField>

<ParamField query="payment_method" type="string">
  Filter by payment method (`credit_card`, `debit_card`, `bank_transfer`, etc.).
</ParamField>

<ParamField query="processor" type="string">
  Filter by processor name.
</ParamField>

<ParamField query="min_amount" type="string">
  Minimum payment amount.
</ParamField>

<ParamField query="max_amount" type="string">
  Maximum payment amount.
</ParamField>

<ParamField query="from_date" type="string">
  Payments created on or after this date (RFC 3339).
</ParamField>

<ParamField query="to_date" type="string">
  Payments created on or before this date (RFC 3339).
</ParamField>

### Response

`PaymentListResponse`

<ResponseField name="has_more" type="boolean" required />

<ResponseField name="limit" type="integer (int32)" required>
  Minimum: `0`.
</ResponseField>

<ResponseField name="offset" type="integer (int32)" required>
  Minimum: `0`.
</ResponseField>

<ResponseField name="payments" type="PaymentResponse[]" required>
  <Expandable title="PaymentResponse">
    <ResponseField name="amount" type="string" required />

    <ResponseField name="amount_refunded" type="string" required />

    <ResponseField name="created_at" type="string (date-time)" required />

    <ResponseField name="currency" type="string" required />

    <ResponseField name="customer_id" type="string,null" />

    <ResponseField name="external_id" type="string,null" />

    <ResponseField name="id" type="string (uuid)" required />

    <ResponseField name="order_id" type="string,null (uuid)" />

    <ResponseField name="payment_method" type="string" required />

    <ResponseField name="payment_number" type="string" required />

    <ResponseField name="processor" type="string,null" />

    <ResponseField name="status" type="string" required />

    <ResponseField name="updated_at" type="string (date-time)" required />
  </Expandable>
</ResponseField>

<ResponseField name="total" type="integer" required>
  Minimum: `0`.
</ResponseField>

### Status codes

| Code | Meaning |
| - | - |
| `200` | List of payments |
| `400` | Invalid filter parameter |

### Using this contract

Read the [source OpenAPI document](/spec/stateset-icommerce.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

<RequestExample>
  ```bash cURL theme={null}
  curl --silent --show-error --fail-with-body --request GET \
    --url 'https://api.stateset.com/api/v1/payments' \
    --header "Authorization: Bearer $STATESET_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "has_more": true,
    "limit": 20,
    "offset": 1,
    "payments": [
      {
        "amount": "49.00",
        "amount_refunded": "string",
        "created_at": "2026-08-31T14:22:05Z",
        "currency": "USD",
        "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "external_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "payment_method": "card",
        "payment_number": "string",
        "processor": "stripe",
        "status": "pending",
        "updated_at": "2026-08-31T14:22:05Z"
      }
    ],
    "total": 102
  }
  ```
</ResponseExample>


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