Event Code 103 - Card Status Change


šŸ“˜

Note

Event Code 103 (Card Status Change) sends notifications asynchronously only, as messages are processed in batches. Clients will not receive notifications in a specific order. If a client requires ordered processing, you must use the notification timestamp provided in the payload to ensure proper sequencing.

The 103 event code is used to send out a message when a card status is changed.

{
  "productId": 12345,
  "events": [103],
  "webhookStatus": "active",  
  "config": {
    "url": "https://client_domain.com/webhook",
    "customHeaders": {
      "header1": "value_1",
      "header2": "value_2"
    }
  }
}

After the webhook has been successfully set up, when a card status is changed, a notification response is sent asynchronously from the Event Delivery Service to the URL specified in the webhook. See the below example of a response.

{
"context": {
"notificationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"eventCode": 103,
"eventVersion": "v1",
"notificationTime": "2024-01-24T23:20:28Z"
},
"payload": {
"tokenId": "123456789",
"productId": 123,
"dateTime": "2024-01-24T14:30:00Z",
"newCardStatus": "41",
"oldCardStatus": "00",
"message": "Card status changed from active to lost or stolen.",
"trackingId": "60b83k64-526e-4d25-84c7-32b6e47c02b3"
}
}

The below table describes each of the fields included in the notification response.

FieldDescription
contextObject that contains the context of the notification, such as the event code.
notificationIdUnique identifier of the notification.
eventCodeThe event code. In this case, the event code is 103.
eventVersionThe event version.
notificationTimeWhen the notification was created. Time in the UTC format of 'yyyy-MM-ddTHH:mm:ssZ'.
payloadObject that contains the payload of the notification, which is specific to the event code.
tokenIdThe public token of the cardholder.
productIdThe product identifier.
dateTimeThe date and time the status for the card changed. In the UTC format of 'yyyy-MM-ddTHH:mm:ssZ'.
newCardStatusThe current status of the card.
oldCardStatusThe previous status of the card.
messageThe card status change reason message created by Thredd based on the new card status and old card status.
trackingIdThe Unique identifier generated by Thredd for tracking.