# inquiryPayment (non-NFC Payment)

The **inquiryPayment** API is used by Alipay+ to query the payment result.

**Note:** In the following sections, Mobile Payment Provider (MPP) is also known as Payment Service Provider (PSP). For example, the _pspId_ parameter specifies 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:

-   [Request header](https://docs.alipayplus.com/alipayplus/alipayplus/api_mpp/api_overview.md#3mLq0)
-   [Response header](https://docs.alipayplus.com/alipayplus/alipayplus/api_mpp/api_overview.md#YdmVS) 

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

#### acquirerId (String, REQUIRED)

The unique ID that is assigned by Alipay+ to identify an Acquiring Service Provider (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

#### paymentRequestId (String, REQUIRED)

The unique ID that is assigned by Alipay+ to identify a payment order.

More information:

- Maximum length: 64 characters

## Response parameters

#### result (Result, REQUIRED)

The result of the business processing, including the result status, result code, and result message. For more information about how to return the result, see _How to return the result_.

##### 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. 

It is recommended that you specify this parameter to provide details about the result.

More information:

- Maximum length: 256 characters

#### paymentResult (Result)

The result of the payment. The value of the _paymentResult.resultStatus_ parameter represents the payment status, where `S` represents success and `F` represents failure. See the _Payment result codes_ table for more details. 

Return this parameter if the value of the _result_._resultStatus_ parameter is `S`, which means that the inquiry is successful.

##### 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

#### paymentId (String)

The unique ID that is assigned by the MPP to identify a payment order.

Return this parameter if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds.

More information:

- Maximum length: 64 characters

#### paymentAmount (Amount)

The amount that Alipay+ requests to receive from the MPP. The currency of the amount must be specified to the one that Alipay+ uses to create the payment order. If a promotion exists, this amount does not include the promotion amount.

Return this parameter if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds.

##### currency (String, REQUIRED)

The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros.

More information:

- Maximum length: 3 characters

##### value (Integer, REQUIRED)

The value of the amount as a natural number.

By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1.

More information:

- Value range: 1 - unlimited

#### payToAmount (Amount)

The amount that the MPP settles to Alipay+. The currency of the amount is the MPP's currency.

Return this parameter if the value of the _paymentResult.resultStatus_ parameter is `S` and _payToAmount.currency_ is different from _paymentAmount.currency_. When this parameter is returned, _payToAmount_._value_ is calculated based on _paymentAmount_._value_ and _paymentQuote_._quotePrice_ by using the rounding mode of HALF EVEN.

##### currency (String, REQUIRED)

The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros.

More information:

- Maximum length: 3 characters

##### value (Integer, REQUIRED)

The value of the amount as a natural number.

By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1.

More information:

- Value range: 1 - unlimited

#### paymentTime (Datetime)

The date and time when the payment order reaches a final state.

Return this parameter if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds.

More information:

- The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00".

#### customerId (String)

The unique ID that is assigned by the MPP to identify a user.

Return this parameter if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds.

More information:

- Maximum length: 64 characters

#### customsDeclarationAmount (Amount)

The amount that is to be declared by the ACQP to customs. The currency of the amount is the currency used by the MPP's user. For example, if the user uses ALIPAY\_CN to pay, the currency is CNY.

Return this parameter if the value of the _paymentResult.resultStatus_ parameter is `S` and customs declaration is required by the MPP's local authority (for now this only includes the Chinese Mainland).

##### currency (String, REQUIRED)

The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros.

More information:

- Maximum length: 3 characters

##### value (Integer, REQUIRED)

The value of the amount as a natural number.

By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1.

More information:

- Value range: 1 - unlimited

#### passThroughInfo (String)

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

Return this parameter if the MPP wants to pass information to the ACQP.

More information:

- Maximum length: 20000 characters

## More information

### How to return the result

The MPP needs to return the result (specified on the _result_ and _paymentResult_ parameters) according to the business processing result.

-   If the payment is successful, set the value of _result.resultStatus_ to `S` and the value of _paymentResult.resultStatus_ to `S`.
-   If the payment failed, set the value of _result.resultStatus_ to `S` and the value of _paymentResult.resultStatus_ to `F`.
-   If the payment is in processing, set the value of _result.resultStatus_ to `S` and the value of _paymentResult.resultStatus_ to `U`.
-   If the payment order does not exist, set the value of _result.resultStatus_ to `F` and the value of _result.resultCode_ to `ORDER_NOT_EXIST`.
-   If system or network issues exist, set the vaue of _result.resultStatus_ to `U`, and Alipay+ will retry the inquiry.

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. |
| 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. |
| ORDER_NOT_EXIST | F | The order doesn't exist. |
| 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. |

## Payment result codes

| Code | Value | Message |
| --- | --- | --- |
| SUCCESS | S | Success |
| BUSINESS_NOT_SUPPORT | F | The payment business is not supported. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. |
| EXPIRED_CODE | F | The code is expired. |
| INVALID_CODE | F | The code is invalid. |
| INVALID_CONTRACT | F | The contract is invalid. |
| INVALID_TOKEN | F | The access token is invalid. |
| MERCHANT_NOT_REGISTERED | F | The merchant is not registered. |
| ORDER_IS_CLOSED | F | The order is closed. |
| PAYMENT_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the limit that is specified by Alipay+. |
| PAYMENT_COUNT_EXCEED_LIMIT | F | The number of payments exceeds the limit. |
| PROCESS_FAIL | F | A general business failure occurred. Don't retry.  |
| REGULATION_RESTRICTION | F | The payment failed due to regulatory restriction. |
| RISK_REJECT | F | The request is rejected because of the risk control. |
| UNAVAILABLE_PAYMENT_METHOD | F | The payment method is unavailable. |
| USER_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the payment limit that is specified by the user's digital wallet. |
| USER_BALANCE_NOT_ENOUGH | F | The user balance is not enough for the payment. |
| USER_KYC_NOT_QUALIFIED | F | The user is not KYC compliant. |
| USER_NOT_EXIST | F | The user does not exist. |
| USER_PAYMENT_VERIFICATION_FAILED | F | User fails to pass the payment verification in the methods like OPT, PIN, and so on. |
| USER_STATUS_ABNORMAL | F | The user status is abnormal. |
| PAYMENT_IN_PROCESS | U | The payment is being processed. |

## Request

```json
{
  "acquirerId": "1022188000000000001",
  "pspId": "1022172000000000001",
  "paymentRequestId": "20200101234567890132"
}
```

## Response

```json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "success"
  },
  "paymentResult": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "success"
  },
  "paymentId": "20200101234567890133333",
  "paymentTime": "2020-01-01T12:01:01+08:30",
  "paymentAmount": {
    "value": "100",
    "currency": "JPY"
  },
  "payToAmount": {
    "value": "1000",
    "currency": "KRW"
  },
  "customerId": "1234567"
}
```