Alipay+Alipay+

cancelTokenACQP → Alipay+

POST /aps/api/v1/authorizations/cancelToken

The ACQP uses the cancelToken API to revoke an access token if the user wants to cancel the authorization to the auth client (which is usually the merchant). After the access token is revoked, the auth client cannot use the access token to access the user's resources and cannot use the related refresh token to get a new access token. 

Note: In the following sections, Mobile Payment Provider (MPP ) is also known as PSP. For example, pspId refers to the ID that identifies an MPP.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Note:

Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:

  • If the data type of a field is Integer and its value is 20, set it as "20".
  • If the data type of a field is Boolean and its value is true, set it as "true".

Request parameters

accessToken String  REQUIRED

The token that is used to access the MPP user's resources.

More information about this field:

  • This field is an API idempotency field. For requests that are initiated with the same accessToken, Alipay+ regards the requests as repeated and processes the requests only once.
  • Maximum length: 128 characters

authClientId String  REQUIRED

The unique ID that is assigned by the ACQP to identify the auth client, which is usually the merchant. 

More information about this field:

  • Maximum length: 64 characters

passThroughInfo String  

The information that is passed through by the ACQP to Alipay+. The value of this parameter is in the set of key-value pairs.

Note: Specify this parameter if the ACQP wants to pass information to the MPP. 

More information about this field:

  • Maximum length: 20000 characters

Response parameters

result Result object REQUIRED

The result of the token cancelation. If the value of the result.resultCode parameter is SUCCESS, the access token is successfully canceled. See Result processing logic for details. 

Show child parameters

pspId String  

The unique ID that is assigned by Alipay+ to identify an MPP.

Note: Returned if the value of the result.resultCode parameter is SUCCESS

More information about this field:

  • Maximum length: 64 characters

acquirerId String  

The unique ID that is assigned by Alipay+ to identify an ACQP.

Note: Returned if the value of the result.resultCode parameter is SUCCESS

More information about this field:

  • Maximum length: 64 characters

passThroughInfo String  

The information that is passed through by Alipay+ to the ACQP. The value of this parameter is in the set of key-value pairs.

Note: Returned by Alipay+ if the MPP wants to pass information to the ACQP. 

More information about this field:

  • Maximum length: 20000 characters
API Explorer
Sample CodesRun in Sandbox

Request

URL
Request Body

Response

Response Body

More information

Result processing logic

For different request results, different actions are to be performed. See the following list for details: 

result.resultStatus

result.resultCode

Actions

S

SUCCESS

The authorization is successfully canceled. The access token and the related refresh token can no longer be used.

F

INVALID_TOKEN/EXPIRED_ACCESS_TOKEN

Check and ensure that the access token is valid and obtained from . If it is, you can regard that the token is canceled successfully. The related payment method on the merchant payment method page can be removed.

F

...

Retry the API call.

U

...

Retry the API call.

No result received

Retry the API call.

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

N/A

ACCESS_DENIEDFAccess is denied.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

EXPIRED_ACCESS_TOKENFThe access token is expired.

You can regard that the access token has been canceled successfully and then remove the payment method.

INVALID_CLIENTFThe client is invalid.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

INVALID_SIGNATUREFThe signature is invalid.

Check whether the public key, signed message, and signature algorithm are as expected.

INVALID_TOKENFThe access token is invalid.

Ensure that the access token is correct and obtained from Alipay+ and retry the cancelation. If the access token is correct and obtained from Alipay+, you can regard that the token has been canceled successfully and then remove the payment method.

KEY_NOT_FOUNDFThe key is not found.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.

Use a media type that is accepted by Alipay+.

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTPS method.

Ensure the HTTP method is POST.

NO_INTERFACE_DEFFAPI is not defined.

Check whether the request URL is correct. Ensure that the endpoint of the called API is correct.

PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.

Check whether the request parameters, including the header parameters and body parameters, are correct and valid. For more information about the parameters of each API, see the Structure section of the specific API reference topic.

PROCESS_FAILFA general business failure occurred. Do not retry.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

Reduce the frequency of API calls.

UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.

Try to recall the API.