inquiryBalance
Use this interface to inquire the account balance.
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
currencyList Array<CurrencyList>
A list containing 3-character ISO-4217 currency codes representing the currency that the merchant queries.
Note: When this parameter is not specified, this API returns the balance information of all currencies.
Response parameters
result Object REQUIRED
The result of the API call.
accountBalances Array<AccountBalance>
The list of account balances
Note: This parameter is returned on demand only when the value of result.resultStatus is S.
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | success. | API is successfully called, not resembling order status |
| UNKNOWN_EXCEPTION | U | The API call is failed, which is caused by unknown reasons. | The service might be down, retry later. If the issue persists, contact the Antom Technical Support. |
| 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. |
| CONTRACT_CHECK_FAIL | F | The contract check failed. | Check the contract status with Antom before retrying. |
| ACCOUNT_NOT_EXIST | F | The account does not exist. | Check if the account is valid and retry. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact the Antom Technical Support Team. |
| OAUTH_FAIL | F | OAuth process failed. | Contact the Antom Technical Support for detailed reasons. |
| 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. |
| PROCESS_FAIL | F | A general business failure occurred. | Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support to troubleshoot the issue. |
| USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |
| SYSTEM_ERROR | F | System error. | Do not retry, and contact the Antom Technical Support for more details. |
| SERVICE_NOT_ALLOWED | F | Service not allowed | Retry with the correct information. If the issue persists, contact the Antom Technical Support. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Make sure the currency input is correct and try again. |
| AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | Make sure that the input is correct. If the issue persists, contact the Antom Technical Support to verify the authorization status. |
| ACCESS_TOKEN_EXPIRED | F | The access token expired. | Refresh token to get a new access token or contact the Antom Technical Support to address it. |