Foreign Exchange Quotes

A foreign_exchange_quote an exchange rate that is valid for a certain period of time for a requested currency pair.

AttributeTypeDescription
effective_atstring
ISO 8601
The timestamp until when the quoted rate is valid.
expires_atstring
ISO 8601
The timestamp until which the quote must be booked by.
foreign_exchange_indicatorstringEither fixed_to_variable if the base_amount was specified, or variable_to_fixed if the target_amount was specified when requesting the quote.
foreign_exchange_rateobjectThe serialized rate information represented by this quote. See below.
internal_account_iduuidThe ID for the InternalAccount this quote is associated with. See Internal Accounts.
metadataobjectAdditional data represented as key-value pairs. Both the key and value must be strings. See Metadata.
vendor_idstringThis vendor assigned ID for this quote.

The foreign_exchange_rate object

The exchange rate itself is stored as components to allow arbitrarily high precision when converting between currencies where a large decimal is necessary.

AttributeTypeDescription
base_amountintegerAmount in the lowest denomination of the base_currency to convert, often called the "sell" amount.
base_currencystring
ISO 4217
Currency to convert, often called the "sell" currency.
exponentintegerThe exponent component of the rate. The decimal is calculated as value / (10 ^ exponent)
rate_stringstringA string representation of the rate, e.g. "1.234"
target_amountintegerAmount in the lowest denomination of the target_currency, often called the "buy" amount.
target_currencystring
ISO 4217
Currency to convert the base_currency to, often called the "buy" currency.
valueintegerThe whole number component of the rate. The decimal is calculated as value / (10 ^ exponent)