Citi · Schema
BalanceInquiryResponse
Balance Inquiry Response should be in ISO XML Standard format(camt.052.001.02). refer this link for more details- https://www.iso20022.org/catalogue-messages/iso-20022-messages-archive?business-domain%5B0%5D=1&search=camt.052.001.02
BankingFinancial ServicesOpen BankingPaymentsTreasuryISO 20022Commercial CardsForeign ExchangeCustodyTrade FinanceCorporate BankingAPI Gateway
Properties
| Name | Type | Description |
|---|---|---|
| Document | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-balance-inquiry-response-schema.json",
"title": "BalanceInquiryResponse",
"description": "Balance Inquiry Response should be in ISO XML Standard format(camt.052.001.02). refer this link for more details- https://www.iso20022.org/catalogue-messages/iso-20022-messages-archive?business-domain%5B0%5D=1&search=camt.052.001.02",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/citi-balance-api-openapi.yml#/components/schemas/BalanceInquiryResponse",
"properties": {
"Document": {
"$ref": "#/$defs/Document"
}
},
"$defs": {
"AccountIdentification4Choice": {
"type": "object",
"properties": {
"IBAN": {
"$ref": "#/$defs/IBAN2007Identifier"
},
"Othr": {
"$ref": "#/$defs/GenericAccountIdentification1"
}
}
},
"AccountInterest2": {
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/InterestType1Choice"
},
"Rate": {
"type": "array",
"items": {
"$ref": "#/$defs/Rate3"
}
},
"FrToDt": {
"$ref": "#/$defs/DateTimePeriodDetails"
},
"Rsn": {
"$ref": "#/$defs/Max35Text"
}
}
},
"AccountReport11": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/Max35Text"
},
"ElctrncSeqNb": {
"type": "string"
},
"LglSeqNb": {
"type": "string"
},
"CreDtTm": {
"$ref": "#/$defs/ISODateTime"
},
"FrToDt": {
"$ref": "#/$defs/DateTimePeriodDetails"
},
"CpyDplctInd": {
"$ref": "#/$defs/CopyDuplicate1Code"
},
"RptgSrc": {
"$ref": "#/$defs/ReportingSource1Choice"
},
"Acct": {
"$ref": "#/$defs/CashAccount20"
},
"RltdAcct": {
"$ref": "#/$defs/CashAccount16"
},
"Intrst": {
"type": "array",
"items": {
"$ref": "#/$defs/AccountInterest2"
}
},
"Bal": {
"type": "array",
"items": {
"$ref": "#/$defs/CashBalance3"
}
},
"TxsSummry": {
"$ref": "#/$defs/TotalTransactions2"
},
"Ntry": {
"type": "array",
"items": {
"$ref": "#/$defs/ReportEntry2"
}
},
"AddtlRptInf": {
"$ref": "#/$defs/Max500Text"
}
}
},
"AccountSchemeName1Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/ExternalAccountIdentification1Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"ActiveOrHistoricCurrencyAndAmount": {
"type": "object",
"properties": {
"Ccy": {
"description": "Currency code. Passed as the tag attribute.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
]
},
"amt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount_SimpleType"
}
}
},
"ActiveOrHistoricCurrencyAndAmount_SimpleType": {
"type": "number",
"maxLength": 18,
"description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217. The number of fractional digits should be 5."
},
"ActiveOrHistoricCurrencyCode": {
"pattern": "[A-Z]{3,3}",
"type": "string"
},
"AddressType2Code": {
"type": "string",
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
]
},
"AlternateSecurityIdentification2": {
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/Max35Text"
},
"Id": {
"$ref": "#/$defs/Max35Text"
}
}
},
"AmountAndCurrencyExchange3": {
"type": "object",
"properties": {
"InstdAmt": {
"$ref": "#/$defs/AmountAndCurrencyExchange3"
},
"TxAmt": {
"$ref": "#/$defs/AmountAndCurrencyExchange3"
},
"CntrValAmt": {
"$ref": "#/$defs/AmountAndCurrencyExchange3"
},
"AnncdPstngAmt": {
"$ref": "#/$defs/AmountAndCurrencyExchange3"
},
"PrtryAmt": {
"type": "array",
"items": {
"$ref": "#/$defs/AmountAndCurrencyExchangeDetails4"
}
}
}
},
"AmountAndCurrencyExchangeDetails4": {
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/Max35Text"
},
"Amt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
},
"CcyXchg": {
"$ref": "#/$defs/CurrencyExchange5"
}
}
},
"AmountRangeBoundary1": {
"type": "object",
"properties": {
"BdryAmt": {
"$ref": "#/$defs/ImpliedCurrencyAndAmount"
},
"Incl": {
"$ref": "#/$defs/YesNoIndicator"
}
}
},
"BICIdentifier": {
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"BalanceSubType1Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/ExternalBalanceSubType1Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"BalanceType12": {
"type": "object",
"properties": {
"CdOrPrtry": {
"$ref": "#/$defs/BalanceType5Choice"
},
"SubTp": {
"$ref": "#/$defs/BalanceSubType1Choice"
}
}
},
"BalanceType12Code": {
"type": "string",
"enum": [
"XPCD",
"OPAV",
"ITAV",
"CLAV",
"FWAV",
"CLBD",
"ITBD",
"OPBD",
"PRCD",
"INFO"
]
},
"BalanceType5Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/BalanceType12Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"BankToCustomerAccountReportV02": {
"required": [
"Rpt"
],
"type": "object",
"properties": {
"GrpHdr": {
"$ref": "#/$defs/GroupHeader42"
},
"Rpt": {
"type": "array",
"items": {
"$ref": "#/$defs/AccountReport11"
}
}
}
},
"BankTransactionCodeStructure4": {
"type": "object",
"properties": {
"Domn": {
"$ref": "#/$defs/BankTransactionCodeStructure5"
},
"Prtry": {
"$ref": "#/$defs/ProprietaryBankTransactionCodeStructure1"
}
}
},
"BankTransactionCodeStructure5": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/ExternalBankTransactionDomain1Code"
},
"Fmly": {
"$ref": "#/$defs/BankTransactionCodeStructure6"
}
}
},
"BankTransactionCodeStructure6": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/ExternalBankTransactionFamily1Code"
},
"SubFmlyCd": {
"$ref": "#/$defs/ExternalBankTransactionSubFamily1Code"
}
}
},
"BaseOneRate": {
"type": "string",
"maxLength": 11,
"description": "Total Digits allowed is 11 and upto 10 decimal places allowed."
},
"BatchInformation2": {
"type": "object",
"properties": {
"MsgId": {
"$ref": "#/$defs/Max35Text"
},
"PmtInfId": {
"$ref": "#/$defs/Max35Text"
},
"NbOfTxs": {
"$ref": "#/$defs/Max15NumericText"
},
"TtlAmt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
},
"CdtDbtInd": {
"$ref": "#/$defs/CreditDebitCode"
}
}
},
"BranchAndFinancialInstitutionIdentification4": {
"type": "object",
"properties": {
"FinInstnId": {
"$ref": "#/$defs/FinancialInstitutionIdentification7"
},
"BrnchId": {
"$ref": "#/$defs/BranchData2"
}
}
},
"BranchData2": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/Max35Text"
},
"Nm": {
"$ref": "#/$defs/Max140Text"
},
"PstlAdr": {
"$ref": "#/$defs/PostalAddress6"
}
}
},
"CashAccount16": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/AccountIdentification4Choice"
},
"Tp": {
"$ref": "#/$defs/CashAccountType2"
},
"Ccy": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
},
"Nm": {
"$ref": "#/$defs/Max70Text"
}
}
},
"CashAccount20": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/AccountIdentification4Choice"
},
"Tp": {
"$ref": "#/$defs/CashAccountType2"
},
"Ccy": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
},
"Nm": {
"$ref": "#/$defs/Max70Text"
},
"Ownr": {
"$ref": "#/$defs/PartyIdentification32"
},
"Svcr": {
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification4"
}
}
},
"CashAccountType2": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/CashAccountType4Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"CashAccountType4Code": {
"type": "string",
"enum": [
"CASH",
"CHAR",
"COMM",
"TAXE",
"CISH",
"TRAS",
"SACC",
"CACC",
"SVGS",
"ONDP",
"MGLD",
"NREX",
"MOMA",
"LOAN",
"SLRY",
"ODFT"
]
},
"CashBalance3": {
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/BalanceType12"
},
"CdtLine": {
"$ref": "#/$defs/CreditLine2"
},
"Amt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
},
"CdtDbtInd": {
"$ref": "#/$defs/CreditDebitCode"
},
"Dt": {
"$ref": "#/$defs/DateAndDateTimeChoice"
},
"Avlbty": {
"$ref": "#/$defs/CashBalanceAvailability2"
}
}
},
"CashBalanceAvailability2": {
"type": "object",
"properties": {
"Dt": {
"$ref": "#/$defs/CashBalanceAvailabilityDate1"
},
"Amt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
},
"CdtDbtInd": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
}
},
"CashBalanceAvailabilityDate1": {
"type": "object",
"properties": {
"NbOfDays": {
"$ref": "#/$defs/Max15PlusSignedNumericText"
},
"ActlDt": {
"$ref": "#/$defs/ISODate"
}
}
},
"ChargeBearerType1Code": {
"type": "string",
"enum": [
"DEBT",
"CRED",
"SHAR",
"SLEV"
]
},
"ChargeType1Code": {
"type": "string",
"enum": [
"BRKF",
"COMM"
]
},
"ChargeType2Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/ChargeType1Code"
},
"Prtry": {
"$ref": "#/$defs/GenericIdentification3"
}
}
},
"ChargesInformation6": {
"type": "object",
"properties": {
"TtlChrgsAndTaxAmt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
},
"Amt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
},
"CdtDbtInd": {
"$ref": "#/$defs/CreditDebitCode"
},
"Tp": {
"$ref": "#/$defs/ChargeType2Choice"
},
"Rate": {
"$ref": "#/$defs/PercentageRate"
},
"Br": {
"$ref": "#/$defs/ChargeBearerType1Code"
},
"Pty": {
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification4"
},
"Tax": {
"$ref": "#/$defs/TaxCharges2"
}
}
},
"ClearingSystemIdentification2Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/ExternalClearingSystemIdentification1Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"ClearingSystemMemberIdentification2": {
"type": "object",
"properties": {
"ClrSysId": {
"$ref": "#/$defs/ClearingSystemIdentification2Choice"
},
"MmbId": {
"$ref": "#/$defs/Max35Text"
}
}
},
"ContactDetails2": {
"type": "object",
"properties": {
"NmPrfx": {
"$ref": "#/$defs/NamePrefix1Code"
},
"Nm": {
"$ref": "#/$defs/Max140Text"
},
"PhneNb": {
"$ref": "#/$defs/PhoneNumber"
},
"MobNb": {
"$ref": "#/$defs/PhoneNumber"
},
"FaxNb": {
"$ref": "#/$defs/PhoneNumber"
},
"EmailAdr": {
"$ref": "#/$defs/Max2048Text"
},
"Othr": {
"$ref": "#/$defs/Max35Text"
}
}
},
"CopyDuplicate1Code": {
"type": "string",
"enum": [
"CODU",
"COPY",
"DUPL"
]
},
"CorporateAction1": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/Max35Text"
},
"Nb": {
"$ref": "#/$defs/Max35Text"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"CountryCode": {
"type": "string",
"pattern": "[A-Z]{2,2}"
},
"CreditDebitCode": {
"type": "string",
"description": "Specifies if an operation is an increase or a decrease.\n*`CRDT_credit`-Operation is an increase.\n*`DBIT_debit`-Operation is a decrease.\n",
"enum": [
"CRDT",
"DBIT"
]
},
"CreditLine2": {
"type": "object",
"properties": {
"Incl": {
"$ref": "#/$defs/TrueFalseIndicator"
},
"Amt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
}
},
"CreditorReferenceInformation2": {
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/CreditorReferenceType2"
},
"Ref": {
"$ref": "#/$defs/Max35Text"
}
}
},
"CreditorReferenceType1Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/DocumentType3Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"CreditorReferenceType2": {
"type": "object",
"properties": {
"CdOrPrtry": {
"$ref": "#/$defs/CreditorReferenceType1Choice"
},
"Issr": {
"$ref": "#/$defs/Max35Text"
}
}
},
"CurrencyAndAmountRange2": {
"type": "object",
"properties": {
"Amt": {
"$ref": "#/$defs/ImpliedCurrencyAmountRangeChoice"
},
"CdtDbtInd": {
"$ref": "#/$defs/CreditDebitCode"
},
"Ccy": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
}
},
"CurrencyExchange5": {
"type": "object",
"properties": {
"SrcCcy": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
},
"TrgtCcy": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
},
"UnitCcy": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
},
"XchgRate": {
"$ref": "#/$defs/BaseOneRate"
},
"CtrctId": {
"$ref": "#/$defs/Max35Text"
},
"QtnDt": {
"$ref": "#/$defs/ISODateTime"
}
}
},
"DateAndDateTimeChoice": {
"type": "object",
"properties": {
"Dt": {
"$ref": "#/$defs/ISODate"
},
"DtTm": {
"$ref": "#/$defs/ISODateTime"
}
}
},
"DateAndPlaceOfBirth": {
"type": "object",
"properties": {
"BirthDt": {
"$ref": "#/$defs/ISODate"
},
"PrvcOfBirth": {
"$ref": "#/$defs/Max35Text"
},
"CityOfBirth": {
"$ref": "#/$defs/Max35Text"
},
"CtryOfBirth": {
"$ref": "#/$defs/CountryCode"
}
}
},
"DatePeriodDetails": {
"type": "object",
"properties": {
"FrDt": {
"$ref": "#/$defs/ISODate"
},
"ToDt": {
"$ref": "#/$defs/ISODate"
}
}
},
"DateTimePeriodDetails": {
"type": "object",
"properties": {
"FrDtTm": {
"$ref": "#/$defs/ISODateTime"
},
"ToDtTm": {
"$ref": "#/$defs/ISODateTime"
}
}
},
"DecimalNumber": {
"type": "number",
"maxLength": 18,
"description": "Total digits 18 is allowed. And upto 17 decimal places allowed"
},
"Document": {
"properties": {
"BkToCstmrAcctRpt": {
"$ref": "#/$defs/BankToCustomerAccountReportV02"
}
}
},
"DocumentAdjustment1": {
"type": "object",
"properties": {
"Amt": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
},
"CdtDbtInd": {
"$ref": "#/$defs/CreditDebitCode"
},
"Rsn": {
"$ref": "#/$defs/Max4Text"
},
"AddtlInf": {
"$ref": "#/$defs/Max140Text"
}
}
},
"DocumentType3Code": {
"type": "string",
"enum": [
"RADM",
"RPIN",
"FXDR",
"DISP",
"PUOR",
"SCOR"
]
},
"DocumentType5Code": {
"type": "string",
"enum": [
"MSIN",
"CNFA",
"DNFA",
"CINV",
"CREN",
"DEBN",
"HIRI",
"SBIN",
"CMCN",
"SOAC",
"DISP",
"BOLD",
"VCHR",
"AROI",
"TSUT"
]
},
"EntryDetails1": {
"type": "object",
"properties": {
"Btch": {
"$ref": "#/$defs/BatchInformation2"
},
"TxDtls": {
"type": "array",
"items": {
"$ref": "#/$defs/EntryTransaction2"
}
}
}
},
"EntryStatus2Code": {
"type": "string",
"enum": [
"BOOK",
"PDNG",
"INFO"
]
},
"EntryTransaction2": {
"type": "object",
"properties": {
"Refs": {
"$ref": "#/$defs/TransactionReferences2"
},
"AmtDtls": {
"$ref": "#/$defs/AmountAndCurrencyExchange3"
},
"Avlbty": {
"type": "array",
"items": {
"$ref": "#/$defs/CashBalanceAvailability2"
}
},
"BkTxCd": {
"$ref": "#/$defs/BankTransactionCodeStructure4"
},
"Chrgs": {
"type": "array",
"items": {
"$ref": "#/$defs/ChargesInformation6"
}
},
"Intrst": {
"type": "array",
"items": {
"$ref": "#/$defs/TransactionInterest2"
}
},
"RtldPties": {
"$ref": "#/$defs/TransactionParty2"
},
"RltdAgts": {
"$ref": "#/$defs/TransactionAgents2"
},
"Purp": {
"$ref": "#/$defs/Purpose2Choice"
},
"RltdRmtInf": {
"$ref": "#/$defs/RemittanceLocation2"
},
"RmtInf": {
"$ref": "#/$defs/RemittanceInformation5"
},
"RltdDts": {
"$ref": "#/$defs/TransactionDates2"
},
"RltdPric": {
"$ref": "#/$defs/TransactionPrice2Choice"
},
"RltdQties": {
"type": "array",
"items": {
"$ref": "#/$defs/TransactionQuantities1Choice"
}
},
"FinInstrmId": {
"$ref": "#/$defs/SecurityIdentification4Choice"
},
"Tax": {
"$ref": "#/$defs/TaxInformation3"
},
"RtrInf": {
"$ref": "#/$defs/ReturnReasonInformation10"
},
"CorpActn": {
"$ref": "#/$defs/CorporateAction1"
},
"SfkpgAcct": {
"$ref": "#/$defs/CashAccount16"
},
"AddtlTxInf": {
"$ref": "#/$defs/Max500Text"
}
}
},
"ExternalAccountIdentification1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalBalanceSubType1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalBankTransactionDomain1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalBankTransactionFamily1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalBankTransactionSubFamily1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalClearingSystemIdentification1Code": {
"type": "string",
"minLength": 1,
"maxLength": 5
},
"ExternalFinancialInstitutionIdentification1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalOrganisationIdentification1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalPersonIdentification1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalPurpose1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalReportingSource1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalReturnReason1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"ExternalTechnicalInputChannel1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"FinancialIdentificationSchemeName1Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/ExternalFinancialInstitutionIdentification1Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"FinancialInstitutionIdentification7": {
"type": "object",
"properties": {
"BIC": {
"$ref": "#/$defs/BICIdentifier"
},
"ClrSysMmbId": {
"$ref": "#/$defs/ClearingSystemMemberIdentification2"
},
"Nm": {
"$ref": "#/$defs/Max140Text"
},
"PstlAdr": {
"$ref": "#/$defs/PostalAddress6"
},
"Othr": {
"$ref": "#/$defs/GenericFinancialIdentification1"
}
}
},
"FinancialInstrumentQuantityChoice": {
"type": "object",
"properties": {
"Unit": {
"$ref": "#/$defs/DecimalNumber"
},
"FaceAmt": {
"$ref": "#/$defs/ImpliedCurrencyAndAmount"
},
"AmtsdVal": {
"$ref": "#/$defs/ImpliedCurrencyAndAmount"
}
}
},
"FromToAmountRange": {
"type": "object",
"properties": {
"FrAmt": {
"$ref": "#/$defs/AmountRangeBoundary1"
},
"ToAmt": {
"$ref": "#/$defs/AmountRangeBoundary1"
}
}
},
"GenericAccountIdentification1": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/Max34Text"
},
"SchmeNm": {
"$ref": "#/$defs/AccountSchemeName1Choice"
},
"Issr": {
"$ref": "#/$defs/Max35Text"
}
}
},
"GenericFinancialIdentification1": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/Max35Text"
},
"SchmeNm": {
"$ref": "#/$defs/FinancialIdentificationSchemeName1Choice"
},
"Issr": {
"$ref": "#/$defs/Max35Text"
}
}
},
"GenericIdentification3": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/Max35Text"
},
"Issr": {
"$ref": "#/$defs/Max35Text"
}
}
},
"GenericOrganisationIdentification1": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"SchmeNm": {
"description": "Name of the identification scheme.",
"allOf": [
{
"$ref": "#/$defs/OrganisationIdentificationSchemeName1Choice"
}
]
},
"Issr": {
"description": "Entity that assigns the identification.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
}
},
"GenericPersonIdentification1": {
"type": "object",
"properties": {
"Id": {
"$ref": "#/$defs/Max35Text"
},
"SchmeNm": {
"$ref": "#/$defs/PersonIdentificationSchemeName1Choice"
},
"Issr": {
"$ref": "#/$defs/Max35Text"
}
}
},
"GroupHeader42": {
"type": "object",
"properties": {
"MsgId": {
"$ref": "#/$defs/Max35Text"
},
"CreDtTm": {
"$ref": "#/$defs/ISODateTime"
},
"MsgRcpt": {
"$ref": "#/$defs/PartyIdentification32"
},
"MsgPgntn": {
"$ref": "#/$defs/Pagination"
},
"AddtlInf": {
"$ref": "#/$defs/Max500Text"
}
}
},
"IBAN2007Identifier": {
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"ISINIdentifier": {
"type": "string",
"pattern": "[A-Z0-9]{12,12}"
},
"ISODate": {
"type": "string",
"description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.",
"pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$"
},
"ISODateTime": {
"format": "dateTime",
"type": "string"
},
"ImpliedCurrencyAmountRangeChoice": {
"type": "object",
"properties": {
"FrAmt": {
"$ref": "#/$defs/AmountRangeBoundary1"
},
"ToAmt": {
"$ref": "#/$defs/AmountRangeBoundary1"
},
"FrToAmt": {
"$ref": "#/$defs/FromToAmountRange"
},
"EQAmt": {
"$ref": "#/$defs/ImpliedCurrencyAndAmount"
},
"NEQAmt": {
"$ref": "#/$defs/ImpliedCurrencyAndAmount"
}
}
},
"ImpliedCurrencyAndAmount": {
"type": "string",
"maxLength": 18,
"description": "Total digts 18 are allowed. And Upto 5 fractional places"
},
"InterestType1Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/InterestType1Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"InterestType1Code": {
"type": "string",
"enum": [
"INDY",
"OVRN"
]
},
"Max105Text": {
"type": "string",
"minLength": 1,
"maxLength": 105
},
"Max140Text": {
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Max15NumericText": {
"type": "string",
"pattern": "[0-9]{1,15}"
},
"Max15PlusSignedNumericText": {
"type": "string",
"pattern": "[+]{0,1}[0-9]{1,15}"
},
"Max16Text": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"Max2048Text": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"Max34Text": {
"type": "string",
"minLength": 1,
"maxLength": 34
},
"Max35Text": {
"type": "string",
"description": "Specifies a character string with a maximum length of 35 characters.",
"minLength": 1,
"maxLength": 35
},
"Max4Text": {
"minLength": 1,
"maxLength": 4,
"type": "string"
},
"Max500Text": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Max5NumericText": {
"type": "string",
"pattern": "[0-9]{1,5}"
},
"Max70Text": {
"type": "string",
"description": "Specifies a character string with a maximum length of 70characters.",
"minLength": 1,
"maxLength": 70
},
"MessageIdentification2": {
"type": "object",
"properties": {
"MsgNmId": {
"$ref": "#/$defs/Max35Text"
},
"MsgId": {
"$ref": "#/$defs/Max35Text"
}
}
},
"NameAndAddress10": {
"type": "object",
"properties": {
"Nm": {
"$ref": "#/$defs/Max140Text"
},
"Adr": {
"$ref": "#/$defs/PostalAddress6"
}
}
},
"NamePrefix1Code": {
"type": "string",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
]
},
"Number": {
"type": "string",
"maxLength": 18,
"description": "Upto 18 digits allowed."
},
"NumberAndSumOfTransactions1": {
"type": "object",
"properties": {
"NbOfNtries": {
"$ref": "#/$defs/Max15NumericText"
},
"Sum": {
"$ref": "#/$defs/DecimalNumber"
}
}
},
"NumberAndSumOfTransactions2": {
"type": "object",
"properties": {
"NbOfNtries": {
"$ref": "#/$defs/Max15NumericText"
},
"Sum": {
"$ref": "#/$defs/DecimalNumber"
},
"TtlNetNtryAmt": {
"$ref": "#/$defs/DecimalNumber"
},
"CdtDbtInd": {
"$ref": "#/$defs/CreditDebitCode"
}
}
},
"OrganisationIdentification4": {
"type": "object",
"description": "Unique and unambiguous way to identify an organisation.",
"properties": {
"BICOrBEI": {
"description": "Code allocated to a financial institution or non financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
"type": "string"
},
"Othr": {
"description": "Unique identification of an organisation, as assigned by an institution, using an identification scheme.",
"items": {
"$ref": "#/$defs/GenericOrganisationIdentification1"
},
"type": "array"
}
}
},
"OrganisationIdentificationSchemeName1Choice": {
"type": "object",
"description": "Either of Code or Proprietary is required",
"properties": {
"Cd": {
"$ref": "#/$defs/ExternalOrganisationIdentification1Code"
},
"Prtry": {
"$ref": "#/$defs/Max35Text"
}
}
},
"Pagination": {
"type": "object",
"properties": {
"PgNb": {
"$ref": "#/$defs/Max5NumericText"
},
"LastPgInd": {
"$ref": "#/$defs/YesNoIndicator"
}
}
},
"Party6Choice": {
"type": "object",
"properties": {
"OrgId": {
"allOf": [
{
"$ref": "#/$defs/OrganisationIdentification4"
}
]
},
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/json-schema/citi-balance-inquiry-response-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/citi-balance-inquiry-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.