registration
Use the registration API to register a secondary merchant with Alipay.
Request parameters
registrationRequestId String REQUIRED
The unique ID used to identify a registration request.
More information:
- Maximum length: 64 characters
registrationNotifyUrl Url
The URL provided by a merchant to receive the registration notification.
passThroughInfo String
A key-value structure that is only used for site transparent data transmission.
More information:
- Maximum length: 2048 characters
merchantInfo MerchantRegistrationInfo REQUIRED
Merchant information
productCodes Array<ProductCodeType> REQUIRED
Product code. For in-store payments, the valid value of ProductCodeType is:
productCodes: ["IN_STORE_PAYMENT"]
storeInfo StoreRegistrationInfo
Store information
Response parameters
result Result REQUIRED
The request result, which contains information related to the request result, such as status and error codes.
passThroughInfo String
A key-value structure that is only used for site transparent data transmission.
More information:
- Maximum length: 2048 characters
API Explorer
Request
URL
Request Body
Response
Response Body
More information
See the following list for important details on main parameters:
- For a secondary merchant registration request, merchantId and referanceMerchantId must be globally unique for in-store payments. If the registration is repeated, an error of
REPEAT_REGISTRATIONis returned. - If the type of field is Enum, the value of field must be a value within the specified range of Enum. For example, attachmentType, contactType, registrationType, businessType and productCodes are of the enum type. If the value passed in is outside Enum, an error of
PARAM_ILLEGALis returned. - If the Mandatory field is not passed in, an error of
PARAM_ILLEGALis returned. - storeInfo is only required when the productCodes is
IN_STORE_PAYMENT. An error ofPARAM_ILLEGALis returned if storeInfo is not passed in. - For String type fields, if the parameter length exceeds the specified maximum length or is less than the minimum length, an error of
PARAM_ILLEGALis returned. - The
urlof website must be a valid URL, otherwise an error ofPARAM_ILLEGALis returned. - The address must be an address that can be recognized by Google Maps.
- merchantInfo.registrationDetail.attachments.file must be a URL that a file can download.
- For merchantInfo.merchantMCC values, see MCC List for details.
Result/Error codes
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| ACCESS_DENIED | F | The access is denied. |
| INVALID_API | F | The called API is invalid or not active. |
| 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 HTTP method. |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. |
| PROCESS_FAIL | F | A general business failure has occurred. Do not retry. |
| REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. |
| REGISTRATION_UNDER_REVIEW | F | A previously submitted registration is currently under review. No new registration or modification is allowed. |
| REPEAT_REGISTRATION | F | Repeated registration for merchant |
| RECORD_NOT_FOUND | F | The system is not able to find the registration record for the given referenceMerchantId and/or referenceStoreId. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. |
| UNKNOWN_EXCEPTION | U | An API call failed due to unknown reasons. |