Skip to content

@mbanq/core-sdk-js v0.50.0


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

Function: CreateCreditProduct() ​

CreateCreditProduct(data): Command<{ data: { accountingRule: number; charges?: object[]; creditPortfolioAccountId?: number; currencyCode: string; description: string; digitsAfterDecimal: number; disputesInSuspenseAccountId?: number; feeToIncomeAccountMappings?: string; fundSourceAccountId?: number; graceForArrearsAging?: number; gracePeriod: number; incomeFromFeeAccountId?: number; incomeFromPenaltyAccountId?: number; incomeFromRecoveryAccountId?: number; inMultiplesOf: number; interestCalculationDaysInYearType: number; interestCalculationType: number; interestCompoundingPeriodType: number; interestOnIncomeAccountId?: number; interestPostingPeriodType: number; isLinkedToFloatingInterestRates: boolean; isSecuredCreditProduct: boolean; locale?: string; minimumPayCalculationRate: number; minimumPayFixedAmount: number; name: string; nominalAnnualInterestRate: number; nominalAnnualPenaltyInterestRate: number; nominalCashAdvanceInterestRate: number; overpaymentLiabilityAccountId?: number; paymentChannelToFundSourceMappings?: string; penaltyToIncomeAccountMappings?: string; receivableFeeAccountId?: number; receivableInterestAccountId?: number; receivablePenaltyAccountId?: number; shortName: string; statementDay: number; transfersInSuspenseAccountId?: number; writeOffAccountId?: number; }; }, { clientId: number; id: string; resourceId: number; resourceIdentifier?: string; }>

Defined in: src/commands/rest/creditCardProduct.ts:33

Create a new credit product

This command allows you to create a new credit product with specific configurations such as interest rates, compounding periods, and accounting rules.

Parameters ​

data ​

The credit product configuration data

accountingRule ​

number = ...

charges? ​

object[] = ...

creditPortfolioAccountId? ​

number = ...

currencyCode ​

string = ...

description ​

string = ...

digitsAfterDecimal ​

number = ...

disputesInSuspenseAccountId? ​

number = ...

feeToIncomeAccountMappings? ​

string = ...

fundSourceAccountId? ​

number = ...

graceForArrearsAging? ​

number = ...

gracePeriod ​

number = ...

incomeFromFeeAccountId? ​

number = ...

incomeFromPenaltyAccountId? ​

number = ...

incomeFromRecoveryAccountId? ​

number = ...

inMultiplesOf ​

number = ...

interestCalculationDaysInYearType ​

number = ...

interestCalculationType ​

number = ...

interestCompoundingPeriodType ​

number = ...

interestOnIncomeAccountId? ​

number = ...

interestPostingPeriodType ​

number = ...

isLinkedToFloatingInterestRates ​

boolean = ...

isSecuredCreditProduct ​

boolean = ...

locale? ​

string = ...

minimumPayCalculationRate ​

number = ...

minimumPayFixedAmount ​

number = ...

name ​

string = ...

nominalAnnualInterestRate ​

number = ...

nominalAnnualPenaltyInterestRate ​

number = ...

nominalCashAdvanceInterestRate ​

number = ...

overpaymentLiabilityAccountId? ​

number = ...

paymentChannelToFundSourceMappings? ​

string = ...

penaltyToIncomeAccountMappings? ​

string = ...

receivableFeeAccountId? ​

number = ...

receivableInterestAccountId? ​

number = ...

receivablePenaltyAccountId? ​

number = ...

shortName ​

string = ...

statementDay ​

number = ...

transfersInSuspenseAccountId? ​

number = ...

writeOffAccountId? ​

number = ...

Returns ​

Command<{ data: { accountingRule: number; charges?: object[]; creditPortfolioAccountId?: number; currencyCode: string; description: string; digitsAfterDecimal: number; disputesInSuspenseAccountId?: number; feeToIncomeAccountMappings?: string; fundSourceAccountId?: number; graceForArrearsAging?: number; gracePeriod: number; incomeFromFeeAccountId?: number; incomeFromPenaltyAccountId?: number; incomeFromRecoveryAccountId?: number; inMultiplesOf: number; interestCalculationDaysInYearType: number; interestCalculationType: number; interestCompoundingPeriodType: number; interestOnIncomeAccountId?: number; interestPostingPeriodType: number; isLinkedToFloatingInterestRates: boolean; isSecuredCreditProduct: boolean; locale?: string; minimumPayCalculationRate: number; minimumPayFixedAmount: number; name: string; nominalAnnualInterestRate: number; nominalAnnualPenaltyInterestRate: number; nominalCashAdvanceInterestRate: number; overpaymentLiabilityAccountId?: number; paymentChannelToFundSourceMappings?: string; penaltyToIncomeAccountMappings?: string; receivableFeeAccountId?: number; receivableInterestAccountId?: number; receivablePenaltyAccountId?: number; shortName: string; statementDay: number; transfersInSuspenseAccountId?: number; writeOffAccountId?: number; }; }, { clientId: number; id: string; resourceId: number; resourceIdentifier?: string; }>

Command object that executes the API request and returns the created product ID

Example ​

typescript
const command = CreateCreditProduct({
  currencyCode: "USD",
  digitsAfterDecimal: 2,
  // ... other parameters
});
const result = await client.request(command);

Released under the MIT License.