On This Page
FILTER BY TAG

Network Token Life-Cycle Management Notification Examples

These examples show the different notifications for life-cycle management events.

REST Examples: Life-Cycle Management Notifications

Network Token Provisioned
{
   "eventType":"tms.networktoken.provisioned",
   "webhookId":"3xxxxffb-xxxx-fae4-e063-a058xxxx266f",
   "productId":"tokenManagement",
   "organizationId":"OrganizationId",
   "eventDate":"2025-07-03T09:58:09",
   "transactionTraceId":"f25xxxx-38eb-4a2c-a065-732fxxxx6a7f-0",
   "retryNumber":0,
   "payload":{
      "data":{
         "reason":"PROVISIONED",
         "id":"3904693A51027574XXXXAF598E0AA195",
         "type":"tokenizedCardEnrollments",
         "version":"1.0",
         "_links":{
            "tokenized-cards":[
               {
                  "href":"/tms/v2/tokenized-cards/38F377C4044F251XXXX3AF598E0A8B67",
                  "id":"38F377C4044F251AE06XXXX98E0A8B67",
                  "state":"ACTIVE"
               }
            ],
            "instrumentIdentifiers":[
               {
                  "href":"/tms/v1/instrumentidentifiers/7030010xxxx56432345",
                  "id":"7030010xxxx56432345"
               }
            ]
         }
      },
      "organizationId":"OrganizationId"
   },
   "requestType":"NEW"
}
Network Token Status Updated
{
 "eventType": "tms.networktoken.updated",
 "webhookId": "261d2616-xxxx-9ba8-q3456-8b588d0a5f2a",
 "productId": "tokenManagement",
 "organizationId": "mid",
 "eventDate": "2025-02-24T16:46:27",
 "transactionTraceId": "234234234234234c14e374c2b5a31e26c4316f0dc-0",
 "retryNumber": 0,
 "payload": {
   "data": {
     "reason": "TOKEN_STATUS_UPDATED",
     "id": "2EE7067B2F015632E0631E588E0A1987",
     "type": "tokenizedCardUpdates",
     "version": "1.0",
     "_links": {
       "tokenized-cards": [
         {
           "href": "/tms/v2/tokenized-cards/2E8B371F931C4B9BE0631D588D0AF123",
           "id": "2E8B371F931C4B9BE0631D588D0AF123",
           "state": "DELETED"
         }
       ],
       "instrumentIdentifiers": [
         {
           "href": "/tms/v1/instrumentidentifiers/7045450003485829870",
           "id": "7045450003485829870"
         }
       ]
     }
   },
   "organizationId": "mid"
 },
 "requestType": "NEW"
}
Network Token Suspended
{
   "eventType":"tms.networktoken.updated",
   "webhookId":"3903effb-xxxx-fae4-e063-a0xxxx0a266f",
   "productId":"tokenManagement",
   "organizationId":"OrganizationId",
   "eventDate":"2025-07-03T10:29:12",
   "transactionTraceId":"01bcdb1655702343e1b4e48ad2089873daafff2e4ff12da4abb1e9ecc522d769-0",
   "retryNumber":0,
   "payload":{
      "data":{
         "reason":"TOKEN_STATUS_UPDATED",
         "id":"3904B9E29F574360xxxxAF598E0AB766",
         "type":"tokenizedCardUpdates",
         "version":"1.0",
         "_links":{
            "tokenized-cards":[
               {
                  "href":"/tms/v2/tokenized-cards/38F377C4044F25XXXX63AF598E0A8B67",
                  "id":"38F377C4044F25XXXX63AF598E0A8B67",
                  "state":"SUSPENDED"
               }
            ],
            "instrumentIdentifiers":[
               {
                  "href":"/tms/v1/instrumentidentifiers/7030010XXXX56432345",
                  "id":"703001XXXX056432345"
               }
            ]
         }
      },
      "organizationId":"OrganizationId"
   },
   "requestType":"NEW"
}
Network Token Deleted
{
   "eventType":"tms.networktoken.updated",
   "webhookId":"3903effb-xxxx-fae4-e063-a058xxxx266f",
   "productId":"tokenManagement",
   "organizationId":"OrganizationId",
   "eventDate":"2025-07-03T10:30:12",
   "transactionTraceId":"9fa8d1a66d588b2c3e98ccxxxxe25128901ce6305ac4cfd756f0089836f618f2-0",
   "retryNumber":0,
   "payload":{
      "data":{
         "reason":"TOKEN_STATUS_UPDATED",
         "id":"3904CA019A3A55F9E063AFXXXX0A8356",
         "type":"tokenizedCardUpdates",
         "version":"1.0",
         "_links":{
            "tokenized-cards":[
               {
                  "href":"/tms/v2/tokenized-cards/38F377C4044F251AXXXXAF598E0A8B67",
                  "id":"38F377C4044F251AE063XXXX8E0A8B67",
                  "state":"DELETED"
               }
            ],
            "instrumentIdentifiers":[
               {
                  "href":"/tms/v1/instrumentidentifiers/703001XXXX056432345",
                  "id":"70300XXXX0056432345"
               }
            ]
         }
      },
      "organizationId":"OrganizationId"
   },
   "requestType":"NEW"
}
Network Token Activated
{
   "eventType":"tms.networktoken.updated",
   "webhookId":"3903effb-xxxx-fae4-e063-a0xxxx0a266f",
   "productId":"tokenManagement",
   "organizationId":"OrganizationId",
   "eventDate":"2025-07-03T10:32:15",
   "transactionTraceId":"3b4afde1bf4d69477a7e7109cc8e65882412820770a2044ad4c9fed75d31f4e8-0",
   "retryNumber":0,
   "payload":{
      "data":{
         "reason":"TOKEN_STATUS_UPDATED",
         "id":"3904DXXXXC6D597AE06XXXX98E0A6B8C",
         "type":"tokenizedCardUpdates",
         "version":"1.0",
         "_links":{
            "tokenized-cards":[
               {
                  "href":"/tms/v2/tokenized-cards/3904CA019F0355XXXX63AF598E0A8356",
                  "id":"3904CA019F035XXXX063AF598E0A8356",
                  "state":"ACTIVE"
               }
            ],
            "instrumentIdentifiers":[
               {
                  "href":"/tms/v1/instrumentidentifiers/703008XXXX051962341",
                  "id":"703XXXX000051962341"
               }
            ]
         }
      },
      "organizationId":"OrganizationId"
   },
   "requestType":"NEW"
}
Network Token Card Updated
{
  "eventType": "tms.networktoken.updated",
  "webhookId": "27bc79a2-xxxx-8532-xxxx-a0588e0ade3b",
  "productId": "tokenManagement",
  "organizationId": "OrganizationId",
  "eventDate": "2025-02-28T20:40:39",
  "transactionTraceId": "e9d7949bf85521625053f23270af389660fafa4328ddd63518e5deb8577c7564-0",
  "retryNumber": 0,
  "payload": {
    "data": {
      "reason": "CARD_UPDATED",
      "id": "2F3AC2D2450BB025E06XXXX98E0AF0CA",
      "type": "tokenizedCardUpdates",
      "version": "1.0",
      "_links": {
        "tokenized-cards": [
          {
            "href": "/tms/v2/tokenized-cards/2F1F09A14C7E3B7AXXXXAF598E0A5151",
            "id": "2F1F09A14C7E3XXXX063AF598E0A5151"
          }
        ],
        "instrumentIdentifiers": [
          {
            "href": "/tms/v1/instrumentidentifiers/70304500XXXX3860034",
            "id": "70304XXXX0093860034"
          }
        ]
      }
    },
    "organizationId": "OrganizationId"
  },
  "requestType": "NEW"
}
Network Token Updated
{
   "eventType":"tms.networktoken.updated",
   "webhookId":"3903effb-f536-fae4-e063-a0588e0a266f",
   "productId":"tokenManagement",
   "organizationId":"OrganizationId",
   "eventDate":"2025-07-03T10:30:12",
   "transactionTraceId":"9fa8d1a66d588b2c3e98cc108de25128901ce6305ac4cfd756f0089836f618f2-0",
   "retryNumber":0,
   "payload":{
      "data":{
         "reason":"TOKEN_UPDATED",
         "id":"3904CA019A3A55F9E063AF598E0A8356",
         "type":"tokenizedCardUpdates",
         "version":"1.0",
         "_links":{
            "tokenized-cards":[
               {
                  "href":"/tms/v2/tokenized-cards/38F377C4044F251AE063AF598E0A8B67",
                  "id":"38F377C4044F251AE063AF598E0A8B67",
                  "state":"ACTIVE"
               }
            ],
            "instrumentIdentifiers":[
               {
                  "href":"/tms/v1/instrumentidentifiers/7030010000056432345",
                  "id":"7030010000056432345"
               }
            ]
         }
      },
      "organizationId":"OrganizationID"
   },
   "requestType":"NEW"
}
Network Token Expiration Updated
{
  "eventType": "tms.networktoken.updated",
  "webhookId": "3903effb-f536-fae4-e063-a0588e0a266f",
  "productId": "tokenManagement",
  "organizationId": "organizationId",
  "eventDate": "2026-02-23T14:40:45",
  "transactionTraceId": "ddd36b68-b0cd-4bea-a1c9-d9d5f39ede88-0",
  "retryNumber": 0,
  "payload": {
    "data": {
      "version": "1.0",
      "id": "4B7FB81DA338515FE063AF598E0AD417",
      "reason": "TOKEN_EXPIRY_UPDATED",
      "type": "tokenizedCardUpdates",
      "_links": {
        "instrumentIdentifiers": [
          {
            "href": "/tms/v1/instrumentidentifiers/7030050000048066475",
            "id": "7030050000048066475"
          }
        ],
        "tokenized-cards": [
          {
            "href": "/tms/v2/tokenized-cards/4B7FB756657A1B9FE063AF598E0AE530",
            "id": "4B7FB756657A1B9FE063AF598E0AE530"
          }
        ]
      }
    },
    "organizationId": "organizationId"
  },
  "requestType": "NEW"
}
Network Token Metadata Updated
{
  "eventType": "tms.networktoken.updated",
  "webhookId": "3903effb-f536-fae4-e063-a0588e0a266f",
  "productId": "tokenManagement",
  "organizationId": "OrganizationID",
  "eventDate": "2026-02-23T14:40:45",
  "transactionTraceId": "ddd36b68-b0cd-4bea-a1c9-d9d5f39ede88-0",
  "retryNumber": 0,
  "payload": {
    "data": {
      "version": "1.0",
      "id": "4B7FB81DA338515FE063AF598E0AD417",
      "reason": "TOKEN_EXPIRY_UPDATED",
      "type": "tokenizedCardUpdates",
      "_links": {
        "instrumentIdentifiers": [
          {
            "href": "/tms/v1/instrumentidentifiers/7030050000048066475",
            "id": "7030050000048066475"
          }
        ],
        "tokenized-cards": [
          {
            "href": "/tms/v2/tokenized-cards/4B7FB756657A1B9FE063AF598E0AE530",
            "id": "4B7FB756657A1B9FE063AF598E0AE530"
          }
        ]
      }
    },
    "organizationId": "OrganizationId"
  },
  "requestType": "NEW"
}
Redigitization
{
  "eventType": "tms.networktoken.updated",
  "webhookId": "3903effb-f536-fae4-e063-a0588e0a266f",
  "productId": "tokenManagement",
  "organizationId": "OrganizationId",
  "eventDate": "2026-02-26T12:41:05",
  "transactionTraceId": "ed950d64-3e32-467e-9983-329e51f5adc5-0",
  "retryNumber": 0,
  "payload": {
    "data": {
      "version": "1.0",
      "id": "4BBA5FF1292594B4E063AF598E0AAA66",
      "reason": "REDIGITILIZATION",
      "type": "tokenizedCardUpdates",
      "_links": {
        "instrumentIdentifiers": [
          {
            "href": "/tms/v1/instrumentidentifiers/7032130000022946478",
            "id": "7032130000022946478"
          }
        ],
        "tokenized-cards": [
          {
            "href": "/tms/v2/tokenized-cards/4BBA5FF1272C94B4E063AF598E0AAA66",
            "id": "4BBA5FF1272C94B4E063AF598E0AAA66"
          }
        ]
      }
    },
    "organizationId": "OrganizationId"
  },
  "requestType": "NEW"
}
RELATED TO THIS PAGE