Use the pay API to initiate a payment to Alipay and process payment results according to the status and operation instructions returned by Alipay.  

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 gives additional information about other parameters. See the following parameters for details:

• productCode:
The value of this parameter is the payment product that the merchant uses for collecting payments, based on the contract between the merchant and Alipay. When the merchant can use multiple products, this parameter is required.

• order:
The order parameter contains order information, such as Merchant, Goods, logistic, and purchase environment. During the payment process, the order information is mainly used by Alipay for risk control or anti-money laundering. After the payment is completed, the information is used to display consumption records, regulatory reporting, and other purposes. However, Alipay does not verify the consistency of the amount in order and the amount in the payment request. The order information is not applied in fund operations either. Use the env field if the risk control capability provided by Alipay is needed.
In this case, order.merchant.referenceMechantId, order.merchant.merchantMCC, order.merchant.store.referenceStoreId, and order.merchant.store.storeMCC are mandatory. It is recommended to specify order.env.storeTerminalRequestTime and order.env.storeTerminalId.

• paymentMethod:
The value of paymentMethod is CONNECT_WALLET, indicating that Alipay collects money from the user's payment code that was generated by Alipay.

• paymentMethodId:
The unique identifier of the user's payment asset, which can be obtained by using the applyToken interface. For User-Presented Mode payments, this field is required and can be used by the merchant to decide which payment service should be called to process the payment. See Payment Code Specification for more information.

• paymentExpiryTime:
The payment executor must ensure that the payment will not succeed after the expiration time. If this parameter is not specified in the request, the expiration time is then decided by the payment executor.

• paymentFactor:
The value of paymentFactor.inStorePaymentScenario is PaymentCode, indicating that the payment code is used for payment. 

• authExpiredTime:
If the value of this field is true, a specific value is returned.

Payment code specifications

An Alipay payment code is a number that is between 16 to 24 digits and starts with a number ranging from 25 to 30.

For user-presented code payments, use the following rules to determine which payment service is to be called：

• If an Alipay payment code is used for payment, the merchant needs to route the payment to Alipay.
• If a non-Alipay payment code is used for payment, the merchant needs to route the payment to the corresponding payment provider of the non-Alipay payment code.
• If a merchant that is integrated with Alipay has integrated with other local wallets that provide payment codes conforming to Alipay payment code rule, for example, the Macao Wallet, or the PayPay wallet, the merchant needs to route the payment to the local wallet system when payment codes from such local wallets are used, or to route the payment to Alipay when Alipay payment codes are used. To determine the payment code belongs to Alipay or the local wallet, use the following rules: 

Asia

Result process logic

After calling a pay interface, the following results might be returned from Alipay or no result is received by the merchant:

• Alipay returns that result.resultStatus is S, which indicates the transaction succeeds and the money is deducted successfully.
• Alipay returns that result.resultStatus is F, the merchant needs to take further actions according to the error message in result.resultCode.
• Alipay returns that result.resultStatus is U, the merchant needs to use the inquiryPayment interface to inquire the payment result. The inquiry request can be sent 10 to 20 times, with an interval of 3 seconds.
• If no asynchronous notification and payment result are returned from Alipay within 5 seconds after the payment request is sent, the merchant needs to use the inquiryPayment interface to inquire the payment result. The inquiry request can be sent 10 to 20 times, with an interval of 3 seconds.
• When calling the inquiryPayment interfaces, if no payment result can be obtained after the inquiry requests being sent more than the maximum number of times, the merchant needs to call the cancel interface to cancel the transaction. If being out of the cancellable period, the merchant cannot use the cancel interface to cancel the transaction. The merchant can call the refund interface to make a refund instead. 

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