consultUnbindingAlipay+ → ACQP
Alipay+ uses the consultUnbinding API to consult whether the auth client (usually the merchant) allows an access token to be canceled from the Mobile Payment Provider (MPP ) side.
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
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
referenceMerchantId String REQUIRED
The unique ID that is assigned by the ACQP to identify a merchant.
More information about this field
- Maximum length: 32 characters
accessToken String REQUIRED
The token that is used to access the MPP user's resources.
More information about this field
- Maximum length: 128 characters
acquirerId String REQUIRED
The unique ID that is assigned by Alipay+ to identify an ACQP.
More information about this field
- Maximum length: 64 characters
pspId String REQUIRED
The unique ID that is assigned by Alipay+ to identify an MPP.
More information about this field
- Maximum length: 64 characters
Response parameters
result Result object REQUIRED
The result of the consulting. See Result processing logic for details.
allowUnbinding Boolean
This parameter indicates whether the auth client allows the access token to be revoked from the MPP side. Valid values are:
true: indicates that the auth client allows the access token to be revoked from the MPP side.false: indicates that the auth client does not allow the access token to be revoked from the MPP side.
Note: Required if the value of the result.resultStatus parameter is S.
refuseReason String
The reason that the account unbinding is refused.
Note: Required when the ACQP does not allow the access token to be revoked from the MPP side.
More information about this field
- Maximum length: 256 characters
Request
Response
More information
How to return the result
The ACQP needs to return the result (specified on the result parameter) according to the consultation result.
- If the consultation is successful, set the value of result.resultStatus to
Sand specify the value of the allowUnbinding parameter according to whether the auth client allows the access token to be revoked from the MPP side. - If the consultation failed, set the value of result.resultStatus to
F. - If system or network issues exist, set the value of result.resultStatus to
U, and Alipay+ will retry the consultation.
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. |
| 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. |