inquiryPayment
Use the inquiryPayment API to query for information about a previously submitted payment request or accept the asynchronous processing result for a payment.
Request parameters
paymentRequestId String
More information:
- Maximum length: 64 characters
paymentId String
More information:
- Maximum length: 64 characters
Response parameters
result Result
The request result contains information such as status and error codes.
Note: This field doesn't indicate the payment result. This field only indicates whether the inquiryPayment interface is called successfully.
paymentStatus String
Indicates the final status of Alipay payment. Valid values are:
- SUCCESS: Indicates the transaction is successful.
- FAIL: Indicates the transaction is failed.
- PROCESSING: Indicates the transaction is under processing.
- CANCELLED: Indicates the transaction is canceled.
paymentResultCode String
More information:
- Maximum length: 64 characters
paymentResultMessage String
More information:
- Maximum length: 64 characters
paymentRequestId String
More information:
- Maximum length: 64 characters
paymentId String
More information:
- Maximum length: 64 characters
paymentAmount Amount REQUIRED
The payment amount that the merchant requests to receive in the order currency.
authExpiryTime Datetime
Authorization expiration time, which follows the ISO 8601 standard.
paymentCreateTime Datetime
The date and time when the payment is created, which follows the ISO 8601 standard.
paymentTime Datetime
The date and time when the payment reaches a final state of success or failure, which follows the ISO 8601 standard.
pspCustomerInfo PspCustomerInfo
PMP customer information.
Note: PMP, payment method provider, is an organization that processes payment services and other value-added services on behalf of the payer.
redirectActionForm RedirectActionForm
Provides information about the redirection action.
transactions Array<Transaction>
Information about the transaction
grossSettlementAmount Amount
The total settlement amount, which equals to the transaction amount multiplied by the value of settlementQuote.
Note: This field is empty when the settlement currency is the same as the transaction currency.
settlementQuote Quote
The exchange rate between the settlement currency and transaction currency at the time of the transaction, which is provided only in the locked-in rate case.
Note: This field is empty when the settlement currency is the same as the transaction currency.
Request
Response
More information
This section provides additional information about other parameters. See the following list for details:
- paymentTime:
The successful execution time of this payment by Alipay, that is, the date and time when the payment reaches a final state of success or failure. This value is used as the start time of the subsequent revocable and refundable time. For example, if the refundable time is 6 months, the final time to accept the refund is paymentTime plus 6 months. - paymentId:
The unique payment processing ID. For polling the same payment, this field must be unique; for polling different payments, this field must be different. This value can be used for further actions like inquiry, cancellation, or refund. - paymentRequestId or paymentId:
To decide when to use paymentRequestId or paymentId, follow these rules: - If the pay interface calling returns successfully, the merchant can use the paymentId or paymentRequestId to query the original payment.
- If the pay interface calling returns an unknown exception or times out, the merchant can only use paymentRequestId to query the payment result.
- If the cancel interface calling returns an unknown exception or times out, the merchant can use either paymentId or paymentRequestId of the original payment to query the cancel result.
- If the refund interface calling returns an unknown exception or times out, the merchant can use either paymentId or paymentRequestId of the original payment to query the refund result. But using refundRequestId is not supported.
Result process logic
For different request results, different actions are to be performed. See the following list for details:
- If the value of result.resultStatus is
S, payment result inquiry succeeds. - If the value of result.resultStatus is
F, payment inquiry fails. - If the value of result.resultStatus is
U, then the request result is unknown. Use the same request parameters to retry the inquiry request.
Result/Error codes
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| ORDER_NOT_EXIST | F | The order does not exist. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. |
| KEY_NOT_FOUND | F | The key is not found. |
| ACCESS_DENIED | F | Access denied |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. |
| API_INVALID | F | API is invalid or not active. |
| CLIENT_INVALID | F | The client is invalid. |
| INVALID_SIGNATURE | F | The signature is invalid. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. |
| MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. |
| UNKNOWN_EXCEPTION | U | An API call failed due to unknown reasons. |
| USER_KYC_NOT_QUALIFIED | F | Payment failed because of the user's KYC status. The user is either not KYC compliant, or the KYC status is not qualified for this transaction (for example, limitations on the payment amount or product information). |