notifyPaymentMPP → Alipay+
The notifyPayment API is used by the Mobile Payment Provider (MPP) to notify the payment result to Alipay+ when payment processing reaches a final state of success or failure.
Note: In the following sections, the Mobile Payment Provider (MPP) is also known as PSP. For example, pspId refers to 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
paymentResult Result object REQUIRED
The result of the payment. The value of the paymentResult.resultStatus parameter represents the payment status, where S represents success and F represents failure. The value of the paymentResult.resultStatus parameter cannot be U when this API is called to send the payment result. See the Payment result codes table for more details.
paymentRequestId String REQUIRED
The unique ID that is assigned by Alipay+ 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, paymentResult, paymentId, payToAmount, customerId, and customsDeclarationAmount. 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
paymentId String
The unique ID that is assigned by the MPP to identify a payment order.
Specify this parameter if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
More information:
- Maximum length: 64 characters
paymentAmount Amount object REQUIRED
The amount that Alipay+ requests to receive from the MPP. The currency of the amount must be specified to the one that Alipay+ uses to create the payment order. If a promotion exists, this amount does not include the promotion amount.
Specify this parameter if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
payToAmount Amount object
The amount that the MPP settles to Alipay+. The currency of the amount is the MPP's currency.
Specify this parameter if the value of the paymentResult.resultStatus parameter is S and payToAmount.currency is different from paymentAmount.currency. When this parameter is specified, payToAmount.value is calculated based on paymentAmount.value and paymentQuote.quotePrice by using the rounding mode of HALF EVEN.
paymentTime Datetime object
The date and time when the payment order reaches a final state.
Specify this parameter if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
customerId String
The unique ID that is assigned by the MPP to identify a user.
Specify this parameter if the value of the paymentResult.resultStatus parameter is S, which means that the payment succeeds.
More information:
- Maximum length: 64 characters
customsDeclarationAmount Amount object
The 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.
Specify this parameter 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).
passThroughInfo String
The information that is passed through by the MPP to Alipay+. The value of this parameter is in a set of key-value pairs.
Specify this parameter if the MPP wants to pass information to the ACQP.
More information:
- Maximum length: 20000 characters
Response parameters
result Result object 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 notifyPaymet 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 SUCCESS, which means that the notification succeeds.
More information:
- Maximum length: 64 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 SUCCESS, which means that the notification succeeds.
More information:
- Maximum length: 64 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 | Notification status | Actions |
|
| Notification succeeds. | N/A |
| Multiple possible values exist, such as
| Notification fails. | Take actions according to the result code (specified on the result.resultCode parameter). For more information, see Result codes section below. |
| Multiple possible values exist, such as
| Unknown. | Retry the same request. |
No result received | Unknown. | Retry the same request. | |
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | N/A |
| ACCESS_DENIED | F | Access is denied. | 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_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+. |
| 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. |
| 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. |
| 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. |
| 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. |
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. |
| MERCHANT_NOT_REGISTERED | F | The merchant is not registered. |
| 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. |
| REGULATION_RESTRICTION | F | The payment failed due to regulatory restriction. |
| 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_PAYMENT_VERIFICATION_FAILED | F | User fails to pass the payment verification in the methods like OPT, PIN, and so on. |
| USER_STATUS_ABNORMAL | F | The user status is abnormal. |