inquiryPushPaymentAlipay+ → ACQP
The inquiryPushPayment API is used by Alipay+ to inquire about the payment result if no payment result is received after a certain period in Merchant-presented Mode Payment (Push Mode).
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:
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 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
codeValue string REQUIRED
The code value that the user scans.
More information:
- Maximum length: 512 characters
paymentId String REQUIRED
The unique ID that is assigned by Alipay+ to identify a payment order.
More information:
- Maximum length: 64 characters
paymentRequestId String
The unique ID that is assigned by the ACQP to identify a payment order.
This parameter is specified by Alipay+ if the ACQP returned this parameter in the response to the userInitiatedPay request.
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.
paymentResult Result
The result of the payment. See the Payment result codes table for details.
Return this parameter if the value of the result.resultStatus parameter is S, which means that the inquiry is successful.
paymentRequestId String
The unique ID that is assigned by the ACQP 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
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 standard format. For example, "2019-11-27T12:01:01+08:00".
Request
Response
More information
How to return the result
The ACQP 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
Sand the value of paymentResult.resultStatus toS. - If the payment failed, set the value of result.resultStatus to
Sand the value of paymentResult.resultStatus toF. - If the payment is in processing, set the value of result.resultStatus to
Sand the value of paymentResult.resultStatus toU. - If the payment order does not exist, set the value of result.resultStatus to
Fand the value of result.resultCode toORDER_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_MERCHANT_STATUS | F | The merchant status is abnormal due to restrictions, for example, the merchant's operation has been suspended. |
| MERCHANT_KYB_NOT_QUALIFIED | F | The merchant's KYB failed or KYB level is not high enough. |
| MERCHANT_NOT_REGISTERED | F | The merchant is not registered. |
| ORDER_IS_CLOSED | F | The order is closed. |
| PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. |
| 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. Do not retry. |
| RISK_REJECT | F | The request is rejected because of the risk control. |
| PAYMENT_IN_PROCESS | U | The payment is being processed. |