pay (Cashier Payment)ACQP → Alipay+
The pay API is used by the Acquiring Service Provider (ACQP) to send a request to Alipay+ to place orders.
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
order Order REQUIRED
The order details that are agreed upon by the buyer and the merchant, including the information about the buyer, the merchant, the goods, the initial order amount, and so on. The order details are displayed in purchase records and used for risk and regulatory reporting.
Specify the following child parameter apart from the required child parameters:
- env.terminalType
- If the value of this parameter is set to
WEB
,WAP
, orAPP
, paymentMethod.paymentMethodType must be set toCONNECT_WALLET
. - If the value of this parameter is set to
MINI_APP
, paymentMethod.paymentMethodType must be set to the wallet that hosts the mini program. - env.osType if the value of the env.terminalType parameter is
APP
orWAP
It is recommended to specify the following child parameter:
- buyer.referenceBuyerId
paymentRequestId String REQUIRED
The unique ID that is assigned by the ACQP to identify a payment order.
More information:
- This field is an API idempotency field.For requests that are initiated with the same paymentRequestId, Alipay+ regards the requests as repeated and processes the requests only once. Alipay+ checks the consistency of the following key request parameters: paymentAmount, paymentMethod.paymentMethodType, and order.orderAmount. If any of their values is different from that in the previous request, Alipay+ returns the REPEAT_REQ_INCONSISTENT result code.
- Maximum length: 64 characters
paymentAmount Amount REQUIRED
The amount that the ACQP requests to receive from Alipay+. The currency of the amount must be specified to the one that the ACQP uses to create the payment order.
Important:
- The paymentAmount and settlementStrategy parameters jointly affect the amount that Alipay+ settles to the ACQP (which is returned as the settlementAmount parameter) in the following ways:
- If the payment currency (specified on the paymentAmount.currency parameter), also known as transaction currency, is the same as the settlement currency (specified on the settlementStrategy.settlementCurrency parameter), the settlement amount is the same as the payment amount (specified on the paymentAmount.value parameter).
- If the payment currency (specified on the paymentAmount.currency parameter) is different from the settlement currency (specified on the settlementStrategy.settlementCurrency parameter), the settlement amount is calculated based on the payment amount (specified on the paymentAmount.value parameter) and the exchange rate between the settlement currency and payment currency.
- When you specify the paymentAmount parameter, ensure that the settlement amount is no less than the smallest amount in the settlement currency; otherwise, the API call fails.
paymentMethod PaymentMethod REQUIRED
The payment method that is used to collect the payment.
Specify the following child parameter as follows:
- If the value of the order.env.terminalType parameter is
WEB
,WAP
, orAPP
, paymentMethodType must be set toCONNECT_WALLET
. - If the value of the order.env.terminalType parameter is
MINI_APP
, paymentMethodType must be set to the wallet that hosts the mini program.
paymentFactor PaymentFactor REQUIRED
Factors that impact payment-related items such as service fee, interchange fee (also known as interpartner fee), and regulatory reporting. This parameter is used to identify the payment scenario.
Specify the following child parameters as follows:
- isInStorePayment: set the value to
false
- isCashierPayment: set the value to
true
- presentmentMode: set the value to
UNIFIED
paymentExpiryTime Datetime
The time after which the payment order is expired. If the payment order is not completed before the time that is specified for this parameter, Alipay+ closes the order and calls the notifyPayment API to notify the ACQP of the payment result.
Specify this parameter if the ACQP wants the payment order to be completed before a specific time. The default expiration time is 10 minutes. The specified expiration time must be shorter than the default expiration time; otherwise, the default expiration time takes effect instead of the specified expiration time.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
paymentNotifyUrl URL REQUIRED
The URL that is used to receive the payment result notification from Alipay+.
Important: For security reasons, The URL must be an HTTPS URL.
More information:
- Maximum length: 2048 characters
paymentRedirectUrl URL
The URL where the user is redirected from the MPP side to after the user proceeds with the payment order to a status of success, failure or unknown (for example, give up the payment order).
Specify this parameter if the user needs to be redirected from the MPP's payment result page to a predetermined page, for example, the merchant payment result page.
Important: The URL must use HTTPS instead of HTTP for security reasons or the URL can also be in the form of a URL scheme.
More information:
- Maximum length: 2048 characters
settlementStrategy SettlementStrategy
The settlement strategy that is applied to the payment order. For example, specify the currency that the ACQP wants to be settled against on this parameter.
Important: If the settlement currency is different from the payment currency that is specified on the paymentAmount.currency parameter, you must specify this parameter correctly; otherwise, you can
- set the value of this parameter to that of the paymentAmount.currency parameter.
- set the value of this parameter to
null
(without double quotation marks). - exclude this parameter from the request body.
In the latter case, the value of the paymentAmount.currency parameter is used as that of the settlementCurrency parameter.
userRegion String
This parameter is used to sort the payment method list in descending order based on the relevance between the MPP and the user region on the Alipay+ checkout page. The value of this parameter is a 2-letter country/region code according to ISO 3166 Country Codes.
Specify this parameter if the ACQP wants to sort the payment method list on the Alipay+ checkout page based on the user region.
More information:
- Maximum length: 2 characters
splitSettlementId String
The 16-digit, unique ID that is assigned by Alipay+ to the ACQP for multi-batch reconciliation. For each unique value of this parameter, Alipay+ performs a batch of clearing and settlement, and transfers a batch of funds to the ACQP's bank account.
Specify this parameter if the ACQP needs to split its settlement for transactions in one region and one currency into multiple batches.
More information:
- Maximum length: 16 characters
Response parameters
result Result REQUIRED
The result of the business processing, including the result status, result code, and result message. For more information about how to handle the result of the pay API, see How to handle the result.
acquirerId String
The unique ID that is assigned by Alipay+ to identify an ACQP.
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is PAYMENT_IN_PROCESS
, which means that the request is accepted.
More information:
- Maximum length: 64 characters
paymentId String
The unique ID that is assigned by Alipay+ to identify a payment order.
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is PAYMENT_IN_PROCESS
, which means that the request is accepted.
More information:
- Maximum length: 64 characters
normalUrl URL
The payment URL that redirects users to a WAP or Web page in the browser or in the WebView.
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is PAYMENT_IN_PROCESS
, which means that the request is accepted.
The auth client needs to trust all URLs returned by Alipay+, instead of adding them to the whitelist.
More information:
- Maximum length: 4096 characters
paymentAmount Amount
The amount that the ACQP requests to receive from Alipay+. The currency of the amount is the one that the ACQP uses to create the payment order.
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is PAYMENT_IN_PROCESS
, which means that the request is accepted.
paymentData String
The payment data that is used by the Alipay+ client SDK to render the checkout page.
This parameter is returned by Alipay+ if all the following conditions are met:
- the merchant app has integrated the Alipay+ client SDK
- the value of the order.env.terminalType parameter is
APP
- the value of the paymentMethod.paymentMethodType parameter is
CONNECT_WALLET
After receiving this parameter, the ACQP must send it to the merchant app so the app can call the showPaymentSheet API of the Alipay+ client SDK.
More information:
- Maximum length: 20000 characters
pspId String
The unique ID that is assigned by Alipay+ to identify an MPP.
This parameter is returned by Alipay+ if the value of the result.resultCode parameter is PAYMENT_IN_PROCESS
and the value of the paymentMethod.paymentMethodType parameter is not CONNECT_WALLET
.
More information:
- Maximum length: 64 characters
guideUrl string
The URL that redirects users to a page predefined by the MPP, such as a page for users to perform KYC verification, recharge, or bind cards. Please pay attention to this parameter when the value of paymentFactor.isPaymentEvaluation parameter is true
and the value of result.resultStatus is F
.
This parameter is returned by Alipay+ if the MPP returns it.
More information:
- Maximum length: 2048 characters
Request
Response
More information
How to handle the result
You might receive different results from Alipay+. Follow the instructions below to handle the result.
result.resultStatus | result.resultCode | Payment status | Actions |
|
| Payment fails. |
|
| Values other than
| Payment fails. | Take actions according to the result code (specified on the result.resultCode parameter). For more information, see the Result codes section below. |
|
| Payment is in processing. | Redirect the user to the Alipay+ checkout page to confirm the payment. |
| Values other than | Unknown. | Retry the same request. Ensure that the value specified on the paymentRequestId parameter is the same as the one specified in the previous request. |
No result received | Unknown. | Retry the same request. Ensure that the value specified on the paymentRequestId parameter is the same as the one specified in the previous request. |
Result/Error codes
Code | Value | Message | Further action |
---|---|---|---|
ACCESS_DENIED | F | Access is denied. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
BUSINESS_NOT_SUPPORT | F | The payment business is not supported. | Check whether the parameter values in the request message, for example, settlement currency, conform to the contract. If yes, it is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue; otherwise, correct the parameters to align with the contract. |
CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Ensure the currencies used in the request, such as transaction payment and settlement currency, conform to the contract. If the issue persists, it is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
INVALID_CLIENT | F | The client is invalid. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
INVALID_CONTRACT | F | The contract is invalid. | Check whether the parameter values in the request message, for example, settlement currency, conform to the contract. If yes, it is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue; otherwise, correct the parameters to align with the contract. |
INVALID_SIGNATURE | F | The signature is invalid. | Check whether the public key, signed message, and signature algorithm are as expected. |
KEY_NOT_FOUND | F | The key is not found. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | Use a media type that is accepted by Alipay+. |
MERCHANT_NOT_REGISTERED | F | The merchant is not registered. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTPS method. | Ensure the HTTP method is POST. |
NO_INTERFACE_DEF | F | API is not defined. | Check whether the request URL is correct. Ensure that the endpoint of the called API is correct. |
ORDER_IS_CLOSED | F | The order is closed. | Close the order at the ACQP side. |
PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. | Check whether the request parameters, including the header parameters and body parameters, are correct and valid. For more information about the parameters of each API, see the Structure section of the specific API reference topic. |
PAYMENT_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the limit that is specified by Alipay+. | It is recommended that you inform the user of the error. |
PAYMENT_AMOUNT_INVALID | F | Payment amount is invalid. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
PAYMENT_COUNT_EXCEED_LIMIT | F | The number of payments exceeds the limit. | Wait until the MPP server allows more requests. |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | Ensure that the values of the parameters in the repeated requests are the same. |
RISK_REJECT | F | The request is rejected because of the risk control. | It is recommended that you inform the user of the error. |
UNAVAILABLE_PAYMENT_METHOD | F | The payment method is unavailable. | It is recommended that you inform the user of the error. |
USER_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the payment limit that is specified by the user's digital wallet. | It is recommended that you inform the user of the error. |
USER_BALANCE_NOT_ENOUGH | F | The user balance is not enough for the payment. | It is recommended that you inform the user of the error. |
USER_KYC_NOT_QUALIFIED | F | User is not qualified for the KYC verification. | It is recommended that you inform the user of the error. |
USER_NOT_EXIST | F | The user does not exist. | It is recommended that you inform the user of the error. |
USER_PAYMENT_VERIFICATION_FAILED | F | User fails to pass the payment verification in the methods like OTP, PIN and so on. | It is recommended that you inform the user of the error. |
USER_STATUS_ABNORMAL | F | The user status is abnormal. | It is recommended that you inform the user of the error. |
PAYMENT_IN_PROCESS | U | The payment is being processed. | Redirect the user to the Alipay+ checkout page to confirm the payment. |
REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Reduce the frequency of API calls. |
UNKNOWN_EXCEPTION | U | An API call failed, which is caused by unknown reasons. | Try to recall the API. |