Modern Treasury · Schema

foreign_exchange_quote_create_request

FintechPaymentsACHWiresTreasury

Properties

Name Type Description
effective_at string The timestamp until when the quoted rate is valid.
base_amount integer Amount in the lowest denomination of the `base_currency` to convert, often called the "sell" amount.
base_currency object Currency to convert, often called the "sell" currency.
internal_account_id string The ID for the `InternalAccount` this quote is associated with.
target_amount integer Amount in the lowest denomination of the `target_currency`, often called the "buy" amount.
target_currency object Currency to convert the `base_currency` to, often called the "buy" currency.
View JSON Schema on GitHub

JSON Schema

modern-treasury-foreign-exchange-quote-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/foreign_exchange_quote_create_request",
  "title": "foreign_exchange_quote_create_request",
  "type": "object",
  "properties": {
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp until when the quoted rate is valid."
    },
    "base_amount": {
      "type": "integer",
      "description": "Amount in the lowest denomination of the `base_currency` to convert, often called the \"sell\" amount."
    },
    "base_currency": {
      "$ref": "#/components/schemas/currency",
      "description": "Currency to convert, often called the \"sell\" currency."
    },
    "internal_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID for the `InternalAccount` this quote is associated with."
    },
    "target_amount": {
      "type": "integer",
      "description": "Amount in the lowest denomination of the `target_currency`, often called the \"buy\" amount."
    },
    "target_currency": {
      "$ref": "#/components/schemas/currency",
      "description": "Currency to convert the `base_currency` to, often called the \"buy\" currency."
    }
  },
  "additionalProperties": false,
  "required": [
    "internal_account_id",
    "target_currency"
  ]
}