consultUnbindingMPP → Alipay+
The Mobile Payment Provider (MPP) uses the consultUnbinding API to consult whether the auth client (usually the merchant) allows an access token to be canceled from the MPP side.
Usually, the MPP calls the consultUnbinding API when the MPP user wants to unbind his/her MPP account with the related auth client account.
Note: In the following sections, the 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:
- exclude them from the request body.
- set the 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
authClientId String REQUIRED
The unique ID that is assigned by the Acquiring Service Provider (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
Response parameters
result Result object REQUIRED
The result of the consulting. For more information about how to handle the result of the consultUnbinding API, see How to handle the result.
acquirerId String
The unique ID that is assigned by Alipay+ to identify an ACQP
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is SUCCESS.
More information about this field
- Maximum length: 64 characters
pspId String
The unique ID that is assigned by Alipay+ to identify an MPP
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is SUCCESS.
More information about this field
- Maximum length: 64 characters
allowUnbinding Boolean
This parameter indicates whether the auth client allows the access token to be revoked from the MPP side. Valid values are:
true: The auth client allows the access token to be revoked from the MPP side.false: The auth client does not allow the access token to be revoked from the MPP side.
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is SUCCESS.
refuseReason String
The reason that the account unbinding is refused.
This parameter is returned by Alipay+ if 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 handle the result
You might receive different results from Alipay+. Follow the instructions below to handle the result.
result.resultStatus | result.resultCode | Consultation status | Actions |
|
| The API call succeeds and the consultation about unbinding is completed. | Retrieve the value of the allowUnbinding parameter to see whether the access token can be revoked from the MPP side. |
| Multiple possible values exist, such as
| The API call fails, probably because of the system exception. | Take actions according to the error message in the result.resultCode parameter. If the problem persists, contact connect_support@service.alipay.com. |
| Multiple possible values exist, such as
| Unknown exception, which might be caused by network timeout. | It is recommended that the MPP guides the user to reopen the Authorization Detail Page and reinitiate the account unbinding process. |
No result received | It is recommended that the user reopen the Authorization Detail Page and reinitiate the account unbinding process. | ||
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | Retrieve the value of the allowUnbinding parameter to see whether the access token can be revoked from the MPP side. |
| ACCESS_DENIED | F | Access is denied. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| INVALID_CLIENT | F | The client is invalid. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| INVALID_SIGNATURE | F | The signature is invalid. | Check whether the public key, signed message, and signature algorithm are as expected. |
| KEY_NOT_FOUND | F | The key is not found. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | Use a media type that is accepted by Alipay+. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTPS method. | Ensure the HTTP method is POST. |
| NO_INTERFACE_DEF | F | API is not defined. | Check whether the request URL is correct. Ensure that the endpoint of the called API is correct. |
| PARAM_ILLEGAL | F | Illegal 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_FAIL | F | A 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_LIMIT | U | The request traffic exceeds the limit. | Reduce the frequency of API calls. |
| UNKNOWN_EXCEPTION | U | An API call failed, which is caused by unknown reasons. | Try to recall the API. |