Token disabled event

This webhook event is triggered when a payment token has been deactivated or disabled in the system, indicating that the token can no longer be used for future transactions. The event provides the disabled token identifier and associated shopper reference for proper token lifecycle management.

It is sent when you call Disable Token and when the token is disabled on the payment processor's side. After this event, any payment with the token is rejected with error 2004 — do not retry it. To keep charging the shopper, obtain a new token by sending them through a checkout with recurringProcessingModel set. See Token scope and validity.

Webhook Example

{
    "checkoutReference": null,
    "payfacReference": "164EF8478A748",
    "merchantReference": "41603093314785",
    "amount": "",
    "currency": "",
    "reason": "TokenDisabled",
    "success": "true",
    "hmacSignature": "/U16ImnZ81deJgFUwWUqEOsIZJ+4AEl1KKDbawJt/g4=",
    "additionalData": {
        "eventType": "TokenDisabled",
        "token": "164EF8478A748",
        "shopperReference": "xoj0qfx9S7G7fj7byhVu6Tot6G9vjvvP"
    }
}

info

HMAC key: 297d288c4ef7e65d317dbb14dcbe16d054976f25328bc387

Headers

In the Authorization header, we will set the matching Api key for your webhook.

Fields

You will always get these fields.

Field	Type	Description
checkoutReference	nullable string	Always null for this event.
payfacReference	string	The identifier of the payment token that has been disabled.
merchantReference	nullable string	Your reference from the payment that created the token.
amount	string	Always an empty string for this event.
currency	string	Always an empty string for this event.
reason	nullable string	A field that provides additional context.
success	string	Indicates the action status (true/false).
hmacSignature	string	A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.
additionalData	object	An object for the additional details included in the event.

Additional Data Fields

Fields you will get depend on the event type of the webhook.

Field	Type	Description
eventType	string	A string representing the type of event that occurred.
token	string	The identifier of the payment token that has been disabled.
shopperReference	string	The shopper reference identifier associated with the disabled token.