inquiryRegistrationStatus

Use the inquiryRegistrationStatus API to query the registration status of a secondary merchant, by sending the secondary merchant's information or merchant registration request ID.

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

referenceMerchantId String  

The secondary merchant ID that is assigned by the acquirer. 

More information about this field:

  • Maximum length: 64 characters

registrationRequestId String  

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

More information about this field:

  • Maximum length: 64 characters

referenceStoreId String  

The store ID assigned by the acquirer to identify a store that is associated with the merchant. 

More information about this field:

  • Maximum length: 32 characters

Response parameters

result Result object REQUIRED

The request result contains information such as status and error codes.

Child parameters

registrationResult RegistrationResult object 

The registration result information from the wallet. 

Child parameters

pspRegistrationResultList Array<PSPRegistrationResult> object 

The registration result from Alipay+ MPP (Alipay+ Mobile Payment Partner).

Child parameters
API Explorer

Request

Method
POST
Endpoint
/v1/merchants/inquiryRegistrationStatus
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

See the following list for important details on the main parameter:

  • While registrationRequestId, referenceMerchantId, referenceStoreId are all optional, we recommend including referenceMerchantId or referenceStoreId.
  • Re-registration for the same secondary merchant is allowed if the information was reported incorrectly in the initial registration. When the request contains requestId, the registration result is returned. If there is no requestId but referenceMerchantId is in the request, the response returned is the status of all wallets of the current secondary merchant. 

Responses for different cases

This section provides responses for different cases of registration status inquiries.

PARAM_ILLEGAL

RECORD_NOT_FOUND

PENDING in the wallet side

REJECTED

The wallet status returned is APPROVED and the registration status is COMPLETED.

Sample Code

The wallet status returned is null and the registration status is COMPLETED.

Sample Code

Error codes

Error codes are usually classified into the following categories:

  • Common error codes: common for all online and in-store payment APIs.
  • API-specific error codes: listed in the following table.  

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

The registration is successful, no further action is needed.

INVALID_CLIENTFThe client is invalid.

Check whether the clientId is correct.

MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.

Check whether the media type is correct.

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

Check whether the HTTP method is correct.

REPEAT_REQ_INCONSISTENTFRepeated requests are inconsistent.

Change registrationRequestId and call the interface again.

RECORD_NOT_FOUNDFThe system is not able to find the registration record for the given referenceMerchantId and/or referenceStoreId.

The registration record is not found. Please check whether referenceMerchantId or referenceStoreId is correct.