API Reference

Update recorded payment

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

Updates a recorded payment. Sending a recorded payment method on a failed processor payment marks it as recorded: status becomes SUCCEEDED and paidAt is set to the current date and time.

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

Guesty payment id

Body Params
date-time

When to record the payment. On create, omit this field or send a past date to record it now (SUCCEEDED, paidAt set to that time, or the current date and time when omitted). A future date schedules it as PENDING. On update, omit this field to leave the existing time unchanged. Format: YYYY-MM-DDTHH:mm:ss.SSSZ.

number
≥ 1

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

paymentMethod
object

Recorded payment method

string

Booking confirmation code of the reservation (for example GY-123456). This is not a processor payment id.

string
length ≤ 500

Note stored on the recorded 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?