ClickPay provides you with a collection of API endpoints which used to process all payments, regardless of if they are through either your own payment pages, the managed payment pages, or if you are using the hosted payment pages. 


Tokenization is the process of protecting sensitive data by replacing it with an algorithmically generated number called a token. This can be used to allow returning customers to purchase without re-entering credit card details (recurring), such as monthly subscription fees. In this article, we will walk you through the way to delete/revoke a specific token.



TABLE OF CONTENTS


The Endpoint and Related Postman Collection



In this tutorial, we will rely on the ClickPay invoices API Endpoint, mentioned on the ClickPay API endpoints postman collection, which you can access from here. The endpoint will need to be accessed with a POST request on the below-mentioned URL.


Post{{domain}}/payment/token/delete



Deleting token will NEVER affect the previous transactions performed with this token.



The Required Parameters


To query about payment tokens, there are required parameters that need to be passed with valid information. The specification of these required parameters is clarified below:


ParameterData TypeMin/MaxRequiredPurpose
profile_id
INTAccept only valid profile number

The merchant Profile ID you can get from your ClickPay dashboard. For more information please check our How to get your account information from ClickPay Dashboard? solution article.

To know more about this parameter please click here.

tokenSTRINGValid token onlyIndicates the token you want to delete or revoke.
To know more about this parameter please click here.



Sample Request Payload


The below sample request payload will show you how you can pass the above-mentioned parameters, which are needed to be passed with valid values to perform a request.


{
  "profile_id": "profile_id",
  "token": "2C4651FF67A1EC3406B621F8438A78BC"
}



Sample Response Payload


{
  "code": 0,
  "message": "success"
}