Citi API

Balances

balances

Methods

Balance Inquiry Post ->
Balance
post/v3/balance/inquiry

CitiConnect Balance Inquiry allows users to access account balances intraday or end of day for greater visibility.

Security
Parameters
client_id: string
Body parameters
account_currency?: string

Currency type of the Account specified. Only one Account Currency should be sent in the request, if needed. This field is an optional field, so even if no value is sent, the API will still accept the request

account_identifier?: string

Identification of the account as defined by the account service provider. this is mandatory when branch_number not provided

base_currency?: string

Base Currency. Only one value should be sent. If no value is sent, then the API will send a Reject response with the error message

branch_number?: string

Branch Number as defined by the account service provider. account_identifier or branch_number is mandatory to get the balance.

from_date?: string

start date of balance. if data not provided current date will be taken.

to_date?: string

end date of balance. if data not provided current date will be taken. it supports upto last 180 days range.

Response fields
Balance
Request example
200Example

Domain types

AccountIdentificationChoice = { IBAN, Othr }
AccountSchemeNameChoice = { Cd, Prtry }
Amount = { AnncdPstngAmt, CntrValAmt, InstdAmt, 2 more... }
AmountRangeBoundary = { BdryAmt, Incl }
Balance = { Document }
BranchAndFinancialInstitutionIdentification = { BrnchId, FinInstnId }
BranchData = { Id, Nm, PstlAdr }
CashAccount = { Ccy, Id, Nm, 1 more... }
CashAccountType = { Cd, Prtry }
CashBalanceAvailability = { Amt, CdtDbtInd, Dt }
CashBalanceAvailabilityDate = { ActlDt, NbOfDays }
ClearingSystemIdentificationChoice = { Cd, Prtry }
ClearingSystemMemberIdentification = { ClrSysId, MmbId }
ContactDetails = { EmailAdr, FaxNb, MobNb, 4 more... }
CurrencyAndAmountRange = { Amt, Ccy, CdtDbtInd }
DateAndDateTimeChoice = { Dt, DtTm }
DateAndPlaceOfBirth = { BirthDt, CityOfBirth, CtryOfBirth, 1 more... }
DateTimePeriodDetails = { FrDtTm, ToDtTm }
FinancialIdentificationSchemeNameChoice = { Cd, Prtry }
FinancialInstitutionIdentification = { BIC, ClrSysMmbId, Nm, 2 more... }
FromToAmountRange = { FrAmt, ToAmt }
GenericAccountIdentification = { Id, Issr, SchmeNm }
GenericFinancialIdentification = { Id, Issr, SchmeNm }
GenericOrganisationIdentification = { Id, Issr, SchmeNm }
GenericPersonIdentification = { Id, Issr, SchmeNm }
ImpliedCurrencyAmountRangeChoice = { EQAmt, FrAmt, FrToAmt, 2 more... }
InterestTypeChoice = { Cd, Prtry }
ISO4217Amount = { amount, currency }
OrganisationIdentification = { BICOrBEI, Othr }
OrganisationIdentificationSchemeNameChoice = { Cd, Prtry }
PartyChoice = { OrgId, PrvtId }
PartyIdentification = { CtctDtls, CtryOfRes, Id, 2 more... }
PersonIdentification = { DtAndPlcOfBirth, Othr }
PersonIdentificationSchemeNameChoice = { Cd, Prtry }
PostalAddress = { AdrLine, AdrTp, BldgNb, 7 more... }
ProprietaryBankTransactionCodeStructure = { Cd, Issr }
Rate = { Tp, VldtyRg }
RateTypeChoice = { Othr, Pctg }
TaxAmount = { Dtls, Rate, TaxblBaseAmt, 1 more... }
TaxRecord = { AddtlInf, CertId, Ctgy, 6 more... }
TaxRecordDetails = { Amt, Prd }