POSTDelete Card API
Use Case
This async API is used to delete card token or saved card or both in bulk.
Request Attributes
Head
Attribute | Description |
---|---|
tokenType string mandatory | Authorization method for this request. Possible values: JWT |
token string mandatory | Authorization string corresponding to the JWT token. Example: 739816707d7444XXXXXXXX6cb4264d0a1590145379323 |
Body
Attribute | Description |
---|---|
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 : |
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 :- |
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
Body
Attribute | Description |
---|---|
resultCode string | Response code for different failure reason |
resultStatus string | Response status |
resultMsg string | Response Message Possilble Value: Any |
curl -X POST 'https://securegw-stage.paytm.in/savedcardservice/card/delete?mid={mid}&custId={custId-id}' \
--header 'Content-Type: application/json' \
--data '{"head":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2MjYxNjAxNDEsIm1pZCI6ImUxajJobDM4NzUxNjgxODg2MTI5IiwiY3VzdElkIjoiY3VzdDUiLCJyZXF1ZXN0SWQiOiIxMDAwMSJ9.JUsyAJ8PWKRXltQrnFFfgGRJQu1xZR6oiTZFSqPun2I","tokenType":"JWT"},"body":{"mid":{mid},"custId":"cust5","cardId":"2020101101450dbec3ba9d78bcc22234e3210a157a617","requestedBy":"CARDHOLDER","reason":"Customer wants to delete the token","reasonCode":"CUSTOMER_CONFIRMED","isBulkDelete":true,"isParRequest":false}}'