Payment method webhooks
API version 2023-01-01 deprecating
This version will be deprecated on May 1, 2025. If your platform is on this version, you should upgrade to at least 2023-12-01 to simplify authorization and access new features.
Payment methods
Webhooks can be configured to receive updates on every status change that occurs through the lifecycle of a payment method.
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 | Description |
|---|---|
payment_method.created | Triggered when a payment method is created and awaiting presentation or activation. The payment method status is CREATED. |
payment_method.presenting | Triggered when a payment method is presented on an EMV device and waiting for the user to provide their payment method for storage. The payment method status is PRESENTING. |
payment_method.active | Triggered when a payment method has been deemed ready for use. The payment method status is ACTIVE. |
payment_method.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. The payment method status is CANCELED. |
payment_method.failed | Triggered when a payment method has failed. The payment method status is FAILED. |
Updated 6 months ago