Request one or more FX quotes

post

https://www.bankingcircleconnect.com/api/v3/fx/rates

Body Params

One or more quote requests

Represents a Request for Quote (RFQ)

quoteRequestId

uuid

required

Unique identifier (UUID) for this quote request

customerId

string

required

(Required) Specify the customer id that this quote is for.

Must belong to the debit account of the expected payment(s) or the sell account of the expected FX trade(s).

currencyPair

string | null

(Conditionally required)

Specify the currency pair for the quote. Either currencyPair or both currencyOne and currencyTwo are required.

If not specified, then the currency pair will be derived from currencyOne and currencyTwo

Example: You can specify either EURUSD or USDEUR to get the exchange rate in your desired convention.

If you do not provide a currency pair, the exchange rate will be provided in default convention.

currencyOne

string | null

(Conditionally required)

Specify the first of the two currencies for the quote. Required if CurrencyPair is not specified.

If provided, the exchange rate will be provided in our default convention.

Example: Specify EUR as currencyOne and USD as currencyTwo to get the exchange rate in default convention.

currencyTwo

string | null

(Conditionally required)

Specify the second of the two currencies for the quote. Required if CurrencyPair is not specified.

If provided, the exchange rate will be provided in our default convention.

Example: Specify EUR as currencyOne and USD as currencyTwo to get the exchange rate in default convention.

tenor

string

enum

required

(Required)

Specify the tenor for the quote. For today's value date, use ON.

Note: BROKEN is not yet supported.

Allowed:

amount

double | null

≥ 0.01

(Conditionally required)

Specify the requested amount for the quote.

Your specified payment instruction or FX trade amount must be less than or equal to this amount.

Required in all cases, except for Held Rates (See: validFor)

amountCurrency

string | null

(Conditionally required)

Specify the currency of the BankingCircle.Fx.Api.Data.V3.QuoteRequestV3.Amount.

Required in all cases, except for Held Rates (See: ValidFor)

If this quote is used for instructing a Multicurrency Payment, then the amount currency must match the transfer currency.

validFor

int32 | null

1 to 1440

(Optional)

Specify the desired validity period for the quote in minutes.

Required only when requesting a Held Rate (See: RequestType).

Do not provide this for any other request

requestType

string

enum

required

(Required)

Specify the type of this request.

Indicative: Request a quote for indicative (non-tradable) purposes, such as showing it in a user interface.
Rfq: Request a tradable quote that can be used for either FX trading or Multicurrency Payments
PaymentRfq: Request a tradable quote that can be used for FX payments only.
HeldRate: Request a tradable quote that is valid for a specified period of time that can be used multiple times
LockedRate: Request a quote for a locked rate (currently restricted to UI users only).

Allowed:

200OK

400Bad Request

403Forbidden

404Not Found