Skip to Content
Developers
Payments

List payments

GET
/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.

Authorization

apiKey
headerAuthorizationBearer wo_live_...

A key from the shop's admin. Secret keys start with wo_live_, public keys with wo_pub_.

Query parameters

cursor?string

next_cursor from the page before. Leave out for the first page.

Lengthlength <= 200
limit?integer

How many objects a page holds.

Range1 <= value <= 100
Default25
order?string

The list sorts on paid_at, then the id. desc puts the payment noted last first.

Default"desc"
Value in"asc""desc"
method?string

Only payments by this method, such as cash.

Lengthlength <= 32
paid_after?string

Only payments noted at or after this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.

Formatdate-time
paid_before?string

Only payments noted before this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.

Formatdate-time

Response body

The request worked.

application/json
  1. response
data*array<>
has_more*boolean

Whether another page follows this one.

next_cursor*|null
object*string
Example request
curl 'https://api.weerom.com/v1/payments'
Example response
{  "data": [    {      "amount_cents": 4000,      "booking_code": "UEAMEFC9",      "booking_id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90",      "currency": "EUR",      "customer": {        "email": "[email protected]",        "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"}

Details

Keys

Read keyWrite key

Any other kind of 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. Errors has all of them.

StatuscodeWhenWhat to do
400invalid_requestA 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.