Create a Quote

Generates a binding FX quote for a specified currency pair and deal type. The returned quote includes a quote ID, exchange rate, and an expiry time. Use the quote ID to create a deal before the quote expires. Supports spot, unfunded spot, and forward deal types.
Request Parameters
sellAmountAmount
required
Sell amount. One of sellAmount or buyAmount must include a value. See Data Types
buyAmountAmount
required
Buy amount. One of sellAmount or buyAmount must include a value. See Data Types
dealTypestring
required
Deal type.

Valid Values:

SPOT — Standard spot deal. Settles automatically.
UNFUNDED_SPOT — Unfunded spot deal. Requires explicit settlement.
FORWARD — Forward deal. Requires margin and settlement period.
creditSupportCreditSupport
Credit and margin information. Required when dealType is FORWARD.
Show child parametersShow child parameters
settlementPeriodSettlementPeriod
Settlement period. Not applicable when dealType is SPOT; required when dealType is UNFUNDED_SPOT or FORWARD.
Show child parametersShow child parameters
Response Parameters
resultResult
See Result.
quoteQuote
Quote details.
Show child parametersShow child parameters
sellAmountAmount
Sell amount. See Data Types
buyAmountAmount
Buy amount. See Data Types
dealTypestring
Deal type.

Valid Values:

SPOT — Standard spot deal. Settles automatically.
UNFUNDED_SPOT — Unfunded spot deal. Requires explicit settlement.
FORWARD — Forward deal. Requires margin and settlement period.
creditSupportCreditSupport
Credit and margin information. Returned when dealType is FORWARD.
Show child parametersShow child parameters
settlementPeriodSettlementPeriod
Settlement period information.
Show child parametersShow child parameters
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSsuccessN/A
CURRENCY_NOT_SUPPORTEDFThe specified currency is not supported.Use a supported currency code following the ISO 4217 standard. See [Data Types](https://docs.worldfirst.com/wfdocs/api-sdk/data_types)
FX_FORWARD_LEI_CHECK_FAILEDFThe LEI check for the forward deal failed.Ensure a valid Legal Entity Identifier (LEI) is registered for forward deals.
FX_DEAL_QUOTA_NOT_ENOUGHFThe deal quota is not sufficient for this transaction.Check the remaining deal quota and reduce the deal amount or contact support.
FX_CURRENCY_PAIR_RISK_BREAKFThe currency pair has triggered risk control.Contact support to review risk control limits for this currency pair.
Definition
POST /api/open/v1/fx/quotes/create
Request
{
"sellAmount": {
  "currency": "USD",
  "value": 10000
},
"buyAmount": {
  "currency": "HKD"
},
"dealType": "SPOT"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"quote": {
  "quoteId": "QT20260402120****",
  "currencyPair": "USD/HKD",
  "clientRate": 7.785,
  "effectiveAt": "2026-04-02T04:08:56Z",
  "expiresAt": "2026-04-02T04:09:56Z"
},
"sellAmount": {
  "currency": "USD",
  "value": 10000
},
"buyAmount": {
  "currency": "HKD",
  "value": 77850
},
"dealType": "SPOT"
}