API Reference

Record offline payment

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

Records an offline payment on a reservation without charging a processor.

Replaces recorded payments created through the deprecated Record or process a reservation payment.

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

Guesty reservation id

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
required
≥ 1

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

paymentMethod
object
required

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?