inquiryRegistrationInfo
Use the inquiryRegistrationInfo API to inquire a merchant's registration information. For successfully registered merchants, the latest merchant information is returned. If there are no successful registrations, only the request acceptance result will be returned.
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 REQUIRED
The secondary merchant ID that is assigned by the acquirer.
More information about this field
- Maximum length: 64 characters
referenceStoreId String
The store ID assigned by the acquirer to identify a store, which 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.
merchantInfo MerchantRegistrationInfo object
The merchant information.
This parameter is returned when the value of result.resultStatus is S
.
storeInfo StoreRegistrationInfo object
Store information.
productCodes Array <String>
Product code. For in-store payments, the valid value of this field is:
productCodes: ["IN_STORE_PAYMENT"]
This parameter is returned when the value of result.resultStatus is S
.
Request
Response
Responses for different cases
This section provides responses for different cases of registration information inquiries.
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 clientId 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 referenceMerchantId 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. |