Payment method webhooks
Subscribe to payment method webhooks for updates on status changes
Upgrade to the latest version
These docs are for version
2023-12-01. We encourage you to upgrade to version2024-10-16to access new features. Please see the changelog for more information.
Payment methods
Webhooks can be configured to receive updates on every status change that occurs through the lifecycle of a payment method.
Payment method statuses
Payment method webhook payload
The webhook payload data field represents all payment method detail fields returned by the get payment method endpoint.
Payment method events
| Event | Payment Method Status | Description |
|---|---|---|
payment_method.created | CREATED | Triggered when a payment method is created and awaiting presentation or activation. |
payment_method.presenting | PRESENTING | Triggered when a payment method is presented on an EMV device and waiting for the user to provide their payment method for storage. |
payment_method.active | ACTIVE | Triggered when a payment method has been deemed ready for use. |
payment_method.canceled | CANCELED | Triggered when a payment method is unavailable for use. For example, if the payment method is invalid or failed to be collected on an EMV device. |
payment_method.failed | FAILED | Triggered when a payment method has failed. |
payment_method.replaced | REPLACED | Triggered when a payment method is replaced by a new payment method. |
Updated about 2 months ago