Account Updater Events

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:

  1. Receive notifications for events like i. Card updates i. Expirations i. Account closures i. And others
  2. Signature - Read more about webhook signature to configure authentication properly
  3. Extract the cardID from each notification
  4. 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. You can find a brief explanation of each status update here.

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.

Payload
descriptionstringRequired
eventstringRequired
fingerprintstringRequired
groupingstringRequired
idstringRequired
integration_idstringRequired
occurrenceintegerRequired
org_idstringRequired
scopestringRequired
summarystringRequired
tenantstringRequired
timestampstringRequired
Responses
200

Return a 200 status to indicate that the data was received successfully.

No content

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"
}

Last updated