Alipay+ DocsAlipay+ Docs

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 about this field

  • Maximum length: 64 characters

pspId string  REQUIRED

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

More information about this field

  • Maximum length: 64 characters

codeValue string  REQUIRED

The code value that the user scans.

More information about this field

  • Maximum length: 512 characters

paymentId String  REQUIRED

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

More information about this field

  • 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 about this field

  • Maximum length: 64 characters

Response parameters

result Result object 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.

Show child parameters

paymentResult Result object 

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.

Show child parameters

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 about this field

  • 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 about this field

  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
API Explorer
Sample CodesRun in Sandbox

Request

URL
Request Body

Response

Response Body

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

CodeValueMessage
SUCCESSSSuccess
ACCESS_DENIEDFAccess is denied.
INVALID_CLIENTFThe client is invalid.
INVALID_SIGNATUREFThe signature is invalid.
KEY_NOT_FOUNDFThe key is not found.
MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.
METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTPS method.
NO_INTERFACE_DEFFAPI is not defined.
ORDER_NOT_EXISTFThe order doesn't exist.
PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.
PROCESS_FAILFA general business failure occurred. Do not retry.
REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.
UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.

Payment result codes

CodeValueMessage
SUCCESSSSuccess
BUSINESS_NOT_SUPPORTFThe payment business is not supported.
CURRENCY_NOT_SUPPORTFThe currency is not supported.
EXPIRED_CODEFThe code is expired.
INVALID_CODEFThe code is invalid.
INVALID_CONTRACTFThe contract is invalid.
INVALID_MERCHANT_STATUSFThe merchant status is abnormal due to restrictions, for example, the merchant's operation has been suspended.
MERCHANT_KYB_NOT_QUALIFIEDFThe merchant's KYB failed or KYB level is not high enough.
MERCHANT_NOT_REGISTEREDFThe merchant is not registered.
ORDER_IS_CLOSEDFThe order is closed.
PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.
PAYMENT_AMOUNT_EXCEED_LIMITFThe payment amount exceeds the limit that is specified by Alipay+.
PAYMENT_COUNT_EXCEED_LIMITFThe number of payments exceeds the limit.
PROCESS_FAILFA general business failure occurred. Do not retry.
RISK_REJECTFThe request is rejected because of the risk control.
PAYMENT_IN_PROCESSUThe payment is being processed.