Skip to Content
Developers
Payments

Get a payment

GET
/payments/{id}

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.

Authorization

apiKey
headerAuthorizationBearer wo_live_...

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

Path parameters

id*string

The object's id.

Formatuuid

Response body

The request worked.

application/json
  1. response

A booking a customer paid for at the chair. WeerOm notes the payment, it does not take the money.

amount_cents*integer

What the customer paid for the service, VAT included.

booking_code*string

The short code the customer sees on the booking.

booking_id*string

The booking this payment settled.

Formatuuid
currency*string

ISO 4217 code of every amount on this object.

customer*

Who the booking is for, as written on the booking when it was made.

description*string

The service's name, for an invoice line.

discount_percent*integer

Percent off the list price from a deal. 0 without one.

id*string

The payment's id. The same value as booking_id.

Formatuuid
list_price_cents*integer

The price before any deal or change at the chair.

method*|null
net_cents*integer

amount_cents without VAT, rounded half up.

object*string
paid_at*string

When staff noted the payment.

Formatdate-time
service_id*|null
staff_id*string

Who did the work.

Formatuuid
starts_at*string

When the appointment started.

Formatdate-time
tip_cents*integer

Not part of amount_cents.

vat_cents*integer

The VAT inside amount_cents.

vat_percent*number

The shop's VAT rate on services as it is set today. 0 for a shop under an exemption.

Example request
curl 'https://api.weerom.com/v1/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example response
{  "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}

Details

Keys

Read keyWrite key

Any other kind of key answers 403 key_not_allowed.

What it does

  • A payment's id is the id of the booking it settled. A booking without a noted payment answers 404 here.
  • net_cents and vat_cents are worked out on each read, at the shop's VAT rate as it is set at that moment.

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
404not_foundNo object has this id, or the id is not a UUID.Check the id. Ids are UUIDs from a list or from an earlier answer.