Balance Inquiry (Extended)
Returns an extended version of Balance Inquiry, including accrued amounts, unpaid amounts, and withheld amounts.
GET /api/account/v1/GetExtendedBalanceByAccountNumber
Headers
Content-Type*
application/jsona
Authorization*
bearer <token>
request-reference*
{unique_reference}
Params
AccountNumber
string
Required
The account number to retrieve extended balance details for
Body
accountNumber
string
The account number balance details belong to
accountName
string
The customer/account name
referenceNumber
string
System reference number for the account
productName
string
Name of the account product
accountStatus
string
Current status of the account (e.g. Active, Dormant, Frozen)
accountOfficerName
string
Name of the account officer managing the account
accountOfficerCode
string
Code identifying the account officer
accountOfficerID
string
Unique ID of the account officer
branchName
string
Branch where the account is domiciled
branchCode
string
Code of the branch where the account is domiciled
overdraftLimit
string
Approved overdraft limit on the account
ledgerBalance
string
Full account balance including uncleared funds
availableBalance
string
Balance currently available for use
withdrawableBalance
string
Balance that can actually be withdrawn
unclearedEffect
string
Total value of uncleared funds affecting the balance
overdrawnAmount
string
Amount by which the account is currently overdrawn
unpaidOverdraftInterest
string
Unpaid interest accrued on the overdraft
unpaidAccountOpeningFee
string
Unpaid account opening fee
unpaidAccountMaintenanceFee
string
Unpaid account maintenance fee
unpaidCOTFee
string
Unpaid Commission on Turnover (COT) fee
unpaidOverdraftFee
string
Unpaid overdraft management fee
unpaidSMSFee
string
Unpaid SMS alert fee
totalOutstandingOverdraft
string
Total outstanding overdraft balance
unpaidLoanPrincipal
string
Unpaid principal on any loan linked to the account
unpaidLoanInterest
string
Unpaid interest on any loan linked to the account
unpaidLoanFee
string
Unpaid fees on any loan linked to the account
unpaidLoanPenalty
string
Unpaid penalty charges on any loan linked to the account
defaultingLoanInterest
string
Interest accrued due to loan default
totalOutstandingLoan
string
Total outstanding loan balance
hasLoanOutstandingAmount
boolean
Whether the account has any outstanding loan amount
accruedCOTFee
string
COT fee accrued but not yet charged
accruedSMSFee
string
SMS fee accrued but not yet charged
accruedLoanInterest
string
Loan interest accrued but not yet charged
accruedSavingsInterest
string
Savings interest accrued but not yet paid out
accruedOverdraftInterest
string
Overdraft interest accrued but not yet charged
totalAccruedAmount
string
Sum of all accrued amounts on the account
securityDeposit
string
Security deposit held against the account
repaymentLien
string
Amount placed on lien for loan repayment
productMinimumBalance
string
Minimum balance required by the account product
totalWithheldAmount
string
Total amount currently withheld on the account
percentageLien
string
Lien amount calculated as a percentage of balance
flatLien
string
Lien amount applied as a flat value
totalLien
string
Combined total of all liens on the account
memos
array
Log of actions/notes recorded against the account
Here is an example request and response with a sample payload sent to the endpoint in Curl format.
Sample API Request
Response
Last updated