Account Updater Events
When you enroll cards using the CMP's Create Card API, enrollment in account updater depends on the configured workflow. If the account update workflow is enabled, you'll automatically receive notifications for the card's lifecycle events. Each notification includes the card ID, enabling you to easily retrieve the most up-to-date card information with a simple GET request. If the workflow is not configured for account updater, you will need to explicitly enroll the card by making a request to the /card-updates endpoint. This ensures flexibility for customers to manage enrollment based on their specific needs.
Once a card is enrolled in Account Updater:
- Receive notifications for events like i. Card updates i. Expirations i. Account closures i. And others
- Signature - Read more about webhook signature to configure authentication properly
- Extract the cardID from each notification
- Use the cardID to make a GET request to retrieve the updated card data i. Get Card - Get information on registered cards
Account Updater Events
After a card has been enrolled for account updates, there are a few events which may occur to update the status of the card. You may receive these status updates via our Webhook integration. Here is a brief explanation of what each update means:
| Notification Type | Event Description |
|---|---|
| cmp_au_card.updated | Account number change message: This event is triggered when a cardholder opens a new account with a participating issuer or when a new card is issued. For e.g. this could be due to new account creation, lost or stolen card, or when a card holder gets upgraded to Platinum or downgraded, or, due to a portfolio change (one bank to another). |
| cmp_au_card.expired | Expiration date change This event denotes an expiration date change event. Whenever the card expires but has the same PAN, then, a new expiration date is issued. This event is an indication that the card expired (and so a new date is issued). Typically, cards have an expiration date of 2, 3 or x years (it used to be 5 but we rarely see them these days). Sometimes, an issuer can have an expiration for 1 year (for brand new card holders as they do not have enough credit). |
| cmp_au_card.closed | Closed account advice This event is triggered when the issuer reports the closure of the cardholder's account i.e. cardholder's account associated with the particular card is no longer active/closed providing an important update for merchants to keep their records accurate and avoid attempting transactions with invalid or closed accounts. |
| cmp_au_card.non_participating | Non-participating BIN This event represents a non-participating BIN event, indicating that cards linked to these BINs will not receive updates through the account updater service. i.e. BIN of a particular card is not participating in the account updater service and merchants subscribed to account updater will not receive updates for cards associated with non-participating BINs. |
| cmp_au_card.contact_cardholder_advice | Contact cardholder advice This event indicates the issuer is letting the merchant know that something has changed and the merchant should force the customer to key enter the credential and the update will not be shared via the account updater channel for the merchant. In short the merchant must contact the cardholder for more information or clarification. |
| cmp_au_card.unknown | Account not found response from a participating BIN This event indicates that the card is eligible for automatic updates, but no match was found for this account. |
| cmp_au_card.enrolled | This event is triggered when a card is successfully enrolled in account updater or when the network confirms that the card status remains unchanged. Successfully enrolled - The card is successfully enrolled for updates from the networks. Match made, account number and expiration date unchanged - This event implies that the card is already enrolled for account updater services, confirming the card's account number and expiration date haven't changed (matched) since the last card update. |
| cmp_au_card.opt_out | Cardholder Opt-Out Note (Stop Advice) is placed on a card |
| cmp_au_card.enrollment.failed | The card could not be enrolled for account updates with the networks |
This event is triggered when the cardholder chooses to opt-out of the account updater service i.e. when the cardholder does not want their account information automatically updated through the account updater service. Opting out is typically a deliberate choice made by the cardholder.
Enrollment Failure Reason Codes:
| Reason Code | Reason Text |
|---|---|
| card-brand-not-supported | XXX card brand is not supported. Currently, only Visa and Mastercard cards are supported. This error will be returned if an Amex, Discover, or any other card scheme is used. |
| declined | VGS merchant not found This error typically indicates that the customer has not been onboarded to use the account updater with the provided vault credentials. |
| internal-server-error | Something went wrong. |
Note: The 'card_first8' field will be returned in the card notifications only for Visa and Mastercard cards.
Return a 200 status to indicate that the data was received successfully.
Payload
{
"description": "Card updated",
"details": {
"card_id": "CRDecqZp3xRgXU3TFmtcDdzQs",
"card_last4": "5698",
"card_first8": "12345678",
"card_bin": "123456",
"card_fingerprint": "gpwktMGS8NtJervwhyZCEmTMfrrQMXX6vaoyrQmRsT6s",
"fingerprint_matches": "[\"CRDnUwLQMbtEwgyYRPT5wfY5k\",\"CRDiXN4YJy97BKTmpQgimqiTr\"]",
"new_account_number": "************5698",
"new_expiration_date": "0227",
"occurred_at": "2024-01-17T00:00Z",
"old_account_number": "************7343",
"old_expiration_date": "0424",
"reason_code": "A",
"reason_text": "The card number was updated."
},
"event": "cmp_au_card.updated",
"fingerprint": "0734f9289326955d9b323c26b281fd8112f78ef56acd09a3dc2b8c7a9a13c948",
"grouping": "every_single",
"id": "bba88542-cfb1-42f8-8f63-aba60d62917c",
"integration_id": "IN6VgSvLVRV2j2iuxugi4mh7",
"occurrence": 1,
"org_id": "AC21kskfJCLyrkVjmAT6gU9X",
"producer": {
"application_name": "calm-api",
"application_protocol": "http"
},
"scope": "vault",
"summary": "Card \"CRDecqZp3xRgXU3TFmtcDdzQs\" has been updated within vault tntvlyn1nof\n",
"tenant": "ACT9eeBkBsxXe9wWJkQdpG2kC",
"timestamp": "2024-01-18T23:49:31.809Z"
}