Get an FX quoteSignature required
The Partner calls this API to obtain a transactional forex quote on WorldFirst.
To get forex rates as a reference, call the inquiryRate API instead.
Structure
A message consists of a header and body. For details, see the following sections.
Request header
Field Required Sample Description Client-Id Yes For more information about these request header fields, see Request header. Signature Yes Content-Type Yes Request-Time YesClient-Id: *****
Signature: algorithm=RSA256, keyVersion=2, signature=*****
Content-Type: application/json; charset=UTF-8
Request-Time: 2019-04-04T12:08:56+08:00
Request parameters
sell QuoteAmount object REQUIRED
The amount and the currency to be sold.
buy QuoteAmount object REQUIRED
The amount and the currency to be bought.
exchangeTradeType String REQUIRED
Defines the type of foreign exchange trading.
Valid values are:
SPOT
: Using spot rate.FORWARD
: Using forward rate.UNFUNDED_SPOT
: Using unfunded spot rate.
quoteUnfundedInfo QuoteForwardInfo object CONDITIONAL
Information about the quotes. Specify this parameter if the value of the exchangeTradeType parameter is FORWARD
or UNFUNDED_SPOT
.
Response parameters
result Result object 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
quote Quote object REQUIRED
Information about the quote, such as quote prices, quote start time and expiry time, etc.
This field is returned only when the value of result.resultStatus is
S
.
sell QuoteAmount object REQUIRED
The amount and the currency to be sold.
This field is returned only when the value of result.resultStatus is
S
.
buy QuoteAmount object REQUIRED
The amount and the currency to be bought.
This field is returned only when the value of result.resultStatus is
S
.
exchangeTradeType String REQUIRED
Defines the type of the foreign exchange trading.
Valid values are:
SPOT
: Using spot rate.FORWARD
: Using forward rate.UNFUNDED_SPOT
: Using unfunded spot rate.
This field is returned only when the value of result.resultStatus is
S
.
quoteUnfundedInfo QuoteForwardInfo object CONDITIONAL
Information about the quotes. This parameter is returned if the value of the exchangeTradeType parameter is FORWARD
or UNFUNDED_SPOT
.
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 S This indicates the API call succeeded. Get the value of F This indicates the API call failed. For more information on why the call failed, see U 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.quote.quotePrice
and quote.quoteId
.result.resultCode
.UNKNOWN
. Use the following query strategy:
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. |
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. Retry with the correct information. |
INVALID_ACCESS_TOKEN | F | Invalid access token | Check whether the accessToken is correct. |
CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Make sure the currency input is correct and try again. |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | Check the contract status before retrying. |