Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations

Add a payment to reservation

Use this request to create an immediate or future payment, and to add a record to payment history.

An immediate or future payment is charged using a credit card, where a rerocded payment indicates the funds were collected in other methods such as bank transfer, cash, e-check etc

post/reservations/{id}/payments

Path parameters

idstring required

Reservation ID

Request body

amountnumber required
shouldBePaidAtstring date

Expected charge date. Not passing this param at all or passing it with a past date, will immediately charge the payment.

paidAtstring date

Used when adding a record to payment history - the actual charge date.

notestring

Free text

isAuthorizationHoldboolean

True in case of Authorization hold kind of payments

Example request

{
  "paymentMethod": {
    "method": "CASH",
    "id": "5fa02fa358d2db673e17bc2d"
  },
  "amount": 10,
  "shouldBePaidAt": "2023-05-30T12:00:00.000Z",
  "paidAt": "2023-05-30T12:00:00.000Z"
}

Response

Retrieve the created payment for reservation

paymentProviderIdstring