DocumentationAPI Reference

Card Account events

Suggest Edits

For merchants taking advantage of network tokens, this webhook will fire when:

  • a change has occurred to a card-on-file. For example, when a card's expiry date has been updated, merchants will receive an update event with the new expiry date;
  • the scheme token status is updated.

The network token status will be one of the following values:

StatusDescription
pendingThis card has been enrolled for network tokenisation but has not yet had its token activated.

Any transactions attempted with a card in this state will fall back to the original PAN.
activeThis card has an active network token. When transacting with a card in this state, a digital PAN and corresponding cryptographic signature will be fetched and used for the transaction.

If there are errors when fetching the payment instrument (for instance due to service interruptions), the transaction will fall back to the original PAN.
suspendedThis card has a network token, however the token has been suspended by either the network or issuing bank. A card that is suspended may return to the active state, or it may be deleted.

Any transactions attempted with a card in this state will fall back to the original PAN.
deletedThis card has had its network token deleted, possibly due to account closure or some other reason. Merchants should attempt to contact the card holder for an updated payment method.

Any transactions attempted with a card in this state will fall back to the original PAN.
{  
  "event": "card_account:update",
  "payload": {
    "token": "abcd1234abcd",
    "card_number": "555555XXXXXX1243",
    "card_expiry": "2021-09-30",
    "card_type": "MasterCard",
    "card_category": "Credit",
    "card_updater_status": "active"
  }
}

Updated 10 months ago