notifyPaymentAlipay+ → ACQP
The notifyPayment API is used by Alipay+ to notify the payment result to the Acquiring Service Provider (ACQP) after payment processing reaches a final state of success or failure.
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:
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
paymentResult Result REQUIRED
The result of the payment. See the Payment result codes table below for details.
paymentRequestId String REQUIRED
The unique ID that is assigned by the ACQP to identify a payment order.
More information:
- Maximum length: 64 characters
paymentId String
The unique ID that is assigned by Alipay+ to identify a payment order.
Note: This parameter is specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds; otherwise, this parameter may or may not be specified.
More information:
- Maximum length: 64 characters
acquirerId String REQUIRED
The unique ID that is assigned by Alipay+ to identify an ACQP.
More information:
- Maximum length: 64 characters
pspId String
The unique ID that is assigned by Alipay+ to identify an MPP.
Note: Specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
More information:
- Maximum length: 64 characters
customerId String
The unique ID that is assigned by Alipay+ to identify an MPP user.
Note: Specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S and the MPP provides a unique ID that identifies the user.
More information:
- Maximum length: 64 characters
walletBrandName String
The brand name of the MPP that is displayed to the customer.
Note: Specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
More information:
- Maximum length: 128 characters
paymentAmount Amount REQUIRED
The amount that the ACQP requests to receive from Alipay+. The currency of the amount is the same as the one that the ACQP uses to create the payment order.
Note: Specified if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
paymentTime Datetime
The date and time when the payment order reaches a final state.
Note: Specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
settlementAmount Amount
The gross amount that Alipay+ settles to the ACQP. If the settlement currency (specified on the settlementAmount.currency parameter) is the same as the payment currency (specified on the paymentAmount.currency parameter), the settlement amount is the same as the payment amount (specified on the paymentAmount.value parameter); otherwise, the settlement amount is calculated based on the paymentAmount and settlementQuote parameters.
Note: Specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
settlementQuote Quote
The exchange rate between the settlement currency (specified on the settlementAmount.currency parameter) and the payment currency (specified on the paymentAmount.currency parameter).
Note: Specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S and the settlement currency is different from the payment currency.
customsDeclarationAmount Amount
The maximum amount that is to be declared by the ACQP to customs. The currency of the amount is the currency used by the MPP's user. For example, if the user uses ALIPAY_CN to pay, the currency is CNY.
Note: Specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S and customs declaration is required by the MPP's local authority (for now this only includes the Chinese Mainland).
mppPaymentId String
The unique ID that is assigned by the MPP to identify a payment order.
This parameter is specified by Alipay+ if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
More information:
- Maximum length: 64 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 return the result of the notifyPayment API, see How to return the result.
Request
Response
More information
How to return the result
The MPP needs to return the result (specified on the result parameter) according to the business processing result.
If you received the notification successfully, set the value of result.resultStatus to S and return an HTTP status code of 200 to indicate that your server received the call. Otherwise, Alipay+ takes the notification delivery as unsuccessful and retries the notification sending up to 7 times. The intervals between two consecutive times are as follows: 2min, 10min, 10min, 1h, 2h, 6h, and 15h.
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| ACCESS_DENIED | F | Access is denied. | |
| INVALID_CLIENT | F | The client is invalid. | |
| INVALID_SIGNATURE | F | The signature is invalid. | |
| KEY_NOT_FOUND | F | The key is not found. | |
| MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTPS method. | |
| NO_INTERFACE_DEF | F | API is not defined. | |
| PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. |
|
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | |
| UNKNOWN_EXCEPTION | U | An API call failed, which is caused by unknown reasons. |
Payment result codes
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| BUSINESS_NOT_SUPPORT | F | The payment business is not supported. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. |
| EXPIRED_CODE | F | The code is expired. |
| INVALID_CONTRACT | F | The contract is invalid. |
| INVALID_TOKEN | F | The access token is invalid. |
| ORDER_IS_CLOSED | F | The order is closed. |
| PAYMENT_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the limit that is specified by <span>Alipay+</span>. |
| PAYMENT_COUNT_EXCEED_LIMIT | F | The number of payments exceeds the limit. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. |
| RISK_REJECT | F | The request is rejected because of the risk control. |
| UNAVAILABLE_PAYMENT_METHOD | F | The payment method is unavailable. |
| USER_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the payment limit that is specified by the user's digital wallet. |
| USER_BALANCE_NOT_ENOUGH | F | The user balance is not enough for the payment. |
| USER_NOT_EXIST | F | The user does not exist. |
| USER_STATUS_ABNORMAL | F | The user status is abnormal. |