Fx-Rate-Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-fx-rate-response-schema.json",
  "title": "Fx-Rate-Response",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-fxrateinquiry-api-openapi.yml#/components/schemas/Fx-Rate-Response",
  "type": "object",
  "properties": {
    "wl_client_id": {
      "type": "string",
      "title": "wl_client_id",
      "description": "Your unique identification created for WorldLink as a combination of WorldLink Client Number and Branch Number.",
      "maxLength": 9
    },
    "rate_term": {
      "type": "string",
      "description": "Client Rate term maintained in Client profile",
      "maxLength": 8,
      "title": "rate_term"
    },
    "source_currency": {
      "type": "string",
      "description": "Client Source currency must be populated. This will be populated as received in the Request.",
      "maxLength": 3,
      "title": "source_currency"
    },
    "disclaimer": {
      "type": "string",
      "description": "This is a disclaimer for the rate returned.",
      "maxLength": 716,
      "title": "disclaimer"
    },
    "rates": {
      "items": {
        "$ref": "#/$defs/Fx-Rate"
      },
      "type": "array",
      "title": "rates"
    }
  },
  "$defs": {
    "Fx-Rate": {
      "type": "object",
      "title": "Fx-Rate",
      "properties": {
        "target_currency": {
          "type": "string",
          "description": "Client target currency (Optional). This will be populated as received in the Request. If not provided, list all the target_currency as per Client subscription. To be populated for successful scenarios. To be populated for failure scenario only if target_currency received in the request.",
          "maxLength": 3,
          "title": "target_currency"
        },
        "rate": {
          "type": "number",
          "description": "This will be populated as (Multiply/Divide). To be populated for successful scenarios.",
          "maxLength": 17,
          "title": "rate"
        },
        "value_date": {
          "type": "string",
          "description": "FX Contract Value Date. To be populated for successful scenarios. Format: YYYY-MM-DD",
          "maxLength": 10,
          "title": "value_date"
        }
      }
    }
  }
}