GUguesty
Reservations

Record or process a reservation payment

Changed on

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 recorded payment indicates the funds were collected in other methods such as bank transfer, cash, e-check etc

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

Request

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

Path parameters

idstring required

Reservation ID

Request body

amountnumber float required

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

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

Changes

  • 3122b8618183Revision changes
    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • 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 reservationsV2PaymentCreate 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