v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Reservations

Cancels a pending or recorded payment

Use this endpoint to cancel a pending or recorded payment

patch/reservations/{id}/payments/{paymentId}/cancel

Path parameters

idstring required

Reservation ID

paymentIdstring required

Payment ID

Response

Retrieve the updated reservation payments

statusstring

Payment status

amountnumber

cancelledAtstring date

Date of cancellation

notestring

Example response

{
  "status": "CANCELLED",
  "paymentMethod": {
    "method": "RECORDED_CASH",
    "id": "5fa02fa358d2db673e17bc2d"
  },
  "amount": 10,
  "cancelledAt": "2023-05-30T12:00:00.000Z",
  "note": "Free text"
}