Query store information

2023-07-21 09:20

POST: /amsin/api/v1/business/store/inquiryStore Signature required

Use this interface to obtain information of stores and the associated accounts.

Structure

A message consists of a header and body. For details, see the following sections.

Request header

Field	Required	Sample	Description
Client-Id	Yes	`Client-Id: *****`	For more information about these request header fields, see Request header.
Signature	Yes	`Signature: algorithm=RSA256, keyVersion=2, signature=*****`
Content-Type	Yes	`Content-Type: application/json; charset=UTF-8`
Request-Time	Yes	`Request-Time: 2019-04-04T12:08:56+08:00`
Access-Token	Conditional	`Access-Token: ******`	Attention to this field Required for OAUTH authorization.
Connected-CustomerId	Conditional	`Connected-CustomerId: *****`	Attention to this field Required when a partner manages a customer's account.

Request parameters

Field	Data type	Required	Description
pageSize	Integer	Yes	Defines the number of items on each page.
pageNumber	Integer	Yes	Defines the page index that contains statement information. Format: 1,2,3,...

Response parameters

Field	Data type	Required	Description
result	Result object	Yes	Indicates whether this API is called successfully.
Notes: The following parameters are returned on demands only when result.resultStatus = `S`
customerId	String	No	A unique id that is assigned by Zyla to identify an account on Zyla. More information: Maximum length: 64 characters
storeInformation	List<StoreInfo>	No	The store information.
totalCount	Integer	Yes	The total number of items in the query. More information: Maximum length: 8 characters
totalPageNumber	Integer	Yes	Number of the pages in total. More information: Maximum length: 8 characters
currentPageNumber	Integer	Yes	The currency page index number. More information: Maximum length: 8 characters

Result processing logic

After calling the API, a response is returned. The possible responses for result.resultStatus are:

Result status	Description
S	This indicates the API call succeeded.
F	This indicates the API call failed. For more information on why the call failed, see `result.resultCode`.
U	This indicates the API call result is unknown. Partner can make a query when the returned status is UNKNOWN. Use the following query strategy: A Partner can make 7 queries at maximum. Intervals between queries: 5m, 10m, 20m, 40m, 80m, 160m, and 320m. If none of the queries is successful, contact Zyla Technical Support.

Result codes

result.resultCode

resultCode	resultStatus	resultMessage	Further action
SUCCESS	S	Success
PROCESS_FAIL	F	A general business failure occurred. Do not retry.	Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue.
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	Check and verify whether the request fields, including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section.
KEY_NOT_FOUND	F	The key is not found.	Contact our Technical Support Team to resolve the issue.
ACCESS_DENIED	F	Access is denied.	Contact our Technical Support Team to resolve the issue.
INVALID_API	F	The called API is invalid or not active.	Check whether the correct API is being called.
INVALID_CLIENT	F	The client is invalid.	The Client ID does not exist or is invalid.
INVALID_SIGNATURE	F	The signature is invalid.	Make sure the request is properly signed with a valid signature.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	Ensure the HTTP method is `POST`.
UNKNOWN_EXCEPTION	U	API failed due to unknown reason.	The service might be down, retry later. If the issue persists, contact our Technical Support Team.
UN_SUPPORT_BUSINESS	F	Unsupported business.	Invalid parameter. Retry with the correct parameters.
USER_ACCOUNT_NOT_PRIMARY	F	The use account is not primary.	Use the primary account to query the interface.
AUTHORIZATION_NOT_EXIST	F	OAUTH does not exist.	The current token authorization does not exist. Please contact our Technical Support Team to verify token authorization.
INVALID_ACCESS_TOKEN	F	Invalid access token	Use the correct access token.
ACCESS_TOKEN_EXPIRED	F	The access token has expired.	Refresh token to get a new access token or contact out Technical Support Team to address it.

Sample code

Request

copy
{
  "pageSize":"1",
  "pageNumber":"10"
}

Response

copy
{
  "currentPageNumber": 21,
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "success."
  },
  "storeInformation": [{
    "accountInformation": [{
      "accountNo": "***********",
      "accountStatus": "ACTIVE",
      "accountType": "VIRTUAL_ACCOUNT",
      "bankAccountList": [{
        "accountCreationDate": "2023-06-19",
        "bankAccountNo": "*******8396",
        "bankAddress": {
          "address1": "***************************************",
          "region": "HK"
        },
        "bankBIC": "CHASHKHH",
        "bankName": "JP Morgan Chase HONG KONG BRANCH",
        "collectionArea": "GLOBAL",
        "currencyList": ["AUD"],
        "holderName": {
          "fullName": "Z***g"
        }
      }, {
        "accountCreationDate": "2023-06-19",
        "bankAccountNo": "*******8396",
        "bankAddress": {
          "address1": "***************************************",
          "region": "HK"
        },
        "bankBIC": "CHASHKHH",
        "bankName": "JP Morgan Chase HONG KONG BRANCH",
        "collectionArea": "LOCAL",
        "currencyList": ["AUD"],
        "holderName": {
          "fullName": "Z***g"
        }
      }],
      "currencyList": ["AUD"]
    }],
    "authorizedStatus": "NEVER_AUTHORIZED",
    "marketplaceName": "SameName Topup",
    "storeName": "-"
  }],
  "totalCount": 281,
  "totalPageNumber": 1
}