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

# List payments

> GET /v1/payments lists every payment the business sent, newest first, including held, returned, refunded and cancelled payments.

```
GET /v1/payments
```

**Scope:** `payments:read` or `payables:read`

Returns every payment the business sent: held, returned, refunded and cancelled ones included, and each split and retry as its own payment.

## Query parameters

<ParamField query="page" type="integer" default="1">Page number.</ParamField>
<ParamField query="pageSize" type="integer" default="25">1 to 100.</ParamField>
<ParamField query="payableId" type="string">Only payments for this bill, every split and retry included.</ParamField>
<ParamField query="contactId" type="string">Only payments to this contact.</ParamField>

<ParamField query="status" type="string">
  `pending`, `scheduled`, `processing`, `held`, `completed`, `failed`, `returned`, `cancelled`, `refund_pending` or `refunded`.
</ParamField>

<ParamField query="createdAfter" type="string">ISO 8601 time. Created at or after it.</ParamField>
<ParamField query="createdBefore" type="string">ISO 8601 time. Created before it.</ParamField>

```bash theme={null}
curl "https://api.stg.cleo-pay.com/v1/payments?payableId=b1e2c3d4-5f6a-4b8c-9d0e-1f2a3b4c5d6e" \
  --header "Authorization: Bearer $CLEO_API_KEY"
```

## Response

`200` with `{ items, totalCount }`. Each item is a [payment](/concepts/payments#the-payment-object). Items are newest first, with ties in a fixed order, so walking the pages neither repeats nor skips a payment that did not change.

A payment the business recorded outside Cleo (check, wire, cash) has `paymentRail: null`.


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