inquireRate
Use this interface to to query real-time foreign exchange rates for reference purposes.
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
rateConditionList Array<InquiryRateCondition> REQUIRED
A collection of JSON objects representing currency exchange pairs.
Response parameters
result Object REQUIRED
rateResultList RateResultList REQUIRED
A list of the foreign exchange rates that Antom returns to the merchant.
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | API is successfully called, not resembling order status. |
| PARAM_ILLEGAL | F | Illegal parameters exist. | Check and verify whether the request fields, including the header fields and body fields, are correct and valid. |
| 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 resolve the issue. |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | The service might be down, retry later. If the issue persists, contact Antom Technical Support. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact Antom Technical Support. |
| USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |
| CONTRACT_CHECK_FAIL | F | The contract check has failed. | Ensure the Partner has already signed a contract and the input is correct. |
| 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. |
| QUOTE_EXPIRED | F | The quote is expired. | Call the createQuote API to create a new quote. Retry creating a new settlement request with the new quote. |