paytm developer docs logoDeveloperDocumentation
search

POSTModify Token Status API

Use Case

Used by merchants to delete the token card mapped to Unique customer identifier and MID combination

Request Attributes

Content Type : JSON

Head

AttributeDescription
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: timestamp

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

clientId
string
optional

Paytm uses the merchant key on the basis of clientId parameter value. It is required only if the merchant has more than one key.

encryptionKeyVersion
string
optional

Paytm uses the merchant key on the basis of the encryption key version. It is required only if the merchant has more than one key.

Possible Value: v1

Body

AttributeDescription
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

tokenStatus
string
mandatory

The status of the token. Must be one of the three possible values.
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.

userInfo
userInfo
mandatory

Customer info object

userInfoCoft
+
AttributeDescription
custId
string
mandatory

 Merchant customer id/consumer id

Possible Values: Any

firstName
string
optional

Customer/consumer first name

Possible Values: Any

lastName
string
optional

Customer/consumer last name

Possible Values: Any

mobileNumber
string
optional

Customer/consumer mobile no

Possible Value: Any (valid mobile no)

requestedBy
string
mandatory

Agent that triggered the token status change. Must be either of the three possible values.

Possible Value: CARDHOLDER,MERCHANT,TOKEN_REQUESTOR

reason
text
mandatory

Freeform reason why the Token is being modified

reasonCode
string
mandatory

The reason code for token status modification. Must be either of the three possible values. 

Possible Value: SUSPECTED_FRAUD,CUSTOMER_CONFIRMED,OTHER

Response Attributes

Content Type : JSON

Head

AttributeDescription
Version
string

API version

responseTimestamp
string

Response time in milliseconds

requestId
string

Unique ID sent in request

Body

AttributeDescription
tokenStatus
string

Final Token status after Modification,token state is not present for failure resultInfo

Possible Value: SUSPENDED/ACTIVE/DEAD

resultInfo
resultInfo

Status object

ResultInfo
+
AttributeDescription
resultCode
string

Response code for different failure reason

Possible Values: Any

resultStatus
string

Response status

Possible Values: S/F/U

resultMsg
string

Response message

Possible Values: Any

⇾
Staging
Production
https://securestage.paytmpayments.com/coft-center/coft/merchant/{mid}/token/modifyStatus?requestId={request-id}copy icon
REQUEST
RESPONSE
CURL
PHP
PYTHON
NODE
curl -X PUT 'https://securestage.paytmpayments.com/coft-center/coft/merchant/{mid}/token/modifyStatus?requestId={request-id}' \
--header 'Content-Type: application/json' \
--data '{"body":{"tokenStatus":"SUSPENDED","tokenIndexNumber":"61af6a68f2108f05055","requestedBy":"MERCHANT","reason":"Deletemycard","reasonCode":"SUSPECTED_FRAUD","userInfo":{ "custId": "xxxx_15", "firstName": "", "lastName": "", "mobileNumber": "7777777777"}},"head":{"version":"v1","requestTimestamp":"1544614590000","requestId":"merchre000001","signature":"d7186f022c5a44cc8915bf74e4e8c9f61534487392716","signatureType":"CHECKSUM"}}'
copy icon