Skip to content

@mbanq/core-sdk-js v0.50.0


@mbanq/core-sdk-js / commands / GetLoanTransactionDetails

Function: GetLoanTransactionDetails()

GetLoanTransactionDetails(param): Command<{ loanId: number; transactionId: number; }, { amount: number; currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; date: number[]; feeChargesPortion?: number; fixedEmiAmount?: number; id: number; interestPortion?: number; isRevolvingLoan?: boolean; manuallyReversed?: boolean; officeId: number; officeName?: string; outstandingLoanBalance?: number; overpaymentPortion?: number; paymentDetailData?: { accountNumber?: string; bankNumber?: string; checkNumber?: string; id: number; paymentType?: { id: number; name: string; }; receiptNumber?: string; reference?: string; routingCode?: string; }; penaltyChargesPortion?: number; principalPortion?: number; submittedOnDate?: number[]; transfer?: { currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; id: number; reversed: boolean; transferAmount: number; transferDate: number[]; transferDescription?: string; }; type: { accrual: boolean; approveTransfer: boolean; chargePayment: boolean; code: string; contra: boolean; disbursement: boolean; id: number; initiateTransfer: boolean; recoveryRepayment: boolean; refund: boolean; refundForActiveLoans: boolean; rejectTransfer: boolean; repayment: boolean; repaymentAtDisbursement: boolean; value: string; waiveCharges: boolean; waiveInterest: boolean; withdrawTransfer: boolean; writeOff: boolean; }; unrecognizedIncomePortion?: number; }>

Defined in: src/commands/rest/loan.ts:635

Retrieves detailed information about a specific loan transaction. Use this to get complete transaction details including payment information, amounts breakdown, and transaction status.

Parameters

param

loanId

number = ...

transactionId

number = ...

Returns

Command<{ loanId: number; transactionId: number; }, { amount: number; currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; date: number[]; feeChargesPortion?: number; fixedEmiAmount?: number; id: number; interestPortion?: number; isRevolvingLoan?: boolean; manuallyReversed?: boolean; officeId: number; officeName?: string; outstandingLoanBalance?: number; overpaymentPortion?: number; paymentDetailData?: { accountNumber?: string; bankNumber?: string; checkNumber?: string; id: number; paymentType?: { id: number; name: string; }; receiptNumber?: string; reference?: string; routingCode?: string; }; penaltyChargesPortion?: number; principalPortion?: number; submittedOnDate?: number[]; transfer?: { currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; id: number; reversed: boolean; transferAmount: number; transferDate: number[]; transferDescription?: string; }; type: { accrual: boolean; approveTransfer: boolean; chargePayment: boolean; code: string; contra: boolean; disbursement: boolean; id: number; initiateTransfer: boolean; recoveryRepayment: boolean; refund: boolean; refundForActiveLoans: boolean; rejectTransfer: boolean; repayment: boolean; repaymentAtDisbursement: boolean; value: string; waiveCharges: boolean; waiveInterest: boolean; withdrawTransfer: boolean; writeOff: boolean; }; unrecognizedIncomePortion?: number; }>

A Command that when executed returns detailed transaction information

Example

typescript
const transactionCmd = GetLoanTransactionDetails({ loanId: 12345, transactionId: 1 });
const result = await transactionCmd.execute(config);
console.log('Transaction type:', result.type.value); // "Disbursement"
console.log('Transaction amount:', result.amount); // 5000
console.log('Payment type:', result.paymentDetailData?.paymentType?.name); // "SUBACCOUNTS"
console.log('Outstanding balance:', result.outstandingLoanBalance); // 5000

Released under the MIT License.