inquiryRegistrationStatus
Use this 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:
- Maximum length: 64 characters
registrationRequestId String
The unique ID that is used to identify a registration request.
More information:
- Maximum length: 64 characters
Response parameters
result Result REQUIRED
The request result contains information such as status and error codes.
registrationResult RegistrationResult
The registration result information from the wallet.
pspRegistrationResultList Array<PSPRegistrationResult>
The registration result from the Alipay+ payment methods (Alipay+ Mobile Payment Provider).
Request
Response
More information
See the following list for important details on the main parameter:
- 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.
The wallet status returned is APPROVED
and the registration status is COMPLETED
.
The wallet status returned is null and the registration status is COMPLETED.
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
Code | Value | Message | Further action |
---|---|---|---|
SUCCESS | S | Success | The registration is successful, no further action is needed. |
INVALID_CLIENT | F | The client is invalid. | Check whether the client ID is correct. |
MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | Check whether the media type is correct. |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Check whether the HTTP method is correct. |
REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | Change registrationRequestId and call the interface again. |
RECORD_NOT_FOUND | F | The 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. |