API Reference

Update or cancel a pending payment

put deprecated
https://open-api.guesty.com/v1/reservations//payments/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Reservation ID

string
required

Payment ID

Body Params

Payment parameters

string
enum

Payment status

paymentMethod
object
required

Payment method object with a 'CASH' payment method example

float

Amount to charge.

date-time

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

date-time

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

string

Free text note about the payment.

string

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

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?