# consultUnbinding

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. 

## Structure

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

-   [Request header](api_overview#3mLq0)
-   [Response header](api_overview#YdmVS)

**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:

- Maximum length: 64 characters

#### referenceMerchantId (String, REQUIRED)

The unique ID that is assigned by the ACQP to identify a merchant.

More information:

- Maximum length: 32 characters

#### accessToken (String, REQUIRED)

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

More information:

- Maximum length: 128 characters

#### acquirerId (String, REQUIRED)

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

More information:

- Maximum length: 64 characters

#### pspId (String, REQUIRED)

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

More information:

- Maximum length: 64 characters

## Response parameters

#### result (Result, REQUIRED)

The result of the consulting. See Result processing logic for details.

##### resultCode (String, REQUIRED)

The result code that indicates the detailed processing result.

More information:

- Maximum length: 64 characters

##### resultStatus (String, REQUIRED)

The result status that indicates the processing result. Valid values are:

-   `S`: Successful
-   `F`: Failed
-   `U`: Unknown

##### resultMessage (String)

The result message that describes the result code in detail.

More information:

- Maximum length: 256 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`: 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:

- Maximum length: 256 characters

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 `S` and 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 | 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. |

## Request

### ALIPAY, ALIPAY_HK, DANA, H5, DIRECT

```json
{
  "authClientId": "21888211212100",
  "referenceMerchantId": "21888211212101",
  "accessToken": "2810120412122ojsalksa000",
  "acquirerId": "102218800000000000",
  "pspId": "102208800000000000"
}
```

## Response

```json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "success"
  },
  "allowUnbinding": "false",
  "refuseReason": "merchant not allow unbinding"
}
```