Webhooks
Webhooks are real-time notifications 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 notifications. This enables you to take appropriate actions swiftly, based on the events.
Note: Webhooks in Zoho Payments is available on early access. To enable them for your account, contact support@zohopayments.com.
Zoho Payments supports the following webhooks:
Payment Webhooks
A payment webhook is triggered when a payment is processed in Zoho Payments, notifying your system of the payment status (successful, declined, or pending). It provides details like payment 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 succeeds, providing payment details. |
| payment_session.failed | This event is triggered when a payment session fails, providing the reason for failure and payment details. |
| payment.succeeded | This event is triggered when a payment succeeds, providing details such as the payment ID, payment method, and amount paid. |
| payment.failed | This event is triggered when a payment fails, providing information about the failure reason, allowing you to take necessary actions to resolve the issue. |
Refund Webhooks
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 payment 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 successful, providing details such as the refund amount, payment ID, and the reason for the refund. |
| refund.failed | This event is triggered when a refund fails, providing the failure reason. |
Payout Webhooks
A payout webhook is triggered when a payout transaction is processed in Zoho Payments, notifying your system of the payout status (initiated, completed, or failed). It provides key details like payout ID, amount, and transaction summary, enabling your system to track payout progress and take appropriate actions.
Below is a list of payout webhook events and their descriptions.
| Events | Description |
|---|---|
| payout.initiated | This event is triggered when a payout is successfully initiated, providing details like payout ID, amount, and transaction summary. |
| payout.paid | This event occurs when a payout is successfully completed, with details such as payout ID, amount, and transaction summary. |
| payout.failed | This event occurs when a payout fails for various reasons, including payout ID, amount, transaction summary, and the failure reason. |
