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

# List payments

> Get your payments, one page at a time, with filters.

Requires the **Ramps, banks & methods** scope (payments read).

## Headers

**API-Version** `string` *required* (default: 2026-10-29-atlas)

Your account's API version.

## Query

**page** `integer` (default: 1)

Which page. Starts at 1.

**limit** `integer` (default: 25)

How many per page. Up to 100.

**sort** `string` (default: desc)

`desc` (newest first) or `asc`.

**sort\_by** `string` (default: created\_at)

`created_at` or `updated_at`.

**type** `string`

`onramp` or `offramp`.

**status** `string`

`pending`, `success`, or `failed`.

**state** `string`

Any state, for example `fiat_pending` or `completed`.

**customer\_id** `string`

Only this customer's payments.

**created\_after** `string`

Created at or after this date, for example `2026-10-01`.

**created\_before** `string`

Created before this date. Must be later than `created_after`.

**decode** `string` (default: false)

`true` to include the `quote` and `customer` details in each payment.

## Response

`200 OK`

**status** `string`

`success`

**message** `string`

`Payments retrieved`

**count** `integer`

How many payments are on this page.

**pagination** `object`

`page`, `limit`, `total`, `total_pages`, `has_more`.

**payments** `array`

The payments. Each has the same fields as [Get a payment](https://docs.bridge.linkio.world/api-reference/payments/details.md#response).

## Errors

| Status | Code | Why |
| - | - | - |
| `422` | `validation_failed` | A filter is invalid. For example `limit must be at most 100`, or `created_before must be later than created_after`. |

```bash cURL theme={null}
curl "https://sandbox.core.linkio.world/api/payments/list?type=onramp&status=success&limit=10&decode=true" \
  -H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
  -H "API-Version: 2026-10-29-atlas"
```

```json 200 theme={null}
{
  "status": "success",
  "message": "Payments retrieved",
  "count": 1,
  "pagination": { "page": 1, "limit": 10, "total": 1, "total_pages": 1, "has_more": false },
  "payments": [
    {
      "id": "pay_8fK2mQ9xLp3VnR7tY1wZ4cB6dE",
      "customer_id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
      "reference_id": "ref_7tY1wZ4cB6dE8fK2mQ9xLp3VnR",
      "quote_id": "qte_9xLp3VnR7tY1wZ4cB6dE8fK2mQ",
      "quote": {
        "id": "qte_9xLp3VnR7tY1wZ4cB6dE8fK2mQ",
        "source_amount": "150000",
        "source_currency": "NGN",
        "target_amount": "97.71",
        "target_currency": "USDC",
        "network": "solana",
        "rate": "1535",
        "payment_method": "bank_transfer",
        "payout_method": "stablecoin"
      },
      "customer": { "id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE", "name": "Ada Obi", "email": "ada@example.com" },
      "type": "onramp",
      "status": "success",
      "state": "completed",
      "transaction_hash": "8c1f0e9a…",
      "created_at": "2026-10-28T10:15:02.000Z",
      "updated_at": "2026-10-28T10:21:17.000Z"
    }
  ]
}
```


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