BalInquiryRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-bal-inquiry-request-schema.json",
  "title": "BalInquiryRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-accounts-api-openapi.yml#/components/schemas/BalInquiryRequest",
  "properties": {
    "accountNumber": {
      "description": "Number of the account to which the balance inquiry relates. TPP clients must send encrypted Account number field.",
      "type": "string",
      "format": "alphanumeric",
      "maxLength": 19,
      "minLength": 16
    },
    "accountLevel": {
      "description": "Heirarchy level to which balance inquiry relates<br>Possible Values<br>G - Corporate Group<br>R - Corporate Relationship<br>A - Financial Account<br>C - Card",
      "type": "string",
      "format": "alphanumeric",
      "maxLength": 1
    },
    "transactionAmount": {
      "description": "The amount of the planned transaction to be checked against the available limit<br><br>Applicable only when transactionType = C<br><br>Amount format must be passed with the appropriate amount of decimal positions based on the currency per the ISO 4217 standard<br><br>If additonal digits are added to the right of the decimal where not applicable for the given currency as per the ISO 4217 standard, the additional digits will be stripped from the end from the value.<br>Max length: 14 digits to the left of the decimal and 2 digits to the right of the decimal<br>or 13 digits to the left of the decimal and 3 digits to the right of the decimal.",
      "type": "string",
      "format": "alphanumeric",
      "maxLength": 17
    },
    "transactionAmountCurrency": {
      "description": "Required if transactionAmount is included in request. If not included while Transaction Amount is present, transactionAmountCurrency will be defaulted to the domestic currency<br><br>Applicable only when transactionType = C<br><br>The currency of the planned transaction to be checked against the available limit",
      "type": "string",
      "format": "alphanumeric",
      "maxLength": 3
    }
  },
  "required": [
    "accountNumber"
  ]
}