@mbanq/core-sdk-js / commands / GetCreditAccountDetails
Function: GetCreditAccountDetails()
GetCreditAccountDetails(
creditAccountId):Command<{creditAccountId:number; }, {accountNo:string;arrearsAgingData: {daysPastDue:number;overdueAmount:number;overdueSinceDate:number[]; };bankDetails: {address:string;city:string;name:string;postcode:string;routingNumber:string;swiftCode:string; };cashLimit:number;clientId:number;clientName:string;creditLimit:number;creditProductId:number;creditProductName:string;currency: {code:string;currencyCodeInDigit:number;decimalPlaces:number;displayLabel:string;displaySymbol:string;inMultiplesOf:number;isBaseCurrency:boolean;name:string;nameCode:string; };currentAccountId:number;depositType: {code:string;id:number;value:string; };disputedAmount:number;id:number;interestCalculationDaysInYearType: {code:string;id:number;value:string; };interestCalculationType: {code:string;id:number;value:string; };interestCompoundingPeriodType: {code:string;id:number;value:string; };interestPostingPeriodType: {code:string;id:number;value:string; };isLinkedToFloatingRate:boolean;isSecuredCreditProduct:boolean;nominalAnnualInterestRate:number;nominalAnnualPenaltyInterestRate:number;nominalCashAdvanceInterestRate:number;onHoldFunds:number;reserveAccountId:number;reserveProductId:number;status: {active:boolean;approved:boolean;closed:boolean;code:string;id:number;rejected:boolean;submittedAndPendingApproval:boolean;value:string;withdrawnByApplicant:boolean; };subStatus: {block:boolean;blockCredit:boolean;blockDebit:boolean;code:string;dormant:boolean;escheat:boolean;id:number;inactive:boolean;none:boolean;value:string; };summary: {availableCashLimit:number;availableCreditLimit:number;cashLimit:number;creditLimit:number;currency: {code:string;currencyCodeInDigit:number;decimalPlaces:number;displayLabel:string;displaySymbol:string;inMultiplesOf:number;isBaseCurrency:boolean;name:string;nameCode:string; };currentBalance:number;cycleStartDate:number[];lastStatementDetails: {dueDate:number[];endDate:number[];lastStatementAmount:number;minimumDue:number;paymentStatus:string;startDate:number[]; };nextClosingDate:number[];totalAnnualFees:number;totalDeposits:number;totalExcessBalance:number;totalFeeCharge:number;totalInterestPosted:number;totalPenaltyCharge:number;totalWithdrawalFees:number;totalWithdrawals:number;unBilledAmount:number; };timeline: {activatedByFirstname:string|null;activatedByLastname:string|null;activatedByUsername:string|null;activatedOnDate:number[] |null;approvedByFirstname:string|null;approvedByLastname:string|null;approvedByUsername:string|null;approvedOnDate:number[] |null;submittedByFirstname:string;submittedByLastname:string;submittedByUsername:string;submittedOnDate:number[]; }; }>
Defined in: src/commands/rest/creditAccount.ts:210
Get credit account details by ID
Retrieves comprehensive details of a credit account including account status, balances, credit limits, billing cycle information, autopay settings, and payment history.
Parameters
creditAccountId
number
The unique identifier of the credit account
Returns
Command<{ creditAccountId: number; }, { accountNo: string; arrearsAgingData: { daysPastDue: number; overdueAmount: number; overdueSinceDate: number[]; }; bankDetails: { address: string; city: string; name: string; postcode: string; routingNumber: string; swiftCode: string; }; cashLimit: number; clientId: number; clientName: string; creditLimit: number; creditProductId: number; creditProductName: string; currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; currentAccountId: number; depositType: { code: string; id: number; value: string; }; disputedAmount: number; id: number; interestCalculationDaysInYearType: { code: string; id: number; value: string; }; interestCalculationType: { code: string; id: number; value: string; }; interestCompoundingPeriodType: { code: string; id: number; value: string; }; interestPostingPeriodType: { code: string; id: number; value: string; }; isLinkedToFloatingRate: boolean; isSecuredCreditProduct: boolean; nominalAnnualInterestRate: number; nominalAnnualPenaltyInterestRate: number; nominalCashAdvanceInterestRate: number; onHoldFunds: number; reserveAccountId: number; reserveProductId: number; status: { active: boolean; approved: boolean; closed: boolean; code: string; id: number; rejected: boolean; submittedAndPendingApproval: boolean; value: string; withdrawnByApplicant: boolean; }; subStatus: { block: boolean; blockCredit: boolean; blockDebit: boolean; code: string; dormant: boolean; escheat: boolean; id: number; inactive: boolean; none: boolean; value: string; }; summary: { availableCashLimit: number; availableCreditLimit: number; cashLimit: number; creditLimit: number; currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; currentBalance: number; cycleStartDate: number[]; lastStatementDetails: { dueDate: number[]; endDate: number[]; lastStatementAmount: number; minimumDue: number; paymentStatus: string; startDate: number[]; }; nextClosingDate: number[]; totalAnnualFees: number; totalDeposits: number; totalExcessBalance: number; totalFeeCharge: number; totalInterestPosted: number; totalPenaltyCharge: number; totalWithdrawalFees: number; totalWithdrawals: number; unBilledAmount: number; }; timeline: { activatedByFirstname: string | null; activatedByLastname: string | null; activatedByUsername: string | null; activatedOnDate: number[] | null; approvedByFirstname: string | null; approvedByLastname: string | null; approvedByUsername: string | null; approvedOnDate: number[] | null; submittedByFirstname: string; submittedByLastname: string; submittedByUsername: string; submittedOnDate: number[]; }; }>
Command object that executes the API request and returns credit account details
Example
const command = GetCreditAccountDetails(388);
const accountDetails = await client.request(command);