Webhooks
Overview
Webhooks are real-time callbacks sent from Zoho Payments servers to your servers when specific events occur. You can subscribe to a predefined set of events while configuring the URL to receive these callbacks. These notifications enable you to automatically take appropriate actions based on the events.
Payment Webhook
A payment webhook is triggered when a payment transaction is processed in Zoho Payments, notifying your system of the payment status (successful, declined, or pending). It provides key details like transaction ID, amount, and payment method, enabling your system to take immediate actions such as order fulfillment or customer notifications. This webhook ensures you’re always up to date with transaction statuses.
Below is a list of payment webhook events and their descriptions.
Events | Description |
---|---|
payment_session.succeeded | This event is triggered when a payment session is succeeded. |
payment_session.failed | This event is triggered when a payment session is failed. |
payment.succeeded | This event is triggered when a payment is succeeded. |
payment.failed | This event is triggered when a payment is failed. |
Refund Webhook
A Refund Webhook is triggered when a refund is initiated or processed. It notifies your system about the refund status (successful, failed, or pending), including details like the original transaction ID and refunded amount. Subscribing to this webhook helps automate actions like updating customer accounts or notifying customers about their refund status in real-time.
Below is a list of refund webhook events and their descriptions.
Events | Description |
---|---|
refund.succeeded | This event is triggered when a refund is succeeded. |
refund.failed | This event is triggered when a refund is failed. |