Alipay+Alipay+

registration

Use this interface to register merchant information or update an existing registration. 

To properly identify a registration entity, merchantInfo.referenceMerchantId is required for online merchants, and both merchantInfo.referenceMerchantId and storeIfo.referenceStoreId are required for in-store merchants. 

Request parameters

registrationRequestId String  REQUIRED

The unique ID that is used to identify a registration request.  

More information about this field:

  • Maximum length: 64 characters

merchantInfo MerchantRegistrationInfo object REQUIRED

Merchant information.

Show child parameters

storeInfo StoreRegistrationInfo object 

Store information.

Note:

This field is required and valid only when the value of productCodes is IN_STORE_PAYMENT

Show child parameters

productCodes Array<String>  REQUIRED

The product code. See ProductCodeType for details.  

registrationNotifyUrl String  

The URL provided by the merchant to receive registration notification.  

passThroughInfo String  

Passthrough information in the set of key-value pairs that is transmitted between Acquirer and Alipay+. 

More information about this field:

  • Maximum length: 2048 characters

Response parameters

result Result  

passThroughInfo String  

Passthrough information in the set of key-value pairs that is transmitted between Alipay+ and participants. 

More information about this field:

  • Maximum length: 2048 characters
API Explorer

Request

Method
POST
Endpoint
/aps/api/v1/payments/registration
Header
Accept: application/json
URL
https://<domain_name>/ams/api/<endpoint>
Domain name
North America: https://open-na.alipay.com
Asia: https://open-sea.alipay.com
Europe: https://open-eu.alipay.com
Request Body

Response

Response Body

More information

When use this interface, pay attention to the following items:

  • Batch operations are not supported. Each time, only one merchant or store can be registered.
  • The result returned indicates the acceptance of the registration request.
  • If resultStatus is S, the registration request is successfully accepted.
  • If resultStatus is F, the registration request failed to be accepted, and you can check resultCode and resultMessage for more information.
  • If resultStatus is U, the system is busy and you can try again.
  • For the registration request from Accquirer to Alipay+, the request is handled by the following rules:
  • If the merchant or store information is modified, check where the existing registration request in still within SLA. When the SLA is exceeded, the new registration request can be accepted; otherwise, rejected.  

Sample

1. Acquirer sends a request to Alipay+ to register the merchant and store information for both in-store and online payments.  

Sample Code

2. Alipay+ returns the result to Acquirer. 

Sample Code

Result/Error codes

CodeValueMessage
SUCCESSSSuccess
PROCESS_FAILFIllegal parameters exist. For example, a non-numeric input, or an invalid date.
PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.
KEY_NOT_FOUNDFThe key is not found.
ACCESS_DENIEDFThe access is denied.
REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.
INVALID_APIFThe called API is invalid or not active.
INVALID_CLIENTFThe client is invalid.
INVALID_SIGNATUREFThe signature is invalid.
METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.
MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.
UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.
REGISTRATION_UNDER_REVIEWFA previously submitted registration is currently under review. No new registration or modification is allowed.
REPEAT_REGISTRATIONFRegistration for the merchant is repeated.
REPEAT_REQ_INCONSISTENTFRepeated requests are inconsistent.