Token Delete
EndPoint
DELETE
/credit-card/token/:tokenId
Header Params
{
Content-Type: "application/json",
X-APPOTAPAY-AUTH: "your_auth_token",
Language: "en", // option vi | en, default vi
X-Request-ID: "your_request_id" // optional - easy to debug request
}
Request Params
URL Parameters
Parameters | Requirement | Data type | Description | Note |
---|---|---|---|---|
tokenId | required | String | ID of the AppotaPay token you wish to delete. | Min:1 Max: 32 |
URL Query
Parameters | Requirement | Data type | Description | Note |
---|---|---|---|---|
merchantRefId | required | String | ID you can assign to the DELETE Token request, if you wish | Min:1 Max: 40 |
Example Request
{
"merchantRefId": "9IzaassK2"
}
Response Params
{
"tokenId": "01hqhr4qqnk66d7tg3pk5md08c",
"merchantRefId": "9IzaassK2",
"isDeleted": true
}
Success
Http Status Code
200
-OK
Parameters | Data type | Description | Note |
---|---|---|---|
tokenId | String | ID of the token submitted for deletion. | |
merchantRefId | String | ID assigned to the DELETE Token request, if added | |
isDeleted | String | Indicates if the token is deleted. Available values: true : token is successfully deleted.false : while this is a possible value when the DELETE request has issues, it is unlikely to be returned as AppotaPay will return the appropriate error response instead. |
Error
HTTP Status Code !=
200