Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

pay (Entry Code Payment)

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: 


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

Request parameters

productCode String  REQUIRED

The payment product that the merchant can use, based on the contract between the merchant and Alipay. For Entry Code Payment, the value is fixed as IN_STORE_PAYMENT.

paymentRequestId String  REQUIRED

The unique ID that is assigned by a merchant to identify a payment request. Alipay uses this field for idempotence control. 

More information about this field:

  • This field is an API idempotency field. Merchant uses the paymentRequestId field for idempotency control. For payment requests that are initiated with the same value of paymentRequestId and reach a final status (S or F), the same result is to be returned for the request.
  • Maximum length: 64 characters

order Order object REQUIRED

Order information, such as buyer information, merchant information, order description, and order amount. 

The parameter is also used for risk control, supervision, reporting, user payment result display, and so on.

Show child parameters

paymentAmount Amount object REQUIRED

The payment amount that the merchant requests to receive in the order currency.

Show child parameters

paymentMethod PaymentMethod object REQUIRED

The payment method that is used to collect the payment by the merchant or acquirer. 

Show child parameters

paymentExpiryTime Datetime  

The payment expiration time is a specific time after which the payment will expire. After the payment expiration time, the acquirer or merchant must terminate the order processing. A default payment expiration time is determined by the contract. If you want to use a payment expiration time that differs from the default time, specify this field. 

Note: Usually for User-Presented Mode Payment, the default payment expiration time in the contract is 3 minutes after the payment request is sent. For example, the request is sent when the time is 2019-11-27T12:00:01+08:30, the payment expiration time is 2019-11-27T12:03:01+08:30. 

More information about this field:

  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:30".

paymentRedirectUrl URL  

The URL that the user is redirected to after the payment is completed

More information about this field:

  • Maximum length: 2048 characters

paymentNotifyUrl URL  REQUIRED

The URL that is used to receive the payment result notification

More information about this field:

  • Maximum length: 2048 characters

paymentFactor PaymentFactor object 

Specifies the payment scenario

Show child parameters

settlementStrategy SettlementStrategy object 

The settlement strategy for the payment request.

Note: Specify this field when one of the following conditions are met:

  • Multiple settlement contracts are signed and more than one settlement contract supports this transaction. In this case, use this field to specify the settlement currency so that the settlement contract to be used for this transaction can be selected from all the signed settlement contracts.
  • When the value of paymentMethodType is CONNECT_WALLET.
Show child parameters

merchantRegion String  

The country or region where the merchant or secondary merchant operates the business. The 2-letter country/region code that follows ISO 3166 Country Codes standard. Only US, JP, PK, SG are supported now.

Note: This field is required when you use Alipay Global Gateway (GGW) product. 

More information about this field:

  • Maximum length: 2 characters

Response parameters

result Result object REQUIRED

The request result contains information such as status and error codes.

Show child parameters

paymentRequestId String  

The unique ID that is assigned by a merchant to identify a payment request. 

More information about this field:

  • Maximum length: 64 characters

paymentId String  

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

More information about this field:

  • Maximum length: 64 characters

paymentAmount Amount object 

The payment amount that the merchant requests to receive in the order currency.

Show child parameters

paymentTime Datetime  

The date and time when the payment reaches a final state of success or failure. 

More information about this field:

  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:30".

paymentCreateTime Datetime  

The date and time when the payment is created.

More information about this field:

  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:30".

pspCustomerInfo PspCustomerInfo object 

The customer information of Alipay+ MPP .

Note: Alipay+ Mobile Payment Partner, is an organization that processes payment services and other value-added services on behalf of the payer. For online and in-store payments, an Alipay+ Mobile Payment Partner is a digital wallet, such as GCash. 

Show child parameters

challengeActionForm ChallengeActionForm object 

Provides information about the challenge action when the payment result is not in a final state of success or failure.

Show child parameters

redirectActionForm RedirectActionForm object 

Provides information about the redirection action.

Show child parameters

grossSettlementAmount Amount object 

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

Show child parameters

settlementQuote Quote object 

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.

Show child parameters
API Explorer

Request

Method
POST
Endpoint
/v1/payments/pay
Header
Accept: application/json
URL
https://<domain_name>/ams/api/<endpoint>
Domain name
North America: https://open-na.alipay.com
Asia: https://open-sea.alipay.com
Europe: https://open-eu.alipay.com
Request Body

Response

Response Body

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.

Sample for the order field

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

paymentExpiryTime:
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 EntryCode, indicating that Alipay needs to generate a redirection URL in this payment.

paymentId:
If this field is not returned in the response, you can use the paymentRequestId field to initiate inquiryPayment and cancel requests.

Result process logic

