search

Token Notify Webhook

Use Case

This webhook is used by Token Gateway to notify successful/unsuccessful completion of token provisioning and/or Token Status. In the future this will include lifecycle updates triggered by the issuers.

 

{
  "head":{
     "version":"v1",
     "signature":"WdDf8b1B8OMLy6dZtdZQros=",
     "requestId":"1639651691",
     "signatureType":"CHECKSUM",
     "requestTimestamp":"1639651724075"
  },
  "body":{
     "mid":"INTEGR776986XXXXXX",
     "tokenInfo":{
        "tokenIndexNumber":"61bb196cfXXX57577b",
        "cardScheme":"VISA",
        "tokenExpiry":"102022",
        "issuingBankName":"ICICI Bank",
        "cardSuffix":"32XX",
        "tokenUniqueReference":"60fafffc42XXXX40000",
        "panUniqueReference":"V00100XXXXX20166880000",
        "displayName":"ICICI Bank",
        "tokenStatus":"ACTIVE",
        "cardType":"CC",
        "tokenSuffix":"04XX",
        "tokenBin":"447XXXX38"
     }
  }
}
{
  "head":{
     "version":"v1",
     "signature":"WdDf8b1B8OMLy6dZtdZQros=",
     "requestId":"1639651691",
     "signatureType":"CHECKSUM",
     "requestTimestamp":"1639651724075"
  },
  "body":{
     "mid":"INTEGR776986XXXXXX",
     "tokenInfo":{
        "tokenIndexNumber":"61bb196cfXXX57577b",
        "cardScheme":"VISA",
        "tokenExpiry":"102022",
        "issuingBankName":"ICICI Bank",
        "cardSuffix":"32XX",
        "tokenUniqueReference":"60fafffc42XXXX40000",
        "panUniqueReference":"V00100XXXXX20166880000",
        "displayName":"ICICI Bank",
        "tokenStatus":"FAILED",
        "cardType":"CC",
        "tokenSuffix":"04XX",
        "tokenBin":"447XXXX38"
     }
  }
}

Note: All the response codes of the transaction are available here.

 

The parameters are briefly described below.

 

Head

ATTRIBUTE DESCRIPTION
version
string
mandatory
Version of the API
Possible Value: v1
requestTimestamp
string
mandatory

EPOCH timestamp of the time at which request is being sent

Possible Value: 1588402269

requestId
string
mandatory

Merchant’s Unique Request ID for card tokenization

Possible Value: Any

signature
string
mandatory

Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

Possible Value: Any

signatureType
string
mandatory

Authorization method for this request.

Possible Value: CHECKSUM

Body

ATTRIBUTE DESCRIPTION
mid
string
mandatory

Paytm provides MID as a unique identifier to each merchant.For your staging MID, click here. You get the production MID post the account activation.

Example:INTEGR7769XXXXXX9383

tokenIndexNumber
string
mandatory
Unique Token Reference ID provided by Paytm Token Service
Possible Value:Any Alphanumeric
cardScheme
string
mandatory
The network used for card token generated
Possible Values: VISA, MASTER, RUPAY
tokenExpiry
string
mandatory
Expiry  of the card token
Possible Value:MMYYYY format .ie 092021
issuingBankName
string
mandatory
Name of the bank issuing the card
Possible Value:Any
cardSuffix
string
mandatory
Last 4 digits of the actual card
Possible Value:Any
tokenUniqueReference
string
optional
The unique reference allocated to the Primary Account Number by the network Provided if the tokenization was successful.
Possible Value:Any
panUniqueReference
string
conditional
Token reference number provided by card network.
Possible Value:Any
cardType
string
mandatory
Type of the card
Possible Values: CC or DC
displayName
string
mandatory
Display name of the card
Example: HDFC Bank Regalia
tokenSuffix
string
mandatory
Last 4 digits of token
tokenStatus
string
mandatory
The status of the token. Must be one of the four possible values.
INIT: Tokenization is not yet complete
SUSPENDED: Card Token has been temporarily disabled.
ACTIVE: Card token is active and transactions can be processed with the same.
DEAD: Card Token has been deleted permanently.
FAILED: Card Token failed by system or card network error.
tokenBin
string
mandatory
First 9 digits of the card token
Example: 447XXXX38