GUguesty
Reservations

Refund a payment

Changed on

Use this endpoint to refund a guest's payment charged on an existing reservation.

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.

post/reservations/{id}/payments/{paymentId}/refund

Request

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

Path parameters

idstring required

Reservation ID

paymentIdstring required

Payment ID

Request body

amountnumber float required

Amount to refund.

notestring

Free text note about the refund.

Example request

{
  "amount": 100,
  "note": "Free text"
}

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 reservationsV2PaymentRefundCreate was added

    • info

      endpoint deprecated