Event types
Last updated: April 29, 2022
Checkout.com sends webhooks for a number of event types.
To subscribe to certain event types, follow the instructions in webhook management.
Webhook event type | Description |
---|---|
View a card verified webhook example. | Card verified Occurs when a card verification is successful. |
| Card verification declined Occurs when a card verification is not approved. |
View a dispute canceled webhook example. | Dispute canceled Occurs when a dispute is canceled by the issuing bank and your account is credited back the disputed amount. |
| Dispute evidence required Notifies you that you need to respond to a dispute, and that your account has been debited the disputed amount. |
View a dispute expired webhook example. | Dispute expired Notifies you that you can no longer respond to a dispute, because the time limit to take action has been exceeded. |
View a dispute lost webhook example. | Dispute lost Notifies you that the issuing bank has rejected your evidence and you have lost the dispute. |
View a dispute resolved webhook example. | Dispute resolved Occurs when we automatically resolve the dispute because it had already been refunded. |
View a dispute won webhook example. | Dispute won Notifies you that the issuing bank has accepted your evidence and you have won the dispute. Your account has been credited back the disputed amount. |
View a payment approved webhook example. | Payment approved Occurs when an acquirer or provider approves a payment. |
View a payment pending webhook example. | Payment pending Occurs on asynchronous payments when further action is required. |
View a payment declined webhook example (for payments) or a payment declined webhook example (for Card Payouts). | Payment declined Occurs when a payment times out, or is declined by the acquirer or provider. |
View a payment expired webhook example. | Payment expired Occurs when the merchant generates an alternative Payment Link but the customer fails to access it to complete the payment. |
View a payment voided webhook example. | Payment voided Occurs when an acquirer voids an authorized payment. |
View a payment canceled webhook example. | Payment canceled Occurs when an end user cancels the payment through the provider’s interface. |
| Payment void declined Occurs when a void attempt times out, or is declined by the acquirer or provider. |
View a payment captured webhook example. | Payment captured Occurs when an acquirer captures an authorized card payment, or when the provider completes an alternative payment capture. |
| Payment capture declined Occurs when a capture times out, or is declined by the acquirer. |
| Payment capture pending Occurs when an acquirer is in the process of capturing a payment. |
View a payment refunded webhook example. | Payment refunded Occurs when an acquirer refunds a captured payment. |
| Payment refund declined Occurs when a payment refund times out, or is declined by an acquirer. |
| Payment refund pending Occurs when an acquirer is in the process of refunding a payment. |
| Payment chargeback Occurs when a chargeback is requested for a payment. |
| Payment retrieval Occurs when a retrieval is requested for a payment. |
View a source updated webhook example. | Source updated Occurs when a payment source has been updated. |
Only applies to payouts. View a payment paid webhook example. | Payment paid Occurs when a payout is made to a card. |
Information
Receiving a payment_captured
notification via webhooks is the only way to confirm a payment completes successfully.
Use this API request to view all available event types.
get
https://api.checkout.com/event-types
Header | Value |
---|---|
required |
Use the valid secret key of your Checkout.com account. You can find this in the Hub. |
required |
|
Query parameters | Description |
---|---|
optional | The version of the API that you wish to retrieve event types for. Use |