# inquiryRegistrationStatus `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: - [Request header](api_overview.md#3mLq0) - [Response header](api_overview.md#YdmVS) **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: - 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: - 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 about when to specify this parameter, see _How to specify request parameters_. More information: - Maximum length: 64 characters ## Response parameters #### result (Result, 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+. ##### resultCode (String, REQUIRED) The result code that indicates the detailed processing result. More information: - Maximum length: 64 characters ##### resultStatus (String, REQUIRED) The result status that indicates the processing result. Valid values are: - `S`: Successful - `F`: Failed - `U`: Unknown ##### resultMessage (String) The result message that describes the result code in detail. More information: - Maximum length: 256 characters #### registrationResult (RegistrationResult) The collective registration result of all the Mobile Payment Providers (MPPs) to be registered to. This parameter is returned by Alipay+ if _result.resultStatus_ is `S`. ##### registrationStatus (String, REQUIRED) The registration status that reflects whether all the MPPs to be registered to have returned the registration result. Valid values are: - `COMPLETED`: indicates that all the MPPs have returned the registration result. - `PENDING`: indicates that at least one MPP has not returned the registration result. The ACQP can check the value of _pspResgitrationResultList_ for the registration status of each MPP. **Important**: When you submit a new registration request by specifying the same _referenceMerchantId_, and the last registration request is in the `PENDING` status, depending on whether the last registration request exceeds 30 minutes, different actions are performed: - If the last registration request exceeds 30 minutes, the last registration request is canceled and the information that is submitted in the new registration request overwrites the one that is submitted in the last registration request. - If the last registration request does not exceed 30 minutes, the new registration request is rejected. #### pspRegistrationResultList (Array) 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`. ##### pspName (String, REQUIRED) The MPP's name. View [MPP Capabilities](../mpp_list/mpp_capabilities) for a complete list of valid values. ##### registrationResult (RegistrationResult) The registration result from a certain MPP. ###### registrationStatus (String, REQUIRED) The registration status that reflects the registration result of a specific MPP to be registered. - `PENDING`: indicates that the MPP has not returned the registration result. - `CANCELLED`: indicates that the registration is canceled by the MPP. - `APPROVED`: indicates that the registration is approved by the MPP. - `REJECTED`: indicates that the registration is rejected by the MPP. ###### rejectionReason (string) The reason why the MPP rejected the merchant registration. This parameter is returned by Alipay+ if _pspRegistrationResultList.registrationResult.registrationStatus_ is `REJECTED`. More information: - Maximum length: 1024 characters ##### productCodes (Array, 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](../product_intro_acq/product_cashier_acq_tile). - `AGREEMENT_PAYMENT`: indicates the Auto Debit product. For more information, see [Auto Debit](../product_intro_acq/product_debit_acq_tile). - `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](../product_intro_acq/product_upm_acq) and [Merchant-presented Mode Payment](../product_intro_acq/product_mpm_acq). ## 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. | ## Request ```json { "referenceMerchantId": "2188120000190000" } ``` ## Response ```json { "result": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "Success" }, "registrationResult": { "registrationStatus": "COMPLETED" }, "pspRegistrationResultList": [ { "productCodes": [ "CASHIER_PAYMENT" ], "pspName": "ALIPAY_HK", "registrationResult": { "registrationStatus": "APPROVED" } }, { "productCodes": [ "CASHIER_PAYMENT" ], "pspName": "KAKAOPAY", "registrationResult": { "registrationStatus": "REJECTED", "rejectionReason": "rejectionReason message" } } ] } ```