notifyRegistrationStatusAlipay+ → ACQP
The notifyRegistrationStatus API is used by Alipay+ to notify the Acquiring Service Provider (ACQP) of the merchant registration result. Each time Alipay+ receives a notification from the Mobile Payment Provider (MPP), Alipay+ will notify the ACQP of the registration status.
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
referenceMerchantId String REQUIRED
The unique ID that is assigned by the ACQP to identify a merchant.
More information:
- Maximum length: 32 characters
referenceStoreId String REQUIRED
The unique ID that is assigned by the ACQP to identify a store, which is affiliated with the merchant.
More information:
- Maximum length: 32 characters
registrationResult RegistrationResult object REQUIRED
The collective registration result of all the MPPs to be registered to for each of the unique pair of referenceMerchantId and referenceStoreId.
pspRegistrationResultList Array<PSPRegistrationResult> object
The list of individual registration results of all the MPPs to be registered to.
This parameter is specified by Alipay+ if at least one MPP has updated its registration status.
More information:
- Maximum size: Unlimited
registrationRequestId String
The unique ID that is assigned by the ACQP to identify a registration request.
More information:
- Maximum length: 64 characters
Response parameters
result Result object REQUIRED
The result of the business processing, including the result status, result code, and the result message.
Request
Response
More information
How to return the result
The ACQP needs to return the result (specified in the result parameter) according to the business processing result.
- If you received the notification successfully, set the value of result.resultStatus to
Sand the value of result.resultCode toSUCCESS. - If you failed to receive the notification, set the value of result.resultStatus to
ForUand specify the value of result.resultCode according to the failure reason. Alipay+ takes the notification delivery as unsuccessful and retries sending the notification up to 7 times. The intervals between two consecutive times are as follows: 2min, 10min, 10min, 1h, 2h, 6h, and 15h. Note that Alipay+ does not retry to send the notification if you test Alipay+ APIs in the sandbox environment.
For more information about how to define your result codes, see the Result codes section below.
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. |