Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations

Update or cancel a payment for reservation

Use this request to update or cancel an upcoming payment. To cancel, set the the payment status to CANCELLED.

put/reservations/{id}/payments/{paymentId}

Path parameters

idstring required

Reservation ID

paymentIdstring required

Payment ID

Request body

status'PENDING' | 'PENDING_AUTH' | 'FAILED' | 'SUCCEEDED' | 'CANCELLED' | 'AUTHORIZATION_HOLD_SUCCEEDED' | 'FAILED_FULLY_PAID' | 'PENDING_ACTIVATION'

Payment status

amountnumber
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
stripePaymentMethodTokenstring

Stripe pm_ token representing a credit card tok_ kind of tokens are NOT supported

Example request

{
  "status": "SUCCEEDED",
  "paymentMethod": {
    "method": "CASH",
    "id": "5fa02fa358d2db673e17bc2d"
  },
  "amount": 10,
  "shouldBePaidAt": "2023-05-30T12:00:00.000Z",
  "paidAt": "2023-05-30T12:00:00.000Z",
  "note": "Free text",
  "stripePaymentMethodToken": "pm_stipetoken"
}

Response

Retrieve the updated reservation payments

paymentProviderIdstring