Webhook event types

Last updated: January 15, 2025

This page lists the webhooks you may receive from your Checkout.com integrations. For each webhook, we include one or both of the following:

Event type – The code-formatted name your webhook receiver listens for
Display name – The plain text name as displayed in the Dashboard

Event type Display name Description

Event type	Display name	Description
`card_updated` See example	Card updated	Occurs when the Real-Time Account Updater updates card details, or the account is closed.

card_updated

See example

Card updated

Occurs when the Real-Time Account Updater updates card details, or the account is closed.

Event type	Display name	Description
`authentication_approved` See example	Authentication approved	Occurs when an authentication request is approved.
`authentication_attempted` See example	Authentication attempted	Occurs when an authentication is attempted and the card scheme or issuer responds with `attempted` status.
`authentication_expired` See example	Authentication expired	Occurs when an authentication request expires.
`authentication_failed` See example	Authentication failed	Occurs when an authentication request fails.
`authentication_started` See example	Authentication started	Occurs when an authentication request from a merchant or gateway passes validation.

Event type Display name Description

Event type	Display name	Description
`sub_account_top_up_received` See example	Top-up received	Occurs when a top-up is applied to a sub-account's balance.
`sub_account_low_balance_threshold_exceeded` See example	Balance below threshold	Occurs when a sub-account balance falls below its low-balance threshold.

sub_account_top_up_received

See example

Top-up received

Occurs when a top-up is applied to a sub-account's balance.

sub_account_low_balance_threshold_exceeded

See example

Balance below threshold

Occurs when a sub-account balance falls below its low-balance threshold.

Event type	Display name	Description
`dispute_accepted` See example	Dispute accepted	Occurs when you accept a dispute. No further action is required.
`dispute_arbitration_evidence_submitted` See example	Dispute arbitration evidence submitted	Occurs when you submit evidence to support an arbitration.
`dispute_arbitration_lost` See example	Dispute arbitration lost	Occurs when you lose an arbitration. Your account is debited any additional arbitration-related fees.
`dispute_arbitration_sent_to_scheme` See example	Dispute arbitration sent to scheme	Occurs when the documentation for an arbitration is sent to the card scheme.
`dispute_arbitration_won` See example	Dispute arbitration won	Occurs when you win an arbitration. Your account is credited the disputed amount.
`dispute_canceled` See example	Dispute canceled	Occurs when the issuing bank cancels a dispute. If previously debited, the disputed amount is credited back to you.
`dispute_evidence_acknowledged_by_scheme` See example	Dispute evidence acknowledged by the scheme	Occurs when the supporting documents you sent us are forwarded to the card scheme.
`dispute_evidence_required` See example	Dispute evidence required	Occurs when Checkout.com receives a dispute that you need to provide evidence for.
`dispute_evidence_submitted` See example	Dispute evidence submitted	Occurs when you submit evidence for a dispute. No further action is required from you.
`dispute_expired` See example	Dispute expired	Occurs when the time limit to take action against a dispute runs out. No further action is possible.
`dispute_lost` See example	Dispute lost	Occurs when the issuing bank rejects your evidence and you lose the dispute.
`dispute_received` See example	Dispute received	Occurs when Checkout.com receives a dispute notification from the card scheme.
`dispute_resolved` See example	Dispute resolved	Occurs when Checkout.com receives a dispute notification but no further action is required from you, because you've already refunded the customer.
`dispute_won` See example	Dispute won	Occurs when the issuing bank accepts your evidence and you win the dispute. If previously debited, the disputed amount is credited back to you.
`request_for_information_received` See example	Request for information received	Occurs when Checkout.com sends you a Request for Information (RFI) for a payment.

Event type Display name Description

Event type	Display name	Description
`payment_compliance_review` See example	Compliance review	Occurs when a payment is pending while under compliance review.

payment_compliance_review

See example

Compliance review

Occurs when a payment is pending while under compliance review.

Event type Display name Description

Event type	Display name	Description
`fraud_reported` See example	Fraud Reported	Occurs when a payment is reported as fraudulent.

fraud_reported

See example

Fraud Reported

Occurs when a payment is reported as fraudulent.

Event type	Display name	Description
`card_verification_declined` See example	Card verification declined	Occurs when a card verification is declined.
`card_verified` See example	Card verified	Occurs when a card verification is successful.
`payment_approved` See example	Payment approved	Occurs when an authorization for a payment is successfully approved.
`payment_authorization_increment_declined` See example	Payment authorization increment declined	Occurs when an authorization is declined.
`payment_authorization_incremented` See example	Payment authorization incremented	Occurs when an authorization is successfully incremented.
`payment_canceled` See example	Payment canceled	Occurs in some APM flows when the customer cancels the payment via a provider's platform.
`payment_capture_declined` See example	Payment capture declined	Occurs when a capture is declined.
`payment_capture_pending` See example	Payment capture pending	Occurs when the customer approves the payment on their banking page.
`payment_captured` See example	Payment captured	Occurs when a capture is successful.
`payment_declined` See example	Payment declined	Occurs when a payment authorization request times out, or if there is a rejection during authorization. For example, due to insufficient funds, the issuer blocking the card, or a Do Not Honor instruction.
`payment_expired` See example	Payment expired	Occurs when an APM payment expires (not applicable to 3DS payment expiries).
`payment_paid` See example	Payment paid	Occurs when a bank payout is paid.
`payment_pending` See example	Payment pending	Occurs when an asynchronous payment request has successfully initiated. For example, a payment that requires an additional action to complete it, such as a cardholder completing a redirect to an alternative payment method's checkout page.
`payment_refund_declined` See example	Payment refund declined	Occurs when a refund is declined.
`payment_refund_pending` See example	Payment refund pending	Occurs when a refund request is successfully initiated.
`payment_refunded` See example	Payment refunded	Occurs when a refund is successful.
`payment_retry_scheduled` See example	Payment retry scheduled	Occurs when a payment retry attempt fails, and provides information about the payment retry schedule.
`payment_returned` See example	Payment returned	Occurs when a payment is returned by a Pay to Bank (PTB) payment, or by some alternative payment methods (APMs) that support failure-after-success scenarios. For example, such as Automated Clearing House (ACH). These returns are triggered outside of Checkout.com.
`payment_void_declined` See example	Payment void declined	Occurs when the card scheme rejects a void request after successful authorization but before capture.
`payment_voided` See example	Payment voided	Occurs when a void is successful.
`bank_account_updated` See example	Bank account updated	This event is for ACH Direct Debit payments only, and occurs when the customer's bank account details change and must be updated for future payments.

See also:

Event type	Description
`identity_verification_anonymized` See example	Occurs when the verification has been anonymized and the `status` changed to `retry_required`, but a retry is no longer available.
`identity_verification_audit_completed` See example	Occurs when the verification has been audited and its `status` has likely been updated.
`identity_verification_capture_aborted` See example	Occurs when the user abandoned the flow without completing the capture.
`identity_verification_capture_completed` See example	Occurs when the user successfully completed the flow.
`identity_verification_capture_refused` See example	Occurs when the user explicitly refused to perform the flow.
`identity_verification_checks_completed` See example	Occurs when Checkout.com has completed the verification checks. The final verification status can be `approved` or `declined`.
`identity_verification_checks_inconclusive` See example	Occurs when the user did not provide the data required to perform the verification checks.
`identity_verification_closed` See example	Occurs when the user user forcibly closed the flow.
`identity_verification_created` See example	Occurs when you successfully created a new verification.
`identity_verification_link_expired` See example	Occurs when the verification URL expired without the user being redirected to the web flow. By default, expiry is after 15 minutes.
`identity_verification_opened` See example	Occurs when you created an attempt and the verification URL is available.
`identity_verification_report_created` See example	Occurs when the verification report is available for you to retrieve using the API.
`identity_verification_reset` See example	Occurs when you created a new attempt while the status of the previous attempt was `pending`.
`identity_verification_retry_requested` See example	Occurs when the user needs to retry the flow. Create a new attempt.
`identity_verification_started` See example	Occurs when the user has been successfully redirected to and started the web flow.

Event type	Description
`aml_verification_created` See example	Occurs when you successfully created an AML verification.
`aml_verification_monitoring_alert` See example	Occurs when a screening alert was raised and you need to investigate the case.
`aml_verification_monitoring_reviewed` See example	Occurs when one of the following: You finished investigating the case. A manual review was re-opened.
`aml_verification_onboarding_completed` See example	Occurs when the verification was completed successfully.
`aml_verification_onboarding_reviewed` See example	Occurs when the verification was manually reviewed.
`aml_verification_onboarding_started` See example	Occurs when Checkout.com started the screening checks.
`aml_verification_status_changed` See example	Occurs when the verification status was updated.

Event type	Description
`face_authentication_anonymized` See example	Occurs when the authentication is anonymized.
`face_authentication_audit_completed` See example	Occurs when the authentication is audited and its `status` has likely been updated. See Face Authentication statuses.
`face_authentication_capture_aborted` See example	Occurs when the user abandons the flow without completing the capture.
`face_authentication_capture_completed` See example	Occurs when the user successfully captures the face video.
`face_authentication_capture_refused` See example	Occurs when the user explicitly refuses to start the flow.
`face_authentication_checks_completed` See example	Occurs when Checkout.com finishes checking the face video. The final `status` can be `approved` or `declined`.
`face_authentication_checks_inconclusive` See example	Occurs when Checkout.com did not receive the required information to perform our checks.
`face_authentication_closed` See example	Occurs when the user user forcibly closes the flow.
`face_authentication_created` See example	Occurs when you successfully create an authentication.
`face_authentication_link_expired` See example	Occurs when the verification URL expired without the user being redirected to the web flow. By default, expiry is after 15 minutes.
`face_authentication_opened` See example	Occurs when you create an initial attempt and the verification URL is available.
`face_authentication_reset` See example	Occurs when you create a new attempt while the status of the previous attempt was `pending` or `capture_in_progress`.
`face_authentication_retry_requested` See example	Occurs when the user needs to retry the flow. Create a new attempt.
`face_authentication_started` See example	Occurs when the user is redirected to the verification URL and starts the flow.

Event type Description

Event type	Description
`3ds_card_enrolled` See example	Occurs when a card is successfully enrolled in 3D Secure (3DS).
`3ds_card_information_changed` See example	Occurs when a card's 3DS enrollment data is updated.
`authorization_advice_received` See example	Occurs when the card scheme declines a transaction on our behalf because Checkout.com is not reachable, or when a transaction is performed at a gas station or ATM. If the notification occurs due to an automated fuel dispenser (AFD) transaction, debit the cardholder's balance accordingly. If the notification occurs due to a decline, no further action is required.
`authorization_approved` See example	Occurs when you approve an authorization relay request for a transaction on an issued card.
`authorization_declined` See example	Occurs when you decline an authorization relay request for a transaction on an issued card.
`card_activated` See example	Occurs when an issued card is activated.
`card_created` See example	Occurs when you create a card.
`card_details_changed` See example	Occurs when you change the details of an issued card.
`card_revoked` See example	Occurs when you revoke a card.
`card_suspended` See example	Occurs when you suspend a card.
`chargeback_initiated` See example	Occurs when you receive a dispute notification from the card scheme.
`digital_card_activated` See example	Occurs when a digital card you've issued is activated.
`digital_card_deactivated` See example	Occurs when you deactivate a digital card.
`digital_card_deleted` See example	Occurs when you delete a digital card.
`digital_card_not_provisioned` See example	Occurs when an attempt to add a card to a digital wallet fails.
`digital_card_pending` See example	Occurs when an attempt to add a card to a digital wallet is awaiting verification from the cardholder.
`digital_card_provisioned` See example	Occurs when a card is successfully added to a digital wallet.
`issuer_reversal_processed` See example	Occurs when the issuer automatically releases funds held after an approved authorization when: An authorization was not entirely cleared within seven days of its approval. A pre-authorization was not entirely cleared within 30 days of its approval. A final presentment partially covers the corresponding approved authorizations. For Automated Fuel Dispensers (AFD), the cost of dispensed fuel is lower than the initial authorization amount.
`presentment_received` See example	Occurs when Checkout.com receives a presentment from the acquirer that matches an existing authorization, pre-authorization, or incremental authorization.
`presentment_reversed` See example	Occurs when Checkout.com is notified of an error in or duplication of a previous presentment. A presentment reversal is a technical cancellation where funds are moved from the merchant to the cardholder.
`reversal_approved` See example	Occurs when a reversal is approved. A reversal is a technical cancellation where an authorization hold is voided, without any movement of funds.
`reversal_declined` See example	Occurs when a reversal is declined because no match was found with a previous authorization approval. A reversal is a technical cancellation in which an authorization hold is voided, without any movement of funds.

3ds_card_enrolled

See example

Occurs when a card is successfully enrolled in 3D Secure (3DS).

3ds_card_information_changed

See example

Occurs when a card's 3DS enrollment data is updated.

authorization_advice_received

See example

Occurs when the card scheme declines a transaction on our behalf because Checkout.com is not reachable, or when a transaction is performed at a gas station or ATM.

If the notification occurs due to an automated fuel dispenser (AFD) transaction, debit the cardholder's balance accordingly. If the notification occurs due to a decline, no further action is required.

authorization_approved

See example

Occurs when you approve an authorization relay request for a transaction on an issued card.

authorization_declined

See example

Occurs when you decline an authorization relay request for a transaction on an issued card.

card_activated

See example

Occurs when an issued card is activated.

card_created

See example

Occurs when you create a card.

card_details_changed

See example

Occurs when you change the details of an issued card.

card_revoked

See example

Occurs when you revoke a card.

card_suspended

See example

Occurs when you suspend a card.

chargeback_initiated

See example

Occurs when you receive a dispute notification from the card scheme.

digital_card_activated

See example

Occurs when a digital card you've issued is activated.

digital_card_deactivated

See example

Occurs when you deactivate a digital card.

digital_card_deleted

See example

Occurs when you delete a digital card.

digital_card_not_provisioned

See example

Occurs when an attempt to add a card to a digital wallet fails.

digital_card_pending

See example

Occurs when an attempt to add a card to a digital wallet is awaiting verification from the cardholder.

digital_card_provisioned

See example

Occurs when a card is successfully added to a digital wallet.

issuer_reversal_processed

See example

Occurs when the issuer automatically releases funds held after an approved authorization when:

An authorization was not entirely cleared within seven days of its approval.
A pre-authorization was not entirely cleared within 30 days of its approval.
A final presentment partially covers the corresponding approved authorizations.
For Automated Fuel Dispensers (AFD), the cost of dispensed fuel is lower than the initial authorization amount.

presentment_received

See example

Occurs when Checkout.com receives a presentment from the acquirer that matches an existing authorization, pre-authorization, or incremental authorization.

presentment_reversed

See example

Occurs when Checkout.com is notified of an error in or duplication of a previous presentment.

A presentment reversal is a technical cancellation where funds are moved from the merchant to the cardholder.

reversal_approved

See example

Occurs when a reversal is approved.

A reversal is a technical cancellation where an authorization hold is voided, without any movement of funds.

reversal_declined

See example

Occurs when a reversal is declined because no match was found with a previous authorization approval.

A reversal is a technical cancellation in which an authorization hold is voided, without any movement of funds.

Event type	Display name	Description
`full_dd_failed` See example	Full DD failed	Occurs when a sub-entity fails its due diligence checks.
`full_dd_passed` See example	Full DD passed	Occurs when a sub-entity passes its due diligence checks.
`match_failed` See example	Match failed	Occurs when a sub-entity fails its MATCH check.
`match_passed` See example	Match passed	Occurs when a sub-entity passes its MATCH check.
`payment_instrument_created` See example	Payment instrument created	Occurs when a payment instrument is created associated with a sub-entity.
`payment_instrument_error` See example	Payment instrument error	Occurs when a payment instrument has failed to be created.
`payment_instrument_verification_failed` See example	Payment instrument verification failed	Occurs when a payment instrument fails verification.
`payment_instrument_verification_passed` See example	Payment instrument verification passed	Occurs when a payment instrument passes verification.
`payments_disabled` See example	Payments disabled	Occurs when payment capabilities are disabled for a sub-entity.
`payments_enabled` See example	Payments enabled	Occurs when payment capabilities are enabled for a sub-entity.
`payout_declined` See example	Payout declined	Occurs when a scheduled sub-entity payout fails.
`payout_paid` See example	Payout paid	Occurs when a scheduled sub-entity payout is made.
`payouts_disabled` See example	Payouts disabled	Occurs when payout capabilities are disabled for a sub-entity.
`payouts_enabled` See example	Payouts enabled	Occurs when payout capabilities are enabled for a sub-entity.
`status_changed` See example	Status changed	Occurs when the status of a sub-entity changes.
`sub_entity_created` See example	Sub entity created	Occurs when a sub-entity is successfully created.
`transfer_status_changed` See example	Transfer status changed	Occurs when the status of a transfer you requested changes.
`vmss_failed` See example	VMSS failed	Occurs when a sub-entity fails due diligence VMSS checks.
`vmss_passed` See example	VMSS passed	Occurs when a sub-entity passes due diligence VMSS checks.

Event type Display name Description

Event type	Display name	Description
`report_generated` See example	Report generated	Occurs when a scheduled report is generated and available to retrieve.

report_generated

See example

Report generated

Occurs when a scheduled report is generated and available to retrieve.

Event type	Display name	Description
`settlement_generated` See example	New settlement generated	Occurs when a settlement is created and ready for processing.
`settlement_instructed` See example	Settlement instructed	Occurs when a settlement is approved and sent for processing. The funds are being prepared for transfer.
`settlement_rejected` See example	Settlement rejected	Occurs when a settlement is canceled before processing. The funds are returned to the available balance.
`settlement_returned` See example	Settlement returned	Occurs when the beneficiary bank sends back a previously instructed settlement. This may be due to incorrect account details or other banking issues.

Webhook event types

Account Updater

Authentication

Balances

Disputes

FinCrime

Fraud

Gateway

Identity Verification

AML Verification

Face Authentication

Issuing

Platforms

Reports

Settlements