Create payment

post

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

Creates a payment on a reservation.

Replaces the deprecated Record or process a reservation payment for processor payments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

reservationId

string

required

Guesty reservation id

paymentMethodId

string

required

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

amount

number

required

≥ 1

Amount to charge, in the reservation currency. Must be at least 1. Cannot exceed the reservation balance unless isSecurityDeposit is true.

shouldBePaidAt

date-time

When to charge. Must not be in the past. Omit to charge immediately. Format: YYYY-MM-DDTHH:mm:ss.SSSZ.

isAuthorizationHold

boolean

When true, creates an authorization hold instead of a charge. Cannot be true together with isSecurityDeposit. Capture a non-deposit hold with POST /payments/{paymentId}/capture.

isSecurityDeposit

boolean

When true, creates a security deposit authorization hold. Requires releaseAuthorizationHold, released at releaseAuthorizationHold.shouldTriggerAt. Cannot be true together with isAuthorizationHold.

releaseAuthorizationHold

object

Release schedule for a security deposit. Required when isSecurityDeposit is true.

note

string

length ≤ 500

Note stored on the payment

Responses

401

Missing or invalid authentication.

201The created payment

400The request is invalid.

402The payment cannot proceed.

422The request cannot be processed.

500Internal server error. Try again later.

503The reservation is not ready for payments yet. This happens right after the reservation is created, before its payment data is available. No payment was created. Retry the same request later.