Alipay+Alipay+

inquiryRegistrationStatusACQP → Alipay+

POST /aps/api/v1/merchants/inquiryRegistrationStatus

The inquiryRegistrationStatus API is used by the Acquiring Service Provider (ACQP) to query the merchant registration status from Alipay+


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 unique ID that is assigned by the ACQP to identify a merchant.

Note: For more about when to specify this parameter, see How to specify request parameters

More information about this field:

  • Maximum length: 64 characters

referenceStoreId String  

The unique ID that is assigned by the ACQP to identify a store, which is affiliated with the merchant.

Note: For more about when to specify this parameter, see How to specify request parameters

More information about this field:

  • Maximum length: 32 characters

registrationRequestId String  

The unique ID that is assigned by the ACQP to identify a registration request.

Notes:

  • Required if referenceMerchantId and registrationRequestId are not specified.
  • For more about when to specify this parameter, see How to specify request parameters

More information about this field:

  • Maximum length: 64 characters

Response parameters

result Result object REQUIRED

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

Note: This parameter only indicates the request result, but does not indicate whether the registration is approved or not. For example, result.resultStatus is S only means the request is successfully sent and received by Alipay+. 

Show child parameters

registrationResult RegistrationResult object 

The collective registration result of all the Mobile Payment Partners (MPPs) to be registered to.

Note: Returned by Alipay+ if result.resultStatus is S

Show child parameters

pspRegistrationResultList Array<PSPRegistrationResult> object 

The list of individual registration results of all the MPPs to be registered to.

Note: Returned by Alipay+ if result.resultStatus is S

Show child parameters
API Explorer
Sample CodesRun in Sandbox

Request

URL
Request Body

Response

Response Body

More information

How to specify request parameters

When specifying the request parameters, the ACQP needs to take the following things into consideration:

  • It is recommended that you specify registrationRequestId to query the registration status regardless of whether the merchant supports online payments, in-store payments, or both. Note that do not specify referenceStoreId for the merchant that supports only online payments.
    • For the merchant that supports only in-store payments, you can specify either registrationRequestId or a combination of referenceMerchantId and referenceStoreId to query the registration status.
    • For the merchant that supports only online payments, you can specify either registrationRequestId or referenceMercahntID to query the registration status.
  • If only registrationRequestId is specified, the result of the corresponding registration request is returned. 
  • If only referenceMerchantId is specified, the registration information of the corresponding online merchant is returned.
  • If both referenceMerchantId and referenceStoreId are specified, the registration information of the corresponding in-store merchant is returned.
  • registrationRequestId takes precedence over referenceMerchantId and referenceStoreId. When registrationRequestId and one or both of referenceMerchantId and referenceStoreId are specified, registrationRequestId is used to do the inquiry.
  • When you use referenceMerchantId to inquire, the latest registration status is returned. For example, for a successful merchant registration, the value of pspRegistrationResultList.registrationResult.registrationStatus will be returned as APPROVED. After that, if the merchant registration information is modified and is submitted for registration again, when registration is still in process and you use the same referenceMerchantId to inquire, the value of pspRegistrationResultList.registrationResult.registrationStatus will be returned asPENDING

How to handle the response

When handling the response, the ACQPneeds to note that the merchant registration at a specific MPP is successful only when:

  • the value of result.resultCode is SUCCESS, and
  • the value of pspRegistrationResultList.registrationResult.registrationStatus of the MPP is APPROVED

Samples

The following three cases illustrate how to specify request parameters and shows examples of the registration statuses that are returned by different MPPs. 

Case 1

Request: The ACQP specifies the referenceMerchantId parameter for inquiry.

Sample Code

Response: Alipay+ returns the registration status to the ACQP. 

Sample Code

Case 2

Request: The ACQP specifies the referenceMerchantId and referenceStoreId parameters for inquiry. 

Sample Code

Response: Alipay+ returns the registration status to the ACQP. 

Sample Code

Case 3

Request: The ACQP specifies the registrationRequestId parameter for inquiry. 

Sample Code

Response: Alipay+ returns the registration status to the ACQP. 

Sample Code

Result

Result codes are usually classified into the following categories:

  • Common result codes: are common across all APS APIs for Acquiring Partners.  
  • API-specific result codes: are listed in the following table.

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

N/A

ACCESS_DENIEDFAccess is denied.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. 

INVALID_CLIENTFThe client is invalid.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. 

INVALID_SIGNATUREFThe signature is invalid.

Check whether the public key, signed message, and signature algorithm are as expected. 

KEY_NOT_FOUNDFThe key is not found.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. 

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

Use a media type that is accepted by Alipay+. 

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTPS method.

Ensure the HTTP method is POST. 

NO_INTERFACE_DEFFAPI is not defined.

Check whether the request URL is correct. Ensure that the endpoint of the called API is correct. 

PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.

Check whether the request parameters, including the header parameters and body parameters, are correct and valid. For more information about the parameters of each API, see the Structure section of the specific API reference topic. 

PROCESS_FAILFA general business failure occurred. Do not retry.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. 

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

Check whether the values of the referenceMerchantId and referenceStoreId parameters are correct. If so, contact connect_support@service.alipay.com to troubleshoot the issue; otherwise, specify the parameter values correctly and call the API again. 

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

Reduce the frequency of API calls. 

UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.

Try to recall the API.