@mbanq/core-sdk-js / commands / GetFixedDepositAccount
Function: GetFixedDepositAccount()
GetFixedDepositAccount(
accountId):Command<{accountId:number; }, {accountChart: {accountId:number;accountNumber:string;chartSlabs:object[];fromDate:number[];id:number;isPrimaryGroupingByAmount:boolean;periodTypes:object[]; };accountNo:string;activationCharge:number;charges:object[];clientId:number;clientName:string;currency: {code:string;decimalPlaces:number;displayLabel:string;displaySymbol:string;name:string;nameCode:string; };depositAmount:number;depositPeriod:number;depositPeriodFrequency: {code:string;id:number;value:string; };depositProductId:number;depositProductName:string;depositType: {code:string;id:number;value:string; };fieldOfficerId:number;id:string;interestCompoundingPeriodType: {code:string;id:number;value:string; };interestPostingPeriodType: {code:string;id:number;value:string; };maturityAmount:number;maturityDate:number[];minBalanceForInterestCalculation:number;minDepositTerm:number;minDepositTermType: {code:string;id:number;value:string; };minRequiredOpeningBalance:number;nominalAnnualInterestRate:number;preClosurePenalApplicable:boolean;status: {active:boolean;approved:boolean;closed:boolean;code:string;id:number;matured:boolean;prematureClosed:boolean;rejected:boolean;submittedAndPendingApproval:boolean;transferInProgress:boolean;transferOnHold:boolean;value:string;withdrawnByApplicant:boolean; };summary: {accountBalance:number;availableBalance:number;currency: {code:string;decimalPlaces:number;displayLabel:string;displaySymbol:string;name:string;nameCode:string; };interestNotPosted:number;totalAnnualFees:number;totalDeposits:number;totalFeeCharge:number;totalInterestEarned:number;totalInterestPosted:number;totalOverdraftInterestDerived:number;totalPenaltyCharge:number;totalWithdrawalFees:number;totalWithdrawals:number;totalWithholdTax:number; };timeline: {activatedByFirstname?:string;activatedByLastname?:string;activatedByUsername?:string;activatedOnDate?:number[];approvedByFirstname?:string;approvedByLastname?:string;approvedByUsername?:string;approvedOnDate?:number[];submittedByFirstname:string;submittedByLastname:string;submittedByUsername:string;submittedOnDate:number[]; };transferInterestToSavings:boolean;withdrawalFeeForTransfers:boolean;withHoldTax:boolean; }>
Defined in: src/commands/rest/fixedDepositAccount.ts:98
Retrieves detailed information about a specific Fixed Deposit Account.
This API provides comprehensive details of the selected Fixed Deposit account, including:
- Account parameters (deposit amount, maturity date, interest rates)
- Associated charges and fees
- Interest rate charts and slabs
- Account status and timeline
- Summary of transactions and balances
Parameters
accountId
number
The ID of the fixed deposit account to retrieve
Returns
Command<{ accountId: number; }, { accountChart: { accountId: number; accountNumber: string; chartSlabs: object[]; fromDate: number[]; id: number; isPrimaryGroupingByAmount: boolean; periodTypes: object[]; }; accountNo: string; activationCharge: number; charges: object[]; clientId: number; clientName: string; currency: { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; name: string; nameCode: string; }; depositAmount: number; depositPeriod: number; depositPeriodFrequency: { code: string; id: number; value: string; }; depositProductId: number; depositProductName: string; depositType: { code: string; id: number; value: string; }; fieldOfficerId: number; id: string; interestCompoundingPeriodType: { code: string; id: number; value: string; }; interestPostingPeriodType: { code: string; id: number; value: string; }; maturityAmount: number; maturityDate: number[]; minBalanceForInterestCalculation: number; minDepositTerm: number; minDepositTermType: { code: string; id: number; value: string; }; minRequiredOpeningBalance: number; nominalAnnualInterestRate: number; preClosurePenalApplicable: boolean; status: { active: boolean; approved: boolean; closed: boolean; code: string; id: number; matured: boolean; prematureClosed: boolean; rejected: boolean; submittedAndPendingApproval: boolean; transferInProgress: boolean; transferOnHold: boolean; value: string; withdrawnByApplicant: boolean; }; summary: { accountBalance: number; availableBalance: number; currency: { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; name: string; nameCode: string; }; interestNotPosted: number; totalAnnualFees: number; totalDeposits: number; totalFeeCharge: number; totalInterestEarned: number; totalInterestPosted: number; totalOverdraftInterestDerived: number; totalPenaltyCharge: number; totalWithdrawalFees: number; totalWithdrawals: number; totalWithholdTax: number; }; timeline: { activatedByFirstname?: string; activatedByLastname?: string; activatedByUsername?: string; activatedOnDate?: number[]; approvedByFirstname?: string; approvedByLastname?: string; approvedByUsername?: string; approvedOnDate?: number[]; submittedByFirstname: string; submittedByLastname: string; submittedByUsername: string; submittedOnDate: number[]; }; transferInterestToSavings: boolean; withdrawalFeeForTransfers: boolean; withHoldTax: boolean; }>
A Command that when executed returns the full FixedDepositAccount details
Example
const getFDCmd = GetFixedDepositAccount(13400);
const account = await getFDCmd.execute(config);
console.log(account.accountNo, account.depositAmount);
console.log(account.status.value); // e.g., "Submitted and pending approval"
console.log(account.maturityDate); // [2025, 10, 22]