GUguesty
Reservations

Update or cancel a pending payment

Changed on

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

Note: This endpoint will be deprecated as part of the move to the Reservations Open API [Beta] (v3). See the Reservations V3 Booking Flow guide for what's available today.

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

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/reservations/{id}/payments/{paymentId}
  • Auth
    API key in header authorization

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 float

Amount to charge.

shouldBePaidAtstring date-time

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

paidAtstring date-time

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

notestring

Free text note about the payment.

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

Changes

  • 3122b8618183Revision changes
    • breaking

      the request property format changed from no format to float

    • breaking

      the / response's property format changed from date to date-time for status

    • breaking

      the / response's property format changed from date to date-time for status

    • breaking

      the / response's property format changed from date to date-time for status

    • info

      api operation id reservationsV2PaymentUpdate was added

    • info

      endpoint deprecated

    • info

      the request property format was generalized from date to date-time

    • info

      the request property format was generalized from date to date-time