# inquiryPayment `POST /aps/api/v1/payments/inquiryPayment` The **inquiryPayment** API is used by the Acquiring Service Provider (ACQP) to query the payment result if no payment result is received after a certain period of time.  **Note:** In the following sections, Mobile Payment Provider (MPP) is also known as Payment Service Provider. 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](api_overview.md#3mLq0)  - [Response header](api_overview.md#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 #### paymentRequestId (String) The unique ID that is assigned by the ACQP to identify a payment order. **Note**: Required if the _paymentId_ parameter is not specified. More information: - Maximum length: 64 characters #### paymentId (String) The unique ID that is assigned by Alipay+ to identify a payment order. **Note**: Required if the _paymentRequestId_ parameter is not specified. 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 handle the result of the **inquiryPayment** API, see _Result processing logic._ ##### 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 #### paymentResult (Result) The result of the payment. See the _Payment result_ _codes_ table below for details. **Note**: Returned 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 #### acquirerId (String) The unique ID that is assigned by Alipay+ to identify an ACQP. **Note**: Returned by Alipay+ if the value of the _result.resultStatus_ parameter is `S`, which means that the inquiry is successful. More information: - Maximum length: 64 characters #### pspId (String) The unique ID that is assigned by Alipay+ to identify an MPP.  **Note**: Returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds. More information: - Maximum length: 64 characters #### paymentRequestId (String) The unique ID that is assigned by the ACQP to identify a payment order. **Note**: Returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds. More information: - Maximum length: 64 characters #### paymentId (String) The unique ID that is assigned by Alipay+ to identify a payment order. **Note**: This parameter is returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds; otherwise, this parameter may or may not be returned. #### paymentAmount (Amount) The amount that the ACQP requests to receive from Alipay+. The currency of the amount is the same as the one that the ACQP uses to create the payment order. **Note**: Returned 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. For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1, 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. **Note**: Returned by Alipay+ 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 Alipay+ to identify an MPP user. **Note**: Returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S` and the MPP provides a unique ID that identifies the user. More information: - Maximum length: 64 characters #### walletBrandName (String) The brand name of the MPP that is displayed to the customer. **Note**: Returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds. More information: - Maximum length: 128 characters #### transactions (Array) The list of refund transactions that are related to the queried payment order. **Note**: Returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S` and at least one refund transaction is linked to the payment order. More information: - Maximum size: Unlimited ##### transactionResult (Result, REQUIRED) The result of the transaction, including the result status, result code, and result message. ###### 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 ##### transactionId (String) The unique ID that is assigned by Alipay+ to identify a transaction.  **Note**: - The value of this parameter is the same as that of the _refundId_ parameter if _transactionType_ is `REFUND`. - Required if the transaction is completed. More information: - Maximum length: 64 characters ##### transactionType (String, REQUIRED) The type of transaction. Valid values are:  - `REFUND`: indicates a refund transaction ##### transactionStatus (String, REQUIRED) The status of the transaction. Valid values are: - `SUCCESS`: indicates that the transaction is successful. - `FAIL`: indicates that the transaction failed. - `PROCESSING`: indicates that the transaction is under processing. - `CANCELLED`: indicates that the transaction is canceled. ##### transactionAmount (Amount, REQUIRED) The amount of the transaction. **Note**: The value of this parameter is the same as that of the _refundAmount_ parameter if _transactionType_ is `REFUND`. ###### 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. For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1, set the value of this parameter to 1. More information: - Value range: 1 - unlimited ##### transactionRequestId (String, REQUIRED) The unique ID that is assigned by the ACQP to identify a transaction request. **Note**: The value of this parameter is the same as that of the _refundRequestId_ parameter if _transactionType_ is `REFUND`. More information: - Maximum length: 64 characters ##### transactionTime (Datetime) The time when the transaction is completed. **Note**: Required if the transaction is completed. 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". #### settlementAmount (Amount) The gross amount that Alipay+ settles to the ACQP. When the settlement currency (specified on the _settlementAmount.currency_ parameter) is different from the payment currency (specified on the _paymentAmount.currency_ parameter), the settlement amount that is specified on the _settlementAmount.value_ parameter is calculated based on the _paymentAmount_ and _settlementQuote_ parameters. **Note**: Returned by Alipay+ 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. For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1, set the value of this parameter to 1. More information: - Value range: 1 - unlimited #### settlementQuote (Quote) The exchange rate between the settlement currency (specified on the _settlementAmount.currency_ parameter) and the payment currency (specified on the _paymentAmount.currency_ parameter). **Note**: Returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S` and the settlement currency is different from the payment currency. ##### quoteId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify an exchange rate. More information: - Maximum length: 64 characters ##### quoteCurrencyPair (String, REQUIRED) A currency pair, of which the first listed currency (also called base currency) is quoted against the second currency (also called quote currency). The value of this parameter is in the format of `_{base_currency}/{quote_currency}_`, where `_{base_currency}_` and `_{quote_currency}_` are alphabetic codes that follow the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. For example, if the base currency is euro and the quote currency is dollar, the value of this parameter is EUR/USD. More information: - Maximum length: 8 characters ##### quotePrice (Decimal, REQUIRED) The quotation of the exchange rate between the currency pair that is specified on the _quoteCurrencyPair_ parameter. More information: - Value range: 0 - unlimited ##### quoteStartTime (Datetime) The time when the quotation (specified on the _quotePrice_ parameter) takes effect. 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". ##### quoteExpiryTime (Datetime) The time when the quotation (specified on the _quotePrice_ parameter) expires. 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". ##### baseCurrency (String) The first currency in the currency pair that is specified on the quoteCurrencyPair parameter. The value is an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. More information: - Maximum length: 3 characters ##### quoteUnit (String) The amount in the base currency that is specified on the _baseCurrency_ parameter. More information: - Maximum length: 12 characters #### customsDeclarationAmount (Amount) The maximum 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. **Note**: Returned by Alipay+ 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. For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1, set the value of this parameter to 1. More information: - Value range: 1 - unlimited #### mppPaymentId (String) The unique ID that is assigned by the MPP to identify a payment order. This parameter is returned by Alipay+ if the value of the _paymentResult.resultStatus_ parameter is `S`, which means that the payment succeeds. More information: - Maximum length: 64 characters ## More information ### Result processing logic Alipay+ returns the following two kinds of results: - _result_: specifies whether the **inquiryPayment** API request is received successfully. - _paymentResult:_ specifies the payment result. You might receive different results from Alipay+. Follow the instructions below to handle the result.  

result.resultStatus

paymentResult.resultStatus

Payment status

Actions

S

S

Payment succeeds.

Update the status from your server side.

S

F

If paymentResult.resultCode is ORDER\_IS\_CLOSED, the payment order is closed or canceled; otherwise, the payment fails.

Take actions according to the payment result code (specified on the paymentResult.resultCode parameter). For more information, see the Result codes section below.

S

U

Payment is in processing.

Keep inquiring within the payment expiry time. For more information about inquiry rules for different products, see the Payment result inquiry rules section below.

If you still receive the same payment result of U after the payment expires or after your inquiry times exceed the maximum limit, call the cancelPayment API to cancel the payment.

F

F

The payment fails or the payment order does not exist.

  • For cases where the payment fails, take actions according to the payment result code (specified on the paymentResult.resultCode parameter) or contact the technical support team at connect\_support@service.alipay.com.
  • For cases where the payment order does not exist, the reason might be:
    • The payment order ID is incorrect. Use the correct payment order ID to perform inquiries.
    • The payment order is not created in the Alipay+ system yet. Keep inquiring within the payment expiry time. For more information about inquiry rules for different products, see the Payment result inquiry rules section below.

If you still receive the same payment result of U after the payment expires or after your inquiry times exceed the maximum limit, call the cancelPayment API to cancel the payment.

U

U

Unknown exception

Keep inquiring within the payment expiry time. For more information about inquiry rules for different products, see the Payment result inquiry rules section below.

If you still receive the same payment result of U after the payment expires or after your inquiry times exceed the maximum limit, call the cancelPayment API to cancel the payment.

No result received

Unknown

Keep inquiring within the payment expiry time. For more information about inquiry rules for different products, see the Payment result inquiry rules section below.

If you still receive no payment result after the payment expires or after your inquiry times exceed the maximum limit, call the cancelPayment API to cancel the payment.

#### Payment result inquiry rules The following table lists the payment result inquiry rules for different products.

Product

Inquiry frequency

Default payment expiry time

Cashier Payment

An incremental frequency within the payment expiry time

10 minutes

Auto Debit

10 to 20 times within the payment expiry time

60 seconds

User-presented Mode Payment

10 to 20 times within the payment expiry time

60 seconds

Merchant-presented Mode Payment

30 to 60 times within the payment expiry time

180 seconds

## Result/Error codes | Code | Value | Message | Further action | | --- | --- | --- | --- | | SUCCESS | S | Success | N/A | | 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. | | ORDER_NOT_EXIST | F | The order doesn't exist. | Close the order at the ACQP side and call the cancelPayment API. | | 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 Structure 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. | ## Payment result codes | Code | Value | Message | Further action | | --- | --- | --- | --- | | SUCCESS | S | Success | Update the status from the ACQP side. | | BUSINESS_NOT_SUPPORT | F | The payment business is not supported. | Check whether the parameter values in the request message, such as merchant ID and transaction currency, conform to the contract. If yes, it is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue; otherwise, correct the parameters to align with the contract. | | CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Ensure the currencies used in the request, such as payment currency and settlement currency, conform to the contract. If the issue persists, it is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. | | EXPIRED_CODE | F | The code is expired. | Instruct the user to refresh the payment code. | | INVALID_CONTRACT | F | The contract is invalid. | Check whether the parameter values in the request message, such as merchant ID and transaction currency, conform to the contract. If yes, it is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue; otherwise, correct the parameters to align with the contract. | | INVALID_TOKEN | F | The access token is invalid. | Instruct the user to authorize again. | | ORDER_IS_CLOSED | F | The order is closed. | Close the order at the ACQP side. | | PAYMENT_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the limit that is specified by Alipay+. | It is recommended that you inform the user of the error. | | PAYMENT_COUNT_EXCEED_LIMIT | F | The number of payments exceeds the limit. | Wait until the MPP server allows more requests. | | PROCESS_FAIL | F | A general business failure occurred. Don't retry. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. | | RISK_REJECT | F | The request is rejected because of the risk control. | It is recommended that you inform the user of the error. | | UNAVAILABLE_PAYMENT_METHOD | F | The payment method is unavailable. | It is recommended that you inform the user of the error. | | USER_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the payment limit that is specified by the user's digital wallet. | It is recommended that you inform the user of the error. | | USER_BALANCE_NOT_ENOUGH | F | The user balance is not enough for the payment. | It is recommended that you inform the user of the error. | | USER_NOT_EXIST | F | The user does not exist. | It is recommended that you inform the user of the error. | | USER_STATUS_ABNORMAL | F | The user status is abnormal. | It is recommended that you inform the user of the error. | | PAYMENT_IN_PROCESS | U | The payment is being processed. | Call the inquiryPayment API to inquire about the payment result. | | PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. | Check and verify whether the request parameters, including the header parameters and body parameters, are correct and valid. For details on the parameters of each API, see the specific API Structure section. | ## Request ```json { "paymentRequestId": "pay_1089760038715669_10277574507566920200101234567890000" } ``` ## Response ```json { "acquirerId": "1111088000000000000", "pspId": "1022172000000000000", "result": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "success" }, "paymentResult": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "success" }, "paymentRequestId": "pay_1089760038715669_102775745070000", "paymentId": "20200101234567890130000", "mppPaymentId": "pay_1089760038715670_102775745070001", "paymentTime": "2020-01-01T12:01:01+08:30", "paymentAmount": { "value": "100", "currency": "JPY" }, "customerId": "1230000", "walletBrandName": "walletName", "transactions": [ { "transactionResult": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "success" }, "transactionId": "1111111111111110000", "transactionType": "REFUND", "transactionStatus": "SUCCESS", "transactionRequestId": "pay_1089760038715669_102775745070000", "transactionAmount": { "value": "50", "currency": "USD" }, "transactionTime": "2019-06-01T12:01:01+08:30" } ], "settlementAmount": { "value": "74", "currency": "USD" }, "settlementQuote": { "quoteCurrencyPair": "USD/JPY", "quoteExpiryTime": "2021-06-02T13:15:48+08:00", "quoteId": "046793306919858814", "quotePrice": "1.35", "quoteStartTime": "2021-05-30T13:15:48+08:00" } } ```