A foreign_exchange_quote
is an exchange rate that is valid for a certain period of time for a requested currency pair.
Attribute | Type | Description |
---|---|---|
id | string UUID | The UUID of the Foreign Exchange Quote. |
object | string | "foreign_exchange_quote" |
effective_at | string ISO 8601 | The timestamp until when the quoted rate is valid. |
expires_at | string ISO 8601 | The timestamp until which the quote must be booked by. |
foreign_exchange_indicator | string | Either 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_rate | object | The serialized rate information represented by this quote. See Foreign Exchange Rates. |
internal_account_id | uuid | The ID for the InternalAccount this quote is associated with. See Internal Accounts. |
metadata | object | Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata. |
vendor_id | string | This vendor assigned ID for this quote. |
Example Response
{
"id": "63d023ec-c8d5-47b2-8054-7c7db012aade",
"object": "foreign_exchange_quote",
"live_mode": true,
"foreign_exchange_indicator": "variable_to_fixed",
"internal_account_id": "9a471ebb-1097-4617-b6d2-5a5e2417fc81",
"vendor_id": "acc3e05e-10eb-4376-bfcc-f4b03f5afc90",
"effective_at": "2024-04-07T23:59:59Z",
"expires_at": "2024-04-06T23:59:59Z",
"foreign_exchange_rate": {
"base_amount": 100,
"base_currency": "USD",
"target_amount": 91,
"target_currency": "EUR",
"value": 91,
"exponent": 2,
"rate_string": "0.91"
},
"metadata": {
"custom": "metadata"
},
"created_at": "2024-04-05T19:28:44Z",
"updated_at": "2024-04-05T19:28:44Z"
}