Skip to main content
Version: Lastest

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

ParametersRequirementData typeDescriptionNote
tokenIdrequiredStringID of the AppotaPay token you wish to delete.Min:1 Max: 32

URL Query

ParametersRequirementData typeDescriptionNote
merchantRefIdrequiredStringID you can assign to the DELETE Token request, if you wishMin:1 Max: 40

Example Request

{
"merchantRefId": "9IzaassK2"
}

Response Params

{
"tokenId": "01hqhr4qqnk66d7tg3pk5md08c",
"merchantRefId": "9IzaassK2",
"isDeleted": true
}

Success

Http Status Code 200 - OK

ParametersData typeDescriptionNote
tokenIdStringID of the token submitted for deletion.
merchantRefIdStringID assigned to the DELETE Token request, if added
isDeletedStringIndicates 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