register
The register API is used by the marketplace to help its sub-merchants register with Antom. When this API is called successfully, Antom will process the sub-merchant registration asynchronously. The marketplace can get the registration result through the notifyRegistration API.
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
registrationRequestId String REQUIRED
The unique ID that is assigned by the marketplace to identify a registration request. Alipay uses this field for idempotence control.
More information:
- This field is an API idempotency field.For registration requests that are initiated with the same value of registrationRequestId and reach a final status (resultStatus = S or F), the same result is to be returned for the request.
- Maximum length: 64 characters
settlementInfos Array <SettlementInfo> REQUIRED
The list of sub-merchants' settlement information. One settlement currency corresponds to one settlement bank account.
More information:
- Maximum size: 10 elements
merchantInfo MerchantInfo REQUIRED
The information about the sub-merchant.
paymentMethods Array<PaymentMethod> REQUIRED
The payment method that is used to collect the payment by the merchant or acquirer. The payment method must be already supportd by the platform merchant before they can be assigned for sub-merchants.
More information:
- Maximum length: 100 characters
Response parameters
result Result
The request result, which contains information such as status and error codes.
registrationStatus String
The registration status of the merchant. The value of this parameter is fixed to PROCESSING.
Get the sub-merchant's registration result from the notifyRegistration interface.
This parameter is returned when the value of result.resultStatus is S.
More information:
- Maximum length: 64 characters
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | The application for sub-merchant registration is successful. Get the sub-merchant's registration result from the notifyRegistration interface. |
| ACCESS_DENIED | F | Access is denied. | Contact Alipay Technical Support for detailed reasons. |
| INVALID_API | F | The called API is invalid or not active. | Contact Alipay Technical Support to resolve the issue. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Contact Alipay Technical Support for detailed reasons. |
| KEY_NOT_FOUND | F | The 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. |
| PARAM_ILLEGAL | F | The 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. |
| PROCESS_FAIL | F | A 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_INCONSISTENT | F | The amount or currency is different from the previous request. | Ensure all the fields in the requests are the same or use a new request ID to call this interface again. |
| RISK_REJECT | F | The request is rejected because of the risk control. | Prompt the user that the request is rejected because the risk control failed. |
| SYSTEM_ERROR | F | A system error occurred. | Do not retry, and contact Alipay Technical Support for more details. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call this interface again to resolve the issue. If not resolved, contact Alipay Technical Support. |
| UNKNOWN_EXCEPTION | U | An API call has failed, which is caused by unknown reasons. | Call this interface again to resolve the issue. If the issue is not resolved, contact Alipay Technical Support. |