registration

POST /aps/api/v1/merchants/registration

The registration API is used by Alipay+ to register a new merchant or update an existing registration at the Mobile Payment Partner (MPP) side. For merchants that support online payments, the MPP receives the merchant information, while for merchants that support in-store payments, the MPP receives both the merchant information and the store information.

Note: In the following sections, MPP is also known as Payment Service Partner (PSP). For example, pspId refers to the unique 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

registrationRequestId String REQUIRED

The unique ID that is assigned by Alipay+ to identify a registration request.

More information about this field

This field is an API idempotency field.For requests that are initiated with the same registrationRequestId, the MPP needs to return the same result.
Maximum length: 64 characters

productCodes Array<String> REQUIRED

The list of product codes to specify the payment products that the merchant support. Valid values are:

CASHIER_PAYMENT: indicates the Cashier Payment product. For more information, see Cashier Payment.
AGREEMENT_PAYMENT: indicates the Auto Debit product. For more information, see Auto Debit.
IN_STORE_PAYMENT: indicates the in-store payment products, such as User-presented Mode Payment and Merchant-presented Mode Payment. For more information, see User-presented Mode Payment and Merchant-presented Mode Payment.

merchantInfo MerchantRegistrationInfo object REQUIRED

The merchant information for registration, including merchant category code and registration information.

Show child parameters

registrationNotifyUrl URL

The URL that is provided by the merchant to receive registration notifications from the MPP.

Note: Specified by Alipay+ if the information is passed by the merchant.

More information about this field

Maximum length: 2048 characters

passThroughInfo String

The information that is passed through by Alipay+ to the MPP. The value of this parameter is in a set of key-value pairs.

Note: Specified by Alipay+ if the ACQP wants to pass information to the MPP.

More information about this field

Maximum length: 20000 characters

Response parameters

result Result object REQUIRED

The result of the business processing, including the result status, result code, and the result message.

Show child parameters

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.

Note: Specify this parameter if the MPP wants to pass information to the ACQP.

More information about this field

Maximum length: 20000 characters

API Explorer

Request

Request Body

Response

Response Body

More information

When using this API, the MPP needs to take the following things into consideration:

For the registration request from the ACQP to Alipay+, the request is handled by the following rules:

If only a new MPP is added, the request will be accepted.
If the merchant or store information is modified, check where the existing registration request is still within SLA. When the SLA is exceeded, the new registration request can be accepted; otherwise, rejected.

For the registration request from Alipay+ to the MPP, the result code is returned by the following rules:

Only if the registration is successfully accepted and approved by the MPP, can SUCCESS be returned.
If the registration request is successfully accepted, but the registration is still under review, REGISTRATION_IN_PROCESS needs to be returned. This result code can only be used by MPPs who perform the Approval Mode, where MPPs notify Alipay+ of the registration result via the notifyRegistrationStatus API. For more information about what is Approval Mode, see Register a merchant.

Result/Error codes

Code	Value	Message
SUCCESS	S	The registration is successfully accepted and approved by the MPP.
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.
REGISTRATION_UNDER_REVIEW	F	A previously submitted registration is currently under review. No new registration or modification is allowed.
REPEAT_REGISTRATION	F	Registration for the merchant is repeated.
REGISTRATION_IN_PROCESS	U	The registration request is successfully accepted, but the registration result is unknown.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.
UNKNOWN_EXCEPTION	U	An API call failed, which is caused by unknown reasons.