Use the inquiryPayment API to query for information about a previously submitted payment request or accept the asynchronous processing results for a payment.

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
• Response header

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

More information 

This section provides additional information about key 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 unknown exceptions or timeouts, the merchant can only use paymentRequestId to query the payment result.
• If the cancel interface calling returns unknown exceptions or timeouts, the merchant can use either paymentId or paymentRequestId of the original payment to query the cancel result.
• If the refund interface calling returnes unknown exceptions or timeouts, the merchant can use either paymentId or paymentRequestId of the original payment to query the refund result. But using refundRequestId is not supported. 

Responses for different cases

Different responses are returned for different transaction statuses. The following responses are typical results returned by inquiryPayment interface for Cashier Payment and Auto Debit.

1. The transaction was canceled after being paid.

If the transaction was paid, the paymentTime field is returned, which is the time when the payment is completed before. The responses are the same for Cashier Payment and Auto Debit.

2. The transaction was partially or fully refunded.

If the transaction was partially or fully refunded, the transactions field is returned, which records the refund information. The responses are the same for Cashier Payment and Auto Debit.

The following example shows a sample code for a partially refunded transaction:

The following example shows a sample code for a fully refunded transaction:

3. The order doesn't exist.

This is a typical case for Cashier Payment. The following example shows a sample code of this case for Cashier Payment:

4. The transaction was not paid

This is a typical case for Cashier Payment. The following example shows a sample code of this case for Cashier Payment:

5. The transaction was canceled and not paid.

This is a typical case for Cashier Payment. The following example shows a sample code of this case for Cashier Payment:

6. The transaction was not paid and closed for timeout.

This is a typical case for Cashier Payment. The following example shows a sample code of this case for Cashier Payment: 

7. Payment was failed for the insufficiency of the buyer's balance.

This is a typical case for Auto Debit. The following example shows a sample code of this case for Auto Debit:

8. Exceeds the buyer's payment limit.

This is a typical case for Auto Debit. The following example shows a sample code of this case for Auto Debit: 

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. 

Error codes

Error codes are usually classified into the following categories:

• Common error codes: common for all online and in-store payment APIs.
• API-specific error codes: listed in the following table.  

Result/Error codes