After calling a pay interface, the following results might be returned from Alipay:

  • Alipay returns that result.resultStatus is S, which indicates the merchant needs to initiate a redirection by using the parameters in a form to drive the payment process.
  • Alipay returns that result.resultStatus is F, the payment request fails.
  • Alipay returns that result.resultStatus is U, the merchant needs to call the pay interface again. 

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

The payment is successful, no further action is needed. 

ACCESS_DENIEDFAccess is denied.

Contact Alipay Technical Support for detailed reasons. 

API_INVALIDFThe API name or API call format is used incorrectly.

Check whether the API name, HTTP method, or request format is correct when sending the request. 

CLIENT_INVALIDFThe client ID is invalid. Alipay has restrictions on client ID.

Check whether the client ID is correct, or contact Alipay Technical Support for detailed reasons. 

CURRENCY_NOT_SUPPORT FThe currency is not supported.

Contact Alipay Technical Support for detailed reasons. 

INVALID_CONTRACTFThe parameter values in the contract do not match those in the current transaction.

Check whether the parameter values in the contract match those in the current transaction. If the values match, contact Alipay Technical Support to troubleshoot the issue. 

INVALID_MERCHANT_STATUSFThe merchant status is abnormal because restrictions exist.

Contact Alipay Technical Support for detailed reasons. 

INVALID_SIGNATUREFThe signature is not validated. The private key used to sign a request does not match the public key of Alipay Developer Center.

Check whether the private key used to sign a request matches the public key of Alipay Developer Center. The following signature references are useful:

KEY_NOT_FOUNDFThe private key or public key of Alipay or the merchant is not found.

Check whether the private key or public key exists. If not, upload the private key in Alipay Developer Center. 

MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.

Check whether the media type is correct and use a media type that is accepted by Alipay. 

MERCHANT_KYB_NOT_QUALIFIEDFThe payment failed because of the merchant's KYB status. The merchant is either not KYB compliant, or the KYB status is not qualified for this transaction.

Contact Alipay Technical Support for detailed reasons. 

MERCHANT_NOT_REGISTEREDFThe merchant is not registered.

Please register the merchant by using the registration interface. Contact Alipay Technical Support if failed to call the registration interface. 

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method. Only the POST method is supported.

Ensure the HTTP method is POST. 

NO_INTERFACE_DEFFAPI is not defined.

Check whether the URL is correct. Please refer to the endpoint in the API documentation. 

NO_PAY_OPTIONSFThe currency is not supported for the transaction.

Check whether the currency is supported by the wallet, or check whether the wallet and currency are consistent with the contract. Contact Alipay Technical Support for detailed reasons. 

ORDER_IS_CANCELEDFThe request you initiated has the same paymentRequestId as the previously paid transaction, which is canceled.

Use a new paymentRequestId to initiate the payment again. 

ORDER_IS_CLOSEDFThe request you initiated has the same paymentRequestId as that of the existed transaction, which is closed.

Use a new paymentRequestId to initiate the payment again. 

PARAM_ILLEGALFThe required parameters are not passed, or illegal parameters exist. For example, a non-numeric input, an invalid date, or the length and type of the parameter are wrong.

Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid. 

PAYMENT_AMOUNT_EXCEED_LIMITFThe payment amount is greater than the maximum amount allowed by the contract or wallet.

Check whether the payment amount exceeds the limit or use a lower amount and try again. Contact Alipay technical support to know the specific limitation.  

PAYMENT_COUNT_EXCEED_LIMITFThe maximum number of payments exceeds the limit that is specified by the wallet.

Contact Alipay Technical Support to know the specific limitation.  

PAYMENT_NOT_QUALIFIEDFThe merchant is not qualified to pay because the merchant is not registered, does not have a contract for Auto Debit payment, or is forbidden to make a payment.

Contact Alipay Technical Support for detailed reasons. 

PROCESS_FAILFA general business failure occurred.

Do not retry. Human intervention is usually needed. It is recommended that you contact Alipay Technical Support to troubleshoot the issue. 

REPEAT_REQ_INCONSISTENTFThe amount or currency is different from the previous request.

Ensure all the fields in the requests are the same or use a new paymentRequestId to initiate the payment again. 

RISK_REJECTFThe request is rejected because of the risk control.

Prompt the user that the request is rejected because the risk control failed.  

SYSTEM_ERRORFA system error occurred.

Do not retry, and contact Alipay Technical Support for more details. 

USER_NOT_EXISTFThe user does not exist on the wallet side.

Contact Alipay Technical Support for detailed reasons. 

PAYMENT_IN_PROCESSUThe payment is being processed.

Use a new paymentRequestId to initiate the payment again. 

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support. 

UNKNOWN_EXCEPTIONUAn API call has failed, which is caused by unknown reasons.

Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support.