List 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.
apiKeyAuthorizationBearer wo_live_...A key from the shop's admin. Secret keys start with wo_live_, public keys with wo_pub_.
cursor?stringnext_cursor from the page before. Leave out for the first page.
length <= 200limit?integerHow many objects a page holds.
1 <= value <= 10025order?stringThe list sorts on paid_at, then the id. desc puts the payment noted last first.
"desc""asc""desc"method?stringOnly payments by this method, such as cash.
length <= 32paid_after?stringOnly payments noted at or after this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.
date-timepaid_before?stringOnly payments noted before this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.
date-timeThe request worked.
application/json- response
data*array<>has_more*booleanWhether another page follows this one.
next_cursor*|nullobject*stringcurl 'https://api.weerom.com/v1/payments'{ "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_afterincludes a payment noted at that exact moment. A sync that sends the lastpaid_atit saw gets that payment again and skips it byid.paid_beforeleaves out a payment noted at that exact moment.methodmatches the stored word exactly, such ascashorbancontact.
What it does
- A payment is a booking with a noted payment. Its
idis the booking's id. - When staff change the method or an amount,
paid_atmoves to that moment, so the payment comes back in a laterpaid_afterrun with the sameid. When staff clear a payment, it leaves the list. net_centsandvat_centsuse the shop's VAT rate as it is set at the moment you read.
When a field is null
methodisnullwhen no method was recorded with the payment.service_idisnullwhen the booking is not linked to a service record. The name written on the booking still shows.customer.idisnullwhen the shop erased the customer's record. The booking keeps the name, email and phone written on it.customer.emailisnullwhen the booking holds no email. Staff may book without one.customer.phoneisnullwhen 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.
| 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. |
Move a booking POST
Moves a booking to another time, and to another staff member when `staff_id` is sent. The customer gets the shop's mail about the move. As `customer` the shop's cut-off for moving applies. **Keys:** a key that may read and change. Any other key gets 403.
Get a payment GET
One payment by its id, which is the id of the booking it settled. Answers 404 while the booking is unpaid. **Keys:** a key that may read. A public key gets 403.