Retrieve FX ratesSignature required
The Partner can call this API to request an unquoted foreign exchange rate with a higher frequency.
- The foreign exchange rate returned by this API is only for reference purposes.
- To obtain a transactional forex quote on WorldFirst, call the createQuote API instead.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:
Request parameters
inquiryRateConditionList Array<InquiryRateCondition> REQUIRED
A list of the conditions for the inquiry, which includes the currency to buy and the currency to sell.
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
responseId String REQUIRED
The unique ID that is assigned by WorldFirst to identify a response.
This field is returned only when the value of result.resultStatus is
S.
More information:
- Maximum length: 32 characters
rateList Array<ReferenceRate>
A list of the foreign exchange rates that WorldFirst returns to the Partner.
This field is returned only when the value of result.resultStatus is
S.
Request
Response
Result processing logic
After calling the API, a response is returned. The possible responses for result.resultStatus are:
Result status | Description |
| This indicates the API call succeeded. |
| This indicates the API call failed. For more information on why the call failed, see result.resultCode. |
| This indicates the API call result is unknown. Partner can make a query when the returned status is
If none of the queries is successful, contact our Technical Support Team. |
System-realted result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| 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. |
| 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. |
| 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. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team. |
| OAUTH_FAIL | F | OAuth process failed. | Contact our Technical Support Team 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 |
Business-related result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| UN_SUPPORT_BUSINESS | F | Unsupported business. | Invalid parameters are used e.g. currency is incorrect. Retry with the correct information. |
| SYSTEM_ERROR | F | System error. | Do not retry, and contact our Technical Support Team for more details. |
| USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |