@mbanq/core-sdk-js / commands / GetCreditProduct
Function: GetCreditProduct()
GetCreditProduct(
creditProductId):Command<{creditProductId:number; }, {accountingRule: {code:string;id:number;value:string; };charges:object[];currency: {code:string;decimalPlaces:number;displayLabel:string;displaySymbol:string;inMultiplesOf:number;name:string;nameCode:string; };description:string;gracePeriod: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; };isFloatingInterestRateCalculationAllowed:boolean;isLinkedToFloatingInterestRates:boolean;isLinkedWithFundSourceAccount:boolean;isSecuredCreditProduct:boolean;isUsedForSuspenseAccounting:boolean;minimumPayCalculationRate:number;name:string;nominalAnnualInterestRate:number;nominalAnnualPenaltyInterestRate:number;nominalCashAdvanceInterestRate:number;reserveProduct?: {allowOverdraft:boolean;enforceMinRequiredBalance:boolean;id:number;isFloatingInterestRateCalculationAllowed:boolean;isLinkedToFloatingInterestRates:boolean;isLinkedWithFundSourceAccount:boolean;isReservedProduct:boolean;isSkipCollectTransferCharge:boolean;isUsedForSuspenseAccounting:boolean;withdrawalFeeForTransfers:boolean;withHoldTax:boolean; };shortName:string; }>
Defined in: src/commands/rest/creditCardProduct.ts:71
Get a credit product by ID
This command retrieves the details of a specific credit product using its unique ID.
Parameters
creditProductId
number
The ID of the credit product to retrieve
Returns
Command<{ creditProductId: number; }, { accountingRule: { code: string; id: number; value: string; }; charges: object[]; currency: { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; name: string; nameCode: string; }; description: string; gracePeriod: 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; }; isFloatingInterestRateCalculationAllowed: boolean; isLinkedToFloatingInterestRates: boolean; isLinkedWithFundSourceAccount: boolean; isSecuredCreditProduct: boolean; isUsedForSuspenseAccounting: boolean; minimumPayCalculationRate: number; name: string; nominalAnnualInterestRate: number; nominalAnnualPenaltyInterestRate: number; nominalCashAdvanceInterestRate: number; reserveProduct?: { allowOverdraft: boolean; enforceMinRequiredBalance: boolean; id: number; isFloatingInterestRateCalculationAllowed: boolean; isLinkedToFloatingInterestRates: boolean; isLinkedWithFundSourceAccount: boolean; isReservedProduct: boolean; isSkipCollectTransferCharge: boolean; isUsedForSuspenseAccounting: boolean; withdrawalFeeForTransfers: boolean; withHoldTax: boolean; }; shortName: string; }>
Command object that executes the API request and returns the credit product details
Example
const command = GetCreditProduct(1);
const result = await client.request(command);