Webhooks events
Preface
Webhooks events
Preface
Understand the different webhook events triggered by xPay during the payment and subscription processes.
xPay triggers various webhook events to keep you informed about the status of payment intents and subscription activities. Below is a list of the events you may encounter and their descriptions.
Payment Intent Events
| Event Name | Event Type | Description |
|---|---|---|
| Intent Created | intent.created | This event is triggered when a new payment intent is successfully created. |
| Intent Checkout Opened | intent.checkout_opened | This event is triggered when the checkout page for a payment intent is opened by the customer. |
| Intent Success | intent.success | This event indicates that the payment intent has been successfully processed and the payment is complete. |
| Intent Failed | intent.failed | This event is triggered when the payment process for a given intent fails due to an error or insufficient funds. |
| Intent Refunded | intent.refunded | This event is triggered when a payment intent is successfully refunded. |
| Intent Disputed | intent.disputed | This event is triggered when a dispute or chargeback is raised against a processed payment. |
| Intent Dispute Won | intent.dispute_won | This event is triggered when a previously disputed payment is resolved in favor of the merchant. |
Subscription Events
| Event Name | Event Type | Description |
|---|---|---|
| Subscription Created | subscription.created | This event is triggered when a new subscription intent is successfully created. |
| Subscription Checkout Opened | subscription.checkout_opened | This event is triggered when the checkout page for a subscription is opened by the customer. |
| Subscription Trialing | subscription.trialing | This event is triggered when a subscription enters the trial phase before becoming active. |
| Subscription Active | subscription.active | This event indicates that the subscription is now active and recurring charges are scheduled. |
| Subscription Cycle Charged | subscription.cycle_charged | This event is triggered each time a recurring charge is successfully processed for an active subscription. |
| Subscription Unpaid | subscription.unpaid | This event occurs when a subscription enters an unpaid state, typically due to a failed payment attempt. |
| Subscription Ended | subscription.ended | This event indicates that the subscription has either been completed naturally or cancelled and is now considered ended. |
| Subscription Cancelled | subscription.cancelled | This event is triggered when a subscription is cancelled by the merchant. |
These events are designed to help you track and respond to changes in payment and subscription statuses, ensuring a smooth integration with xPay’s systems. Make sure to handle each event appropriately within your webhook implementation.
For more details on how to handle webhooks and event security, refer to the Webhooks Introduction.
Was this page helpful?