Payment Webhooks

Overview

Guesty's Open API allows you to send guest payment-related webhooks to your application's notification URL(s).

What Notifications Can I Receive?

Guesty sends a payment webhook when a guest payment method has been received/added.

Payment Method Received

This webhook is sent when a valid payment method is added to the guest and reservation. Learn how to subscribe to this webhook here.

Event to Subscribe

payments.method.received

Webhook Payload

Body Parameter	Data Type	Description
`payment`	object
`accountId`	string	The ID of your Guesty account.
`reservationId`	string	The Guesty ID of the affected reservation.
`paymentId`	string	The Guesty ID of the payment.
`ctx`	object	It contains the request ID you can share with Guesty support for additional troubleshooting.
`event`	string	`payments.method.received`

Payload Example

{
  "payment":{
    "accountId":"5213a2d206112710005d96ff",
    "reservationId":"667ad00db904239ef0b9cbdd",
    "paymentId":"668520e93cac721c718e845f",
    "ctx":{
      "requestId":"9a55a5e6a0d18a7f"
    }
  },
  "event":"payments.method.received"
}