GUguesty
Reservations

Cancel a pending or recorded payment

Changed on

Use this endpoint to cancel a pending or recorded payment

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.

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

Request

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

Path parameters

idstring required

Reservation ID

paymentIdstring required

Payment ID

Response

Retrieve the updated reservation payments

statusstring

Payment status

amountnumber float
cancelledAtstring date-time

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"
}

Changes

  • 3122b8618183Revision changes
    • breaking

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

    • info

      api operation id reservationsV2PaymentCancelUpdate was added

    • info

      endpoint deprecated