Skip to main content

Productinterestsettings

The interest settings, defines constraints regarding interest that will be used on the loan account crated based on this product.

accrueLateInterestboolean

Whether late interest should be accrued, applied and paid

compoundingFrequencystring

The frequency on which the accrued interest will be added to the principal for interest calculation. It is used only for InterestType.COMPOUNDING_INTEREST

Possible values: [DAILY, SEMI_ANNUALLY]

daysInYearstringrequired

The days in year that should be used for loan calculations.

Possible values: [ACTUAL_365_FIXED, ACTUAL_364, ACTUAL_360, ACTUAL_ACTUAL_ISDA, E30_360, BUS_252, E30_42_365]

decoupleInterestFromArrearsboolean

Whether interest from arrears is decoupled from regular interest. (Only accepted or returned if the feature is enabled.)

indexRateSettings object

The interest settings, defines constraints regarding interest that will be used on the loan account created based on this product.

accrueInterestAfterMaturityboolean

If the product supports this option, specify if the interest should be accrued after the account maturity date

allowNegativeInterestRateboolean

Indicator whether the loan product allows negative values for interest rate or interest spread

encodedKeystring

The encoded key of the interest rate tier, auto generated, unique

indexSourceKeystring

Index rate source key.

interestChargeFrequencystring

The interest change frequency method for a loan account. Shows the possible methods for obtaining the balance based on which the interest will be calculated for loan repayment.

Possible values: [ANNUALIZED, EVERY_MONTH, EVERY_FOUR_WEEKS, EVERY_WEEK, EVERY_DAY, EVERY_X_DAYS]

interestChargeFrequencyCountinteger<int32>

the count of units to apply over the interval

interestRate object

Decimal constraints, like min/max/default.

defaultValuenumber

The default value, will be used in case no other value was filled in by the user.

maxValuenumber

The maximum value.

minValuenumber

The minimum value.

interestRateCeilingValuenumber

Interest spread + index interest rate can't be more than this amount (valid only for index interest rate products).

interestRateFloorValuenumber

Interest spread + index interest rate can't be less than this amount (valid only for index interest rate products).

interestRateReviewCountinteger<int32>

Interest rate review frequency unit count

interestRateReviewUnitstring

The interest rate review unit values. Shows how often is index interest rate reviewed.

Possible values: [DAYS, WEEKS, MONTHS]

interestRateSourcestring

The interest rate review unit values. Shows how often is index interest rate reviewed.

Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]

interestRateTermsstring

The option for how is the interest rate determined when being accrued for an account

Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]

interestRateTiers object[]

The list of interest rate tiers available for the current settings instance

  • Array [
  • encodedKeystring

    The encoded key of the interest rate tier, auto generated, unique

    endingBalancenumber

    The top-limit value for the account balance in order to determine if this tier is used or not

    interestRatenumberrequired

    The rate used for computing the interest for an account which has the balance less than the ending balance

  • ]
  • interestApplicationMethodstring

    The interest application method for a loan account. It shows the method used by the loans defining how the interest gets applied.

    Possible values: [AFTER_DISBURSEMENT, REPAYMENT_DUE_DATE, FIXED_DAYS_OF_MONTH]

    interestBalanceCalculationMethodstring

    The interest balance calculation method for a loan account. Shows the possible methods for obtaining the balance based on which the interest will be calculated for loan repayment.

    Possible values: [ONLY_PRINCIPAL, PRINCIPAL_AND_INTEREST, PRINCIPAL_AND_FEE, PRINCIPAL_INTEREST_AND_FEE]

    interestCalculationMethodstringrequired

    The interest calculation method for a loan account. Shows the different interest calculation methods.

    Possible values: [FLAT, DECLINING_BALANCE, DECLINING_BALANCE_DISCOUNTED, EQUAL_INSTALLMENTS]

    interestRateSettings object[]

    Adjustable interest rates settings

  • Array [
  • encodedKeystring

    The encoded key of the interest rate settings, auto generated, unique

    indexSourceKeystring

    Index rate source key.

    interestRate object

    Decimal constraints, like min/max/default.

    defaultValuenumber

    The default value, will be used in case no other value was filled in by the user.

    maxValuenumber

    The maximum value.

    minValuenumber

    The minimum value.

    interestRateCeilingValuenumber

    Maximum value allowed for index based interest rate. Valid only for index interest rate.

    interestRateFloorValuenumber

    Minimum value allowed for index based interest rate. Valid only for index interest rate.

    interestRateReviewCountinteger<int32>

    Interest rate review frequency unit count. Valid only for index interest rate.

    interestRateReviewUnitstring

    The interest rate review unit values. Shows how often is index interest rate reviewed.

    Possible values: [DAYS, WEEKS, MONTHS]

    interestRateSourcestringrequired

    The interest rate review unit values. Shows how often is index interest rate reviewed.

    Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]

  • ]
  • interestTypestring

    The possible values for how we compute and apply the interest

    Possible values: [SIMPLE_INTEREST, CAPITALIZED_INTEREST, COMPOUNDING_INTEREST]

    pmtAdjustmentThreshold object

    Represents PMT Adjustment threshold settings for loan accounts and loan products.

    methodstring

    Represents the method used to calculate the PMT adjustment threshold. Supported value is CALENDAR_DAYS

    Possible values: [WORKING_DAYS, CALENDAR_DAYS]

    numberOfDaysinteger<int32>

    The number of days that trigger a PMT Adjustment.

    scheduleInterestDaysCountMethodstringrequired

    Shows whether all the installments should compute the interest based on the actual number of days or based on the defined repayment periodicity.

    Possible values: [REPAYMENT_PERIODICITY, ACTUAL_DAYS_COUNT]

    Productinterestsettings
    {
    "accrueLateInterest": true,
    "compoundingFrequency": "DAILY",
    "daysInYear": "ACTUAL_365_FIXED",
    "decoupleInterestFromArrears": true,
    "indexRateSettings": {
    "accrueInterestAfterMaturity": true,
    "allowNegativeInterestRate": true,
    "encodedKey": "string",
    "indexSourceKey": "string",
    "interestChargeFrequency": "ANNUALIZED",
    "interestChargeFrequencyCount": 0,
    "interestRate": {
    "defaultValue": 0,
    "maxValue": 0,
    "minValue": 0
    },
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "DAYS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "FIXED",
    "interestRateTiers": [
    {
    "encodedKey": "string",
    "endingBalance": 0,
    "interestRate": 0
    }
    ]
    },
    "interestApplicationMethod": "AFTER_DISBURSEMENT",
    "interestBalanceCalculationMethod": "ONLY_PRINCIPAL",
    "interestCalculationMethod": "FLAT",
    "interestRateSettings": [
    {
    "encodedKey": "string",
    "indexSourceKey": "string",
    "interestRate": {
    "defaultValue": 0,
    "maxValue": 0,
    "minValue": 0
    },
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "DAYS",
    "interestRateSource": "FIXED_INTEREST_RATE"
    }
    ],
    "interestType": "SIMPLE_INTEREST",
    "pmtAdjustmentThreshold": {
    "method": "WORKING_DAYS",
    "numberOfDays": 0
    },
    "scheduleInterestDaysCountMethod": "REPAYMENT_PERIODICITY"
    }