inquiryQuoteSignature required
For cross-currency transfers, the Partner can use this API to inquire the currency exchange rates.
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
sellCurrency String REQUIRED
3 character ISO 4217 currency code of the currency that the partner intends to convert from.
More information:
- Maximum length: 3 characters
buyCurrency String REQUIRED
3 character ISO 4217 currency code of the currency that the partner intends to convert to.
More information:
- Maximum length: 3 characters
sellAmount Amount REQUIRED
Amount of the currency sold in sellCurrency.
Note:
- This field is conditionally required.
sellAmountandbuyAmountcannot both be empty.
buyAmount Amount REQUIRED
Amount of the currency bought in buyCurrency.
Note:
- This field is conditionally required.
sellAmountandbuyAmountcannot both be empty.
transferFactor TransferFactor REQUIRED
Indicates different scenarios for the transfer, such as transfer to a WorldFirst Account or a WorldFirst Virtual Account.
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
transferFactor TransferFactor REQUIRED
Indicates different scenarios for the transfer, such as transfer to a WorldFirst Account or a WorldFirst Virtual Account.
sellAmount Amount REQUIRED
Amount of the currency sold in sellCurrency.
Note:
- This field is conditionally required.
sellAmountandbuyAmountcannot both be empty.
buyAmount Amount REQUIRED
Amount of the currency bought in buyCurrency.
Note:
- This field is conditionally required.
sellAmountandbuyAmountcannot both be empty.
foreignExchangeQuote Quote
Information about the quote, such as the currency pair of the quote, quote ID, etc.
Request
Response
Result processing logic
After calling the API, a response is returned. The possible responses for result.resultStatus are:
- 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 WorldFirst Technical Support.
System-realted result codes
| Code | Value | Message | 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 WorldFirst Technical Support 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. |
| 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 WorldFirst Technical Support. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support. | Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support. |
| 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. For more details, refer to the following chapter:
|
| 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. |