cancelTokenAlipay+ → MPP
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). Alipay+ routes the request to the Mobile Payment Provider (MPP). 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 retrieve a new access token.
Note: In the following sections, 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:
1. Set the data type of each parameter (except array) as String. This means that you must use double quotation marks (" ") to enclose the parameter value. Examples:
- If the data type of a parameter is Integer and its value is 20, set it as "20".
- If the data type of a parameter is Boolean and its value is true, set it as "true".
2. For optional parameters that are not required in your case, you can take one of the following actions:
- Exclude the parameters from the request body.
- Set the parameter values as null (without the double quotation marks).
Do NOT leave the optional parameters empty by setting their values as ""; otherwise, an error might occur.
Request parameters
pspId String REQUIRED
The unique ID that is assigned by Alipay+ to identify an MPP.
More information:
- Maximum length: 64 characters
acquirerId String REQUIRED
The unique ID that is assigned by Alipay+ to identify an ACQP.
More information:
- Maximum length: 64 characters
accessToken String REQUIRED
The token that is used to access the MPP user's resources.
More information:
- This field is an API idempotency field.For requests that are initiated with the same accessToken, the MPP needs to return the same result.
- Maximum length: 128 characters
passThroughInfo String
The information that is passed through by Alipay+ to the MPP. The value of this parameter is in the set of key-value pairs.
This parameter is specified by Alipay+ if the ACQP wants to pass information to the MPP.
More information:
- Maximum length: 20000 characters
Response parameters
result Result REQUIRED
The result of the token cancelation. If the value of the result.resultCode parameter is SUCCESS, the access token is successfully canceled. For more information about how to return the cancelation result, see How to return the result.
passThroughInfo String
The information that is passed through by the MPP to Alipay+. The value of this parameter is in the set of key-value pairs.
Return this parameter if the MPP wants to pass information to the ACQP.
More information:
- Maximum length: 20000 characters
Request
Response
More information
How to return the result
According to the request processing result, the MPP needs to return the corresponding result (specified by the result parameter):
- If the token cancelation succeeds, set the value of result.resultStatus to
Sand the value of result.resultCode toSUCCESS. - If the token cancelation fails, set the value of result.resultStatus to
Fand the value of result.resultCode accordingly. - If the token cancelation result is unknown, set the value of result.resultStatus to
Uand the value of result.resultCode accordingly.
For more information about how to define your result codes, see the Result codes section below.
Result/Error codes
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| ACCESS_DENIED | F | Access is denied. |
| INVALID_CLIENT | F | The client is invalid. |
| INVALID_SIGNATURE | F | The signature is invalid. |
| INVALID_TOKEN | F | The access token is invalid. |
| KEY_NOT_FOUND | F | The key is not found. |
| MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTPS method. |
| NO_INTERFACE_DEF | F | API is not defined. |
| PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. |
| UNKNOWN_EXCEPTION | U | An API call failed, which is caused by unknown reasons. |