paytm developer docs logoDeveloperDocumentation
search

POSTDelete Card API

Use Case

This async API is used to delete card token or saved card or both in bulk.

Request Attributes

Content Type : JSON

Head

AttributeDescription
tokenType
string
mandatory

Authorization method for this request.

Possible values: CHECKSUM

token
string
mandatory

Authorization string corresponding to the CHECKSUM.

Example: oo5MUzOpBaGGMSUSyaQnGgS0oHqwWNB1AdAQE9qXXXXXxhEKRQ3BF+yuo6a/Rm8mx3LvblC+dS6HQk5XXXXX7H2eUaYNrnUTQvQm1nmaXG/E=

Body

AttributeDescription
mid
string
mandatory

Paytm provides MID as a unique identifier to each merchant.

Example: INTEGR7769XXXXXX9383    

custId
string
mandatory

Customer Id of customer against a merchant    

cardId
string
mandatory

Unique Card ID / Token Index Number provided by Paytm

requestedBy
string
mandatory

Agent that triggered the token status change. Must be either of the three possible values :
CARDHOLDER
MERCHANT
TOKEN_REQUESTOR

reason
text
mandatory

Free form 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 :-
SUSPECTED_FRAUD
OTHER
CUSTOMER_CONFIRMED

isBulkDelete
boolean
optional

Flag indicating if all the similar tokenised and saved cards are to be deleted. For isParRequest = true, this should be true.

This flag has relevance only when the cardId corresponds to tokenised card.

isParRequest
boolean
mandatory

true if merchant sends request to delete card with PAR

Response Attributes

Content Type : JSON

Body

AttributeDescription
resultCode
string

Response code for different failure reason
Possible Value: Any

resultStatus
string

Response status
Possible Value: SUCCESS, FAILED,PENDING

resultMsg
string

Response Message

Possilble Value: Any

⇾
Staging
Production
https://securestage.paytmpayments.com/savedcardservice/card/delete?mid={mid}&custId={custId-id}copy icon
REQUEST
RESPONSE
CURL
PHP
DOTNET
NODE
PYTHON
curl -X POST 'https://securestage.paytmpayments.com/savedcardservice/card/delete?mid={mid}&custId={custId-id}' \
--header 'Content-Type: application/json' \
--data '{"head":{"token":"oo5MUzOpBaGGMSUSyaQnGgS0oHqwWNB1AdAQE9qXXXXXxhEKRQ3BF+yuo6a/Rm8mx3LvblC+dS6HQk5XXXXX7H2eUaYNrnUTQvQm1nmaXG/E=","tokenType":"CHECKSUM"},"body":{"mid":{mid},"custId":"cust5","cardId":"2020101101450dbec3ba9d78bcc22234e3210a157a617","requestedBy":"CARDHOLDER","reason":"Customer wants to delete the token","reasonCode":"CUSTOMER_CONFIRMED","isBulkDelete":true,"isParRequest":false}}'
copy icon