API Reference

Update payment

patch
https://open-api.guesty.com/v1/payments/

Updates amount, paymentMethodId, shouldBePaidAt, or note on a processor payment. Recorded payments must use PATCH /payments/{paymentId}/record.

Replaces the deprecated Update or cancel a pending payment.

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

Guesty payment id

Body Params
string

Guesty payment method id. Recorded payment methods must use the recorded-payment endpoints.

number
≥ 1

Updated payment amount, in the reservation currency. Must be at least 1.

date-time

New scheduled payment date. Omit to leave the existing date unchanged. This update does not charge. Format: YYYY-MM-DDTHH:mm:ss.SSSZ.

string
length ≤ 500

Note stored on the payment

Responses

401

Missing or invalid authentication.

Updated about 2 hours 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 2 hours ago

Did this page help you?