Skip to main content

Interestproductsettings

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

  • ]
  • Interestproductsettings
    {
    "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
    }
    ]
    }