Event types
Checkout.com sends webhooks for a number of event types.
To subscribe to certain event types, follow the instructions in webhook management.
List of event types
| Webhook event type | Description |
|---|---|
| Card verified Occurs when a card verification is successful. |
| Card verification declined Occurs when a card verification is not approved. |
| 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. |
| Dispute expired Notifies you that you can no longer respond to a dispute, because the time limit to take action has been exceeded. |
| Dispute lost Notifies you that the issuing bank has rejected your evidence and you have lost the dispute. |
| Dispute resolved Occurs when we automatically resolve the dispute because it had already been refunded. |
| 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. |
| Payment approved Occurs when an acquirer or provider approves a payment. |
| Payment pending Occurs on asynchronous payments when further action is required. |
| Payment declined Occurs when a payment times out, or is declined by the acquirer or provider. |
| Payment expired Occurs when the merchant generates an alternative Payment Link but the customer fails to access it to complete the payment. |
| Payment voided Occurs when an acquirer voids an authorized payment. |
| 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. |
| 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. |
| 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. |
| Source updated Occurs when a payment source has been updated. |
| 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.
Get event types (API)
Use this API request to view all available event types.
The GET request
Endpoints
https://api.checkout.com/event-types
Header parameters
| Header | Value |
|---|---|
required |
|
required |
|
Query parameters
| Query parameters | Description |
|---|---|
optional | The version of the API that you wish to retrieve event types for. Use |