• Register

Token Notification

This webhook will be used to send Token notification to FI through NI.

Request Parameters:

Field Name Type Max  Remarks Description
id String 36 Mandatory  
type String 5 Mandatory AC: Activation
TC: Completion
TD: Token Events
TE: Token Resume
timestamp String 30 Mandatory  
details card id value String 30 Optional  
type String 10 Optional externalCardId
maskedCardNumber String 19 Optional  
clientId String 20 Optional CLIENT_NUMBER
mobilePhone String 32 Optional  
email String 255 Optional  
language String 10 Optional  Example: ENG
cbsNumber String 3 Optional  
textMessage String 300 Optional  
token activationPref String 10 Optional  
requestorId String 10 Optional Refer Appendix
requestorName String 30 Optional

Refer Appendix

activationCode String 30 Optional  
deviceType String 10 Optional  
tokenEventReasonCode String 20 Optional  
tokenEventIndicator String 30 Optional 3: Deactivate
4: Delete
6: Suspend
7: Resume

 

 

Sample Request for TC

{
   "id":"b876d568-8411-4638-bdef-a1a188a4773b",
   "type":"TC",
   "timestamp":"2022-11-09T11:00:03Z",
   "details":{
      "card":{
         "id":{
            "type":"externalCardId",
            "value":"52913582186153682368"
         },
         "maskedCardNumber":"529135XXXXXX4488",
         "clintId":"1234567",
         "mobilePhone":"0554873333",
         "email":"abcd@gmail.com",
         "language":"ENG",
         "cbsNumber":"1234567"
      },
      "textMessage":"",
      "token":{
         "requestorId":"50110030273",
         "requestorName":"APPLE PAY",
         "deviceType":"16"
      }
   }
}

Sample Request for AC

{
   "id":"b876d568-8411-4638-bdef-a1a188a4773b",
   "type":"AC",
   "timestamp":"2022-11-09T11:00:03Z",
   "details":{
      "card":{
         "id":{
            "type":"externalCardId",
            "value":"52913582186153682368"
         },
         "maskedCardNumber":"529135XXXXXX4488",
         "clintId":"1234567",
         "mobilePhone":"0554873333",
         "email":"abcd@gmail.com",
         "language":"ENG",
         "cbsNumber":"1234567"
      },
      "textMessage":"",
      "token":{
         "activationPref":"",
         "requestorId":"50110030273",
         "requestorName":"APPLE PAY",
         "activationCode":"1234"
      }
   }
}

Sample Request for TD

{
   "id":"b876d568-8411-4638-bdef-a1a188a4773b",
   "type":"TD",
   "timestamp":"2022-11-09T11:00:03Z",
   "details":{
      "card":{
         "id":{
            "type":"externalCardId",
            "value":"52913582186153682368"
         },
         "maskedCardNumber":"529135XXXXXX4488",
         "clintId":"1234567",
         "mobilePhone":"0554873333",
         "email":"abcd@gmail.com",
         "language":"ENG",
         "cbsNumber":"1234567"
      },
      "textMessage":"",
      "token":{
         "deviceType":"16",
         "tokenEventReasonCode":"",
         "requestorId":"50110030273",
         "requestorName":"APPLE PAY",
         "tokenEventIndicator":"3"
      }
   }
}

Sample Request for TE

{
   "id":"b876d568-8411-4638-bdef-a1a188a4773b",
   "type":"TE",
   "timestamp":"2022-11-09T11:00:03Z",
   "details":{
      "card":{
         "id":{
            "type":"externalCardId",
            "value":"52913582186153682368"
         },
         "maskedCardNumber":"529135XXXXXX4488",
         "clintId":"1234567",
         "mobilePhone":"0554873333",
         "email":"abcd@gmail.com",
         "language":"ENG",
         "cbsNumber":"1234567"
      },
      "textMessage":"",
      "token":{
         "deviceType":"16",
         "tokenEventReasonCode":"",
         "requestorId":"50110030273",
         "requestorName":"APPLE PAY",
         "tokenEventIndicator":"7"
      }
   }
}

Response Parameters:

Filed Name Type Max Remarks
id String 12 Mandatory
type String 10 Mandatory
timestamp String 30 Mandatory
response status code String 5 Mandatory
description String 30 Mandatory

 

Response Json

{
    "id": "688385602509",
    "type": "TC",
    "timestamp": "2022-11-09T11:00:04.638756",
    "response": {
        "status": {
            "code": "00",
            "description": "successful"
        }
    }
}

Docs Navigation