# List payments

Source: https://developers.weerom.com/docs/reference/payments/listPayments

```http
GET https://api.weerom.com/v1/payments
```

Bookings a customer paid for, sorted by when staff noted the payment. This is the list an invoicing tool reads: each one carries the amount, the VAT inside it and who paid.

**Keys:** a key that may read. A public key gets 403.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `cursor` | query | string | no | `next_cursor` from the page before. Leave out for the first page. At most 200 characters. |
| `limit` | query | integer | no | How many objects a page holds. 1 to 100, default `25`. |
| `order` | query | `asc`, `desc` | no | The list sorts on `paid_at`, then the id. `desc` puts the payment noted last first. Default `desc`. |
| `method` | query | string | no | Only payments by this method, such as `cash`. At most 32 characters. |
| `paid_after` | query | string (date-time) | no | Only payments noted at or after this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z. |
| `paid_before` | query | string (date-time) | no | Only payments noted before this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z. |

## Responses

### 200

The request worked.

| Field | Type | Description |
| --- | --- | --- |
| `data` | array of object |  |
| `data[].amount_cents` | integer | What the customer paid for the service, VAT included. |
| `data[].booking_code` | string | The short code the customer sees on the booking. |
| `data[].booking_id` | string (uuid) | The booking this payment settled. |
| `data[].currency` | string | ISO 4217 code of every amount on this object. |
| `data[].customer` | object | Who the booking is for, as written on the booking when it was made. |
| `data[].customer.email` | string or null |  |
| `data[].customer.id` | string (uuid) or null | Null when the customer record was erased. |
| `data[].customer.name` | string |  |
| `data[].customer.phone` | string or null |  |
| `data[].description` | string | The service's name, for an invoice line. |
| `data[].discount_percent` | integer | Percent off the list price from a deal. 0 without one. |
| `data[].id` | string (uuid) | The payment's id. The same value as `booking_id`. |
| `data[].list_price_cents` | integer | The price before any deal or change at the chair. |
| `data[].method` | string or null | How they paid. Null when staff did not say. |
| `data[].net_cents` | integer | `amount_cents` without VAT, rounded half up. |
| `data[].object` | `payment` |  |
| `data[].paid_at` | string (date-time) | When staff noted the payment. |
| `data[].service_id` | string (uuid) or null | The service's id. Null when the shop deleted the service since. |
| `data[].staff_id` | string (uuid) | Who did the work. |
| `data[].starts_at` | string (date-time) | When the appointment started. |
| `data[].tip_cents` | integer | Not part of `amount_cents`. |
| `data[].vat_cents` | integer | The VAT inside `amount_cents`. |
| `data[].vat_percent` | number | The shop's VAT rate on services as it is set today. 0 for a shop under an exemption. |
| `has_more` | boolean | Whether another page follows this one. |
| `next_cursor` | string or null | Send as `cursor` for the next page. Null on the last. |
| `object` | `list` |  |

Example:

```json
{
  "data": [
    {
      "amount_cents": 4000,
      "booking_code": "UEAMEFC9",
      "booking_id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90",
      "currency": "EUR",
      "customer": {
        "email": "lotte@example.com",
        "id": "5f0c9d3a-7b2e-4c61-8a4d-9e1f3b6c2d75",
        "name": "Lotte Peeters",
        "phone": "+32470123456"
      },
      "description": "Knippen en baard",
      "discount_percent": 0,
      "id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90",
      "list_price_cents": 4000,
      "method": "bancontact",
      "net_cents": 3306,
      "object": "payment",
      "paid_at": "2026-11-21T10:12:40.000Z",
      "service_id": "c2a41f6e-8d3b-4e97-b5a0-1f7c9e2d4a68",
      "staff_id": "8e1d5b7c-3a9f-4d20-b6c4-7a2e0f9d1c53",
      "starts_at": "2026-11-21T09:30:00.000Z",
      "tip_cents": 200,
      "vat_cents": 694,
      "vat_percent": 21
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "object": "list"
}
```

### 400

A parameter or a field is missing or malformed.

### 401

No key, an unknown key or a revoked key.

### 403

The shop's plan does not include the API, or this kind of key may not call this.

### 429

Too many requests. Retry-After says when.

Every error answers `{ "error": { "code", "message", "param", "request_id" } }`. `param` is only on some 400 answers. See [Errors](https://developers.weerom.com/docs/errors).

## Keys

A read key or a write key. A public key answers 403 `key_not_allowed`.

## Sort

By `paid_at`, the moment staff noted the payment, then by `id`. `order=desc`, the default, lists the newest first. `order=asc` starts with the oldest, which is the order a sync wants.

## Filters

- `paid_after` includes a payment noted at that exact moment. A sync that sends the last `paid_at` it saw gets that payment again and skips it by `id`.
- `paid_before` leaves out a payment noted at that exact moment.
- `method` matches the stored word exactly, such as `cash` or `bancontact`.

## What it does

- A payment is a booking with a noted payment. Its `id` is the booking's id.
- When staff change the method or an amount, `paid_at` moves to that moment, so the payment comes back in a later `paid_after` run with the same `id`. When staff clear a payment, it leaves the list.
- `net_cents` and `vat_cents` use the shop's VAT rate as it is set at the moment you read.

## When a field is null

- `method` is `null` when no method was recorded with the payment.
- `service_id` is `null` when the booking is not linked to a service record. The name written on the booking still shows.
- `customer.id` is `null` when the shop erased the customer's record. The booking keeps the name, email and phone written on it.
- `customer.email` is `null` when the booking holds no email. Staff may book without one.
- `customer.phone` is `null` when the booking holds no phone number.

## Errors

Besides 401 for a missing, unknown or removed key, 403 `plan_required`, 429 `rate_limited` and 500 `internal_error`, which every endpoint can answer:

| Status | `code` | When | What to do |
| --- | --- | --- | --- |
| 400 | `invalid_request` | A parameter is malformed or unknown, a date has no time and offset, or the cursor is not one the API gave out. | Fix the parameter `param` names. |
