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:

1. Set the data type of each parameter (except array) as String. This means that you must use double quotation marks (" ") to enclose the parameter value. Examples:

If the data type of a parameter is Integer and its value is 20, set it as "20".
If the data type of a parameter is Boolean and its value is true, set it as "true".

2. For optional parameters that are not required in your case, you can:

exclude them from the request body.
set the values as null (without the double quotation marks).

Do NOT leave the optional parameters empty by setting their values as ""; otherwise, an error might occur.

Request parameters

referenceMerchantId String

The unique ID that is assigned by the ACQP to identify a merchant. For more about when to specify this parameter, see How to specify request parameters.

More information about this field

Maximum length: 32 characters

referenceStoreId String

The unique ID that is assigned by the ACQP to identify a store, which is affiliated with the merchant. 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.

Specify this parameter if referenceMerchantId and registrationRequestId are not specified. For more information, 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.

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.

This parameter is 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.

This parameter is 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

The ACQP needs to specify request parameters depending on the value of the productCodes parameter in the registration API. Refer to the table below for details.

Value of productCodes	Action
Contains only `CASHIER_PAYMENT`, `AGREEMENT_PAYMENT`, or both	Take either of the following actions: Specify registrationRequestId Specify referenceMerchantId
Contains only `IN_STORE_PAYMENT`	Take either of the following actions: Specify registrationRequestId Specify referenceMerchantId and referenceStoreId
Contains `IN_STORE_PAYMENT` and at least one of `CASHIER_PAYMENT` and `AGREEMENT_PAYMENT`

Important:

registrationRequestId takes precedence over referenceMerchantId and referenceStoreId. When registrationRequestId and one or both of referenceMerchantId and referenceStoreId are specified, registrationRequestId is used.
If registrationRequestId is used to inquire, Alipay+ returns the status of the corresponding registration request.
If registrationMechantId is used to inquire, Alipay+ returns the latest status of the registration request regarding the merchant. For example, for a successful merchant registration, the value of pspRegistrationResultList.registrationResult.registrationStatus is returned as APPROVED. After that, if the registration information is updated and still in review, the value of pspRegistrationResultList.registrationResult.registrationStatus is returned as PENDING.
It is recommended to specify registrationRequestId to query the registration status regardless of payment products that the merchant support.

How to handle the result

You might receive different results from Alipay+. Follow the instructions below to handle the result.

result.resultStatus	result.resultCode	Inquiry status	Actions
`S`	`SUCCESS`	Inquiry succeeds.	N/A
`F`	Multiple possible values exist, such as `ACCESS_DENIED`, `KEY_NOT_FOUND`, etc.	Inquiry fails.	Take actions according to the result code (specified on the result.resultCode parameter). For more information, see the Result codes section below.
`U`	Multiple possible values exist, such as `UNKNOWN_EXCEPTION`, `REQUEST_TRAFFIC_EXCEED_LIMIT`, etc.	Unknown	Use the same parameters to retry the inquiryRegistrationStatus request. If you keep receiving the same result indicating the unknown status, contact connect_support@service.alipay.com.
No result received		Unknown	Use the same parameters to retry the inquiryRegistrationStatus request. If you keep receiving no result, contact connect_support@service.alipay.com.

When handling the result, note that the merchant registration at a specificMPP is successful only when:

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

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success	N/A
ACCESS_DENIED	F	Access is denied.	It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.
INVALID_CLIENT	F	The client is invalid.	It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.
INVALID_SIGNATURE	F	The signature is invalid.	Check whether the public key, signed message, and signature algorithm are as expected.
KEY_NOT_FOUND	F	The key is not found.	It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.
MEDIA_TYPE_NOT_ACCEPTABLE	F	The server does not implement the media type that is acceptable to the client.	Use a media type that is accepted by Alipay+.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTPS method.	Ensure the HTTP method is POST.
NO_INTERFACE_DEF	F	API is not defined.	Check whether the request URL is correct. Ensure that the endpoint of the called API is correct.
PARAM_ILLEGAL	F	Illegal 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_FAIL	F	A general business failure occurred. Do not retry.	It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue.
RECORD_NOT_FOUND	F	The 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_LIMIT	U	The request traffic exceeds the limit.	Reduce the frequency of API calls.
UNKNOWN_EXCEPTION	U	An API call failed, which is caused by unknown reasons.	Try to recall the API.