Event Code 109 - Tokenisation Event Notification (TEN)

Use Webhook event 109 to receive Tokenisation Event Notifications (TENs) for changes to payment token status and lifecycle events.

The 109 event code is used to send out a Tokenisation Event Notification (TEN).

{ 
  "productId": 12345,
  "events": [109],
  "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 TEN has been made, 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": 109,
    "eventVersion": "v1",
    "notificationTime": "2024-01-24T23:20:28Z"
  },
  "payload": {
    "publicToken": "123456789",
    "productId": "124",
    "paymentToken": "987654321",
    "dpan": "5168563000002547",
    "networkTokenReference": "67024958022",
    "provisioningTraceId": "VIS1-20210318-381077544887139",
    "tokenisationServiceDateTime": "2024-10-29T15:16:30Z",
    "processorDateTime": "2024-10-29T15:16:50Z",
    "eventReason": "8",
    "messageReasonCode": "02",
    "eventRequestor": " ",
    "processorTokenStatus": "ACTIVE",
    "tokenisationServiceTokenStatus": "ACTIVE"
  }
}

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

Field	Description
context	Object that contains the context of the notification, such as the event code.
notificationId	Unique identifier of the notification.
eventCode	The event code. In this case, the event code is 104.
eventVersion	The event version.
notificationTime	When the notification was created. Time in the UTC format of 'yyyy-MM-ddTHH:mm:ssZ'.
payload	Object that contains the payload of the notification, which is specific to the event code.
publicToken	The public token associated with the TAR notification.
productId	The unique identifier of the product.
paymentToken	Thredd's internal identifier for the payment token.
dpan	The DPAN identifier for the payment token.
networkTokenReference	The unique token reference from the network.
provisioningTraceId	The lifecycle identifier to link tokenisation events that are related.
tokenisationServiceDateTime	The event generation timestamp from the tokenisation service.
processorDateTime	The event processing timestamp from Thredd.
eventReason	The tokenisation event reason to indicate the reason why the event was triggered.
messageReasonCode	The reason code associated with a given event reason where applicable.
eventRequestor	Indicates the entity that requested the event.
processorTokenStatus	The issuer processor (Thredd) token internal status.
tokenisationServiceTokenStatus	The Tokenisation Service token status (For example, VDEP or MDES).