The table below lists the Webhook events available for tokens.
Event | Description |
---|---|
token.initiated | Triggered when tokenisation request is initiated. |
token.activated | Triggered when: • The token status is changed to active for the first time. • The token status for a previously suspended token is changed to active again. |
token.suspended | Triggered when the issuing bank temporarily suspends a token. |
token.deactivated | Triggered when a token is permanently deactivated. |
token.expiry_updated | Triggered when the issuing bank updates the expiry date for a token. |
Handy Tips
In case of network tokenised cards, the last 4 digits will be of the tokenised card and not the actual card.
{"entity": "event","account_id": "acc_BFQ7uQEaa7j2z7","event": "token.initiated","contains": ["token"],"payload": {"token": {"entity": {"id": "token_4lsdksD31GaZ09","entity": "token","customer_id": "cust_1Aa00000000001","method": "card","card": {"last4": "3335","network": "Visa","type": "debit","issuer": "HDFC","international": false,"emi": true,"sub_type": "consumer","token_iin": "453335"},"compliant_with_tokenisation_guidelines": true,"expired_at": 1748716199,"status": "initiated","notes": []}}}}
{"entity": "event","account_id": "acc_BFQ7uQEaa7j2z7","event": "token.activated","contains": ["token"],"payload": {"token": {"entity": {"id": "token_4lsdksD31GaZ09","entity": "token","customer_id": "cust_1Aa00000000001","method": "card","card": {"last4": "3335","network": "Visa","type": "debit","issuer": "HDFC","international": false,"emi": true,"sub_type": "consumer","token_iin": "453335"},"compliant_with_tokenisation_guidelines": true,"expired_at": 1748716199,"status": "active","notes": []}}}}
{"entity": "event","account_id": "acc_BFQ7uQEaa7j2z7","event": "token.activated","contains": ["token"],"payload": {"token": {"entity": {"id": "token_4lsdksD31GaZ09","entity": "token","customer_id": "cust_1Aa00000000001","method": "card","card": {"last4": "3335","network": "Visa","type": "debit","issuer": "HDFC","international": false,"emi": true,"sub_type": "consumer","token_iin": "453335"},"compliant_with_tokenisation_guidelines": true,"expired_at": 1748716199,"status": "active","notes": []}},"payment": {"entity": {"id": "pay_FPoJKWQQ8lK13n","entity": "payment","amount": 500000,"currency": "INR","base_amount": 500000,"status": "captured","order_id": "order_FPoIeimWki9j8A","invoice_id": null,"international": false,"method": "netbanking","amount_refunded": 190000,"amount_transferred": 0,"refund_status": "partial","captured": true,"description": null,"card_id": null,"bank": "HDFC","wallet": null,"vpa": null,"email": "gaurav.kumar@example.com","contact": "+919000090000","notes": [],"fee": 11800,"tax": 1800,"error_code": null,"error_description": null,"error_source": null,"error_step": null,"error_reason": null,"acquirer_data": {"bank_transaction_id": "4827433"},"created_at": 1597226379}}}}
{"entity": "event","account_id": "acc_BFQ7uQEaa7j2z7","event": "token.suspended","contains": ["token"],"payload": {"token": {"entity": {"id": "token_4lsdksD31GaZ09","entity": "token","customer_id": "cust_1Aa00000000001","method": "card","card": {"last4": "3335","network": "Visa","type": "debit","issuer": "HDFC","international": false,"emi": true,"sub_type": "consumer","token_iin": "453335"},"compliant_with_tokenisation_guidelines": true,"expired_at": 1748716199,"status": "suspended","notes": []}}}}
{"entity": "event","account_id": "acc_BFQ7uQEaa7j2z7","event": "token.deactivated","contains": ["token"],"payload": {"token": {"entity": {"id": "token_4lsdksD31GaZ09","entity": "token","customer_id": "cust_1Aa00000000001","method": "card","card": {"last4": "3335","network": "Visa","type": "debit","issuer": "HDFC","international": false,"emi": true,"sub_type": "consumer","token_iin": "453335"},"compliant_with_tokenisation_guidelines": true,"expired_at": 1748716199,"status": "deactivated","notes": []}}}}