Loanproduct
Represents a loan product.
accountLinkSettings object
Defines the settings for account linking.
Shows whether the loan accounts created using this product can be linked to a savings account.
Loan accounts created for this product can only be linked the the savings accounts that use the savings product with this key. If null, the loan accounts for this product can be linked to any savings account.
A set of linked account options.
Possible values: [AUTO_LINK_ACCOUNTS, AUTO_CREATE_LINKED_ACCOUNTS]
Set the option of automated transfer that should be made from linked deposit accounts into loan accounts create from this product.
Possible values: [FULL_DUE_AMOUNTS, PARTIAL_DUE_AMOUNTS, NO_AUTOMATED_TRANSFERS]
accountingSettings object
Accounting settings, defines the accounting settings for the product.
The calculation method used for accounting.
Possible values: [NONE, CASH, ACCRUAL]
accountingRules object[]
A list of accounting rules for the product.
The encoded key of the accounting rule, auto generated, unique.
General Ledger Financial Resources used to setup the product accounting rules and determine the credit and debit accounts when logging journal entries
Possible values: [PORTFOLIO_CONTROL, FUND_SOURCE, WRITE_OFF_EXPENSE, INTEREST_INCOME, PAYMENT_HOLIDAY_INTEREST_INCOME, TAXES_PAYABLE, FEE_INCOME, PENALTY_INCOME, NEGATIVE_INTEREST_PAYABLE_RECEIVABLE, NEGATIVE_INTEREST_PAYABLE, INTEREST_RECEIVABLE, PAYMENT_HOLIDAY_INTEREST_RECEIVABLE, FEE_RECEIVABLE, PENALTY_RECEIVABLE, TAXES_RECEIVABLE, DEFERRED_INTERESTS_INCOME, DEFERRED_FEE_INCOME, DEFERRED_TAXES, DEPOSIT_REFERENCE, SAVINGS_CONTROL, INTEREST_EXPENSE, INTEREST_PAYABLE, NEGATIVE_INTEREST_INCOME, NEGATIVE_INTEREST_RECEIVABLE, OVERDRAFT_PORTFOLIO_CONTROL, OVERDRAFT_INTEREST_INCOME, OVERDRAFT_WRITE_OFF_EXPENSE, OVERDRAFT_INTEREST_RECEIVABLE, INTER_BRANCH_TRANSFER, INTEREST_FROM_ARREARS_INCOME, INTEREST_FROM_ARREARS_RECEIVABLE, INTEREST_FROM_ARREARS_WRITE_OFF_EXPENSE, PROFIT_EXPENSE, PROFIT_PAYABLE, MUDARIB_SHARE, DISTRIBUTABLE_PROFIT, INTEREST_FROM_FEES_INCOME, INTEREST_FROM_FEES_RECEIVABLE, INTEREST_FROM_FEES_WRITE_OFF_EXPENSE, CREDIT_BALANCE_PAYABLE]
The encoded key of the account that is mapped to the financialResource
The key of the transaction rule that uses this rule
The accounting interest calculation option selected for the product.
Possible values: [NONE, AGGREGATED_AMOUNT, BREAKDOWN_PER_ACCOUNT]
The interval defined for a product when the interest accrues should be maintained.
Possible values: [NONE, DAILY, END_OF_MONTH]
TRUE if it is possible to adjust the interest for the first repayment when the first repayment period is different than the repayment frequency, FALSE otherwise.
TRUEif it is possible to adjust the total due for the repayment when the repayment period is different than the repayment frequency,FALSE` otherwise.
True if advance repayment is allowed; false otherwise.
TRUE if an additional payment may be allocated on the account, ignoring the default repayment allocation order, FALSE otherwise.
arrearsSettings object
The product arrears settings, shows whether the non working days are taken in consideration or not when applying penalties/late fees or when setting an account into arrears
The arrears date calculation method.
Possible values: [ACCOUNT_FIRST_WENT_TO_ARREARS, LAST_LATE_REPAYMENT, ACCOUNT_FIRST_BREACHED_MATERIALITY_THRESHOLD]
The encoded key of the arrears base settings, auto generated, unique.
Defines the tolerance monthly date
Shows whether the non working days are taken in consideration or not when applying penaltees/late fees or when setting an account into arrears
Possible values: [INCLUDED, EXCLUDED]
Defines the tolerance calculation method
Possible values: [ARREARS_TOLERANCE_PERIOD, MONTHLY_ARREARS_TOLERANCE_DAY]
The tolerance floor amount.
tolerancePercentageOfOutstandingPrincipal object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
tolerancePeriod object
Decimal integer, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the integer constraint, auto generated, unique
The maximum value.
The minimum value.
availabilitySettings object
Holds information about product availability.
Holds the entities this product is available for. i.e Individuals
Possible values: [INDIVIDUALS, PURE_GROUPS, SOLIDARITY_GROUPS]
branchSettings object
Holds information about branch availability for the product.
Holds the encoded keys of the branches this product should be available for.
Indicates if this product should be available for all branches
The category of the loan product.
Possible values: [PERSONAL_LENDING, PURCHASE_FINANCING, RETAIL_MORTGAGES, SME_LENDING, COMMERCIAL, UNCATEGORIZED]
The date the loan product was created.
2016-09-06T13:37:50+03:00creditArrangementSettings objectrequired
The funding settings, holds the settings regarding the funding for the loan product.
Shows whether accounts created after this product can/should be part of a line of credit.
Possible values: [OPTIONAL, REQUIRED, NOT_REQUIRED]
currency object
Represents a currency eg. USD, EUR.
Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.
Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SLE, SOS, SRD, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VEF, VES, VND, VUV, WST, XAG, XAU, XAF, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZIG, ZWG, ZMK, ZWL, ZMW, SSP, NON_FIAT]
Currency code for NON_FIAT currency.
The encoded key of the loan product, it is auto generated, and unique.
feesSettings object
Defines fees settings for the product.
Only if true users will be able to apply fees, for current object, of type 'Other'; these fees can have any amount.
fees object[]
List of all fees that can be applied for accounts of this loan product.
accountingRules object[]
A list of accounting rules defined for this fee. If null, product default rules are selected.
The encoded key of the accounting rule, auto generated, unique.
General Ledger Financial Resources used to setup the product accounting rules and determine the credit and debit accounts when logging journal entries
Possible values: [PORTFOLIO_CONTROL, FUND_SOURCE, WRITE_OFF_EXPENSE, INTEREST_INCOME, PAYMENT_HOLIDAY_INTEREST_INCOME, TAXES_PAYABLE, FEE_INCOME, PENALTY_INCOME, NEGATIVE_INTEREST_PAYABLE_RECEIVABLE, NEGATIVE_INTEREST_PAYABLE, INTEREST_RECEIVABLE, PAYMENT_HOLIDAY_INTEREST_RECEIVABLE, FEE_RECEIVABLE, PENALTY_RECEIVABLE, TAXES_RECEIVABLE, DEFERRED_INTERESTS_INCOME, DEFERRED_FEE_INCOME, DEFERRED_TAXES, DEPOSIT_REFERENCE, SAVINGS_CONTROL, INTEREST_EXPENSE, INTEREST_PAYABLE, NEGATIVE_INTEREST_INCOME, NEGATIVE_INTEREST_RECEIVABLE, OVERDRAFT_PORTFOLIO_CONTROL, OVERDRAFT_INTEREST_INCOME, OVERDRAFT_WRITE_OFF_EXPENSE, OVERDRAFT_INTEREST_RECEIVABLE, INTER_BRANCH_TRANSFER, INTEREST_FROM_ARREARS_INCOME, INTEREST_FROM_ARREARS_RECEIVABLE, INTEREST_FROM_ARREARS_WRITE_OFF_EXPENSE, PROFIT_EXPENSE, PROFIT_PAYABLE, MUDARIB_SHARE, DISTRIBUTABLE_PROFIT, INTEREST_FROM_FEES_INCOME, INTEREST_FROM_FEES_RECEIVABLE, INTEREST_FROM_FEES_WRITE_OFF_EXPENSE, CREDIT_BALANCE_PAYABLE]
The encoded key of the account that is mapped to the financialResource
The key of the transaction rule that uses this rule
amortizationSettings object
The settings for defining period intervals.
Type of amortization profile used for fee
Possible values: [NONE, SUM_OF_YEARS_DIGITS, STRAIGHT_LINE, EFFECTIVE_INTEREST_RATE]
The encoded key of the period interval settings, auto generated, unique.
Flag for signaling if fee amortization should be continued or finished at account reschedule/refinance
Possible values: [END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT, CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT]
Frequency settings of the fee amortization
Possible values: [ACCOUNT_INSTALLMENTS_DUE_DATES, ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING, CUSTOM_INTERVAL]
Total number of intervals
Defines the options for an interval
Possible values: [PREDEFINED_INTERVALS, FULL_TERM]
Period count used in conjunction with periodUnit to determine the next date of the interval
Amortization unit to determine the interval between amortizations
Possible values: [DAYS, WEEKS, MONTHS, YEARS]
The amount of the fee
Mambu Function name used for the fee calculation
The amount from which the fee is calculated using percentageAmount
Possible values: [FLAT, LOAN_AMOUNT_PERCENTAGE, REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE, LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS, FLAT_NUMBER_OF_INSTALLMENTS, IOF_PERCENTAGE_OF_DISBURSED_AMOUNT, IOF_PERCENTAGE_OF_INSTALLMENT_PRINCIPAL, IOF_PERCENTAGE_OF_LATE_INSTALLMENT_PRINCIPAL, MAMBU_FUNCTION, FEE_RATE_ON_OUTSTANDING_PRINCIPAL]
Shows when a fee should be applied; to be used with monthly deposit fees
Possible values: [MONTHLY_FROM_ACTIVATION, FIRST_OF_EVERY_MONTH]
Shows the creation date of the fee
2016-09-06T13:37:50+03:00The rate of the fee applied to parentSource
The encoded key of the predefined fee, auto generated, unique
The type of fee application when disbursement is applied
Possible values: [REQUIRED, OPTIONAL]
The id of the fee
Indicates if the fee can be included in penalty calculation
Indication if the fee bears interest
Shows the last modified date of the fee
2016-09-06T13:37:50+03:00The name of the fee
The amount of the fee in percents applied to percentSource
Method to allocate a fee to installments on the schedule
Possible values: [ON_INSTALLMENT, NO_ALLOCATION]
Indicates the state of the fee
Possible values: [ACTIVE, INACTIVE]
taxSettings object
Tax settings for a specific Predefined fee that overrides the tax settings of Loan Product
Marks a specific fee as non-taxable (taxes are not calculated for it).Feature is in the Early Stage. To be enabled by request.
Possible values: [DEFAULT, NON_TAXABLE, CUSTOM_TAX]
Shows the event that will trigger a fee
Possible values: [MANUAL, MANUAL_PLANNED, DISBURSEMENT, CAPITALIZED_DISBURSEMENT, UPFRONT_DISBURSEMENT, LATE_REPAYMENT, PAYMENT_DUE, PAYMENT_DUE_APPLIED_ON_DUE_DATES, ARBITRARY, IOF, EARLY_REPAYMENT_CHARGE, FEE_INCLUDED_IN_PMT]
fundingSettings object
The funding settings, holds the settings regarding the funding for the loan product.
Indicates whether the product has the investor funds enabled or not.
funderInterestCommission object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the decimal constraint, auto generated, unique
The maximum value.
The minimum value.
Define how the Interest is allocated to the investors(if the investors can define their own percentages for their own contribution to the loan, or if all of them are using the same percentage).
Possible values: [PERCENTAGE_OF_LOAN_FUNDING, FIXED_INTEREST_COMMISSIONS]
Shows whether investor funds are locked or not at the loan account's approval.
organizationInterestCommission object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the decimal constraint, auto generated, unique
The maximum value.
The minimum value.
The required investor funds percentage, for opening an account with external funding. If null, the investor funds are not enabled.
gracePeriodSettings object
The funding settings, holds the settings regarding the funding for the loan product.
gracePeriod object
Decimal integer, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the integer constraint, auto generated, unique
The maximum value.
The minimum value.
The grace period type for a loan account.
Possible values: [NONE, PAY_INTEREST_ONLY, INTEREST_FORGIVENESS]
The ID of the loan product, can be generated and customized, and must be unique.
interestSettings object
The interest settings, defines constraints regarding interest that will be used on the loan account crated based on this product.
Whether late interest should be accrued, applied and paid
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]
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]
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.
If the product supports this option, specify if the interest should be accrued after the account maturity date
Indicator whether the loan product allows negative values for interest rate or interest spread
The encoded key of the interest rate tier, auto generated, unique
Index rate source key.
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]
the count of units to apply over the interval
interestRate object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
Interest spread + index interest rate can't be more than this amount (valid only for index interest rate products).
Interest spread + index interest rate can't be less than this amount (valid only for index interest rate products).
Interest rate review frequency unit count
The interest rate review unit values. Shows how often is index interest rate reviewed.
Possible values: [DAYS, WEEKS, MONTHS]
The interest rate review unit values. Shows how often is index interest rate reviewed.
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
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
The encoded key of the interest rate tier, auto generated, unique
The top-limit value for the account balance in order to determine if this tier is used or not
The rate used for computing the interest for an account which has the balance less than the ending balance
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]
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]
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
The encoded key of the interest rate settings, auto generated, unique
Index rate source key.
interestRate object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
Maximum value allowed for index based interest rate. Valid only for index interest rate.
Minimum value allowed for index based interest rate. Valid only for index interest rate.
Interest rate review frequency unit count. Valid only for index interest rate.
The interest rate review unit values. Shows how often is index interest rate reviewed.
Possible values: [DAYS, WEEKS, MONTHS]
The interest rate review unit values. Shows how often is index interest rate reviewed.
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
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.
Represents the method used to calculate the PMT adjustment threshold. Supported value is CALENDAR_DAYS
Possible values: [WORKING_DAYS, CALENDAR_DAYS]
The number of days that trigger a PMT Adjustment.
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]
internalControls object
Constraints and automated actions and that will be applied on the accounts.
Specifies the number of days for an account to be fully paid in order to auto close it.
fourEyesPrinciple object
Settings for Four Eyes Principle
Requires separate users to create and approve loan accounts
lockSettings object
Settings applied when transitioning accounts to Locked state
Specifies constraint types for capping charges.
Possible values: [SOFT_CAP, HARD_CAP]
Specifies how principal will be used when calculating capping charges.
Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, ORIGINAL_PRINCIPAL_PERCENTAGE]
Specifies the percentage of principal that cannot be exceeded by the sum of interest, fees and penalty balances.
Specifies the number of days for in which the account will be locked if it stays in arrears.
The last date the loan product was updated.
2016-09-06T13:37:50+03:00loanAmountSettings object
The amount settings, holds all amount properties.
loanAmount object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the decimal constraint, auto generated, unique
The maximum value.
The minimum value.
trancheSettings object
The tranche settings, indicates the settings regarding tranches in case the product is configured to support tranches.
The number of tranches supported by the loan product
The name of the loan product.
newAccountSettings object
The new account settings, defines the settings and constraints used by new loan account created based on this product.
All the generic account states applicable to loans.
Possible values: [PARTIAL_APPLICATION, PENDING_APPROVAL, APPROVED, ACTIVE, ACTIVE_IN_ARREARS, CLOSED, CLOSED_WRITTEN_OFF, CLOSED_REJECTED]
The type of generator used for IDs creation.
Possible values: [INCREMENTAL_NUMBER, RANDOM_PATTERN]
The pattern that will be used for ID validation (as referred to as an input mask).
The notes or description of the loan product.
offsetSettings object
The offset settings, holds information about offset.
Indicates whether the product supports offset
paymentSettings object
Defines the payment settings for the loan product and for loans crated based on this product.
Payments Method used by loan accounts for repayments schedule generation.
Possible values: [STANDARD_PAYMENTS, BALLOON_PAYMENTS, OPTIMIZED_PAYMENTS, PAYMENT_PLAN]
The late payment recalculation method. Is used by loan accounts to have the schedule recalculated when late payments are posted on accounts..
Possible values: [OVERDUE_INSTALLMENTS_INCREASE, LAST_INSTALLMENT_INCREASE, NO_RECALCULATION]
The payment allocation method used by the loans defining how the payments get performed.
Possible values: [HORIZONTAL, VERTICAL]
prepaymentSettings object
Defines the prepayment settings for the product
The apply interest method type for pre-payments.
Possible values: [AUTOMATIC, MANUAL]
The elements recalculation method types
Possible values: [PRINCIPAL_EXPECTED_FIXED, TOTAL_EXPECTED_FIXED]
ERC free allowance in percentage
Shows whether the future payments are allowed or not for this product (repayment transactions with entry date set in the future)
Possible values: [NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS, ACCEPT_OVERPAYMENTS]
Shows whether the pre-payments are allowed or not for this product.
Possible values: [ACCEPT_PREPAYMENTS, NO_PREPAYMENTS]
The prepayment recalculation method types.
Possible values: [NO_RECALCULATION, RESCHEDULE_REMAINING_REPAYMENTS, RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS, RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT, RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT, REDUCE_AMOUNT_PER_INSTALLMENT, REDUCE_NUMBER_OF_INSTALLMENTS, REDUCE_NUMBER_OF_INSTALLMENTS_NEW]
The status of installment after the principal was paid off as part of an over-payment.
Possible values: [PARTIALLY_PAID, PAID, ORIGINAL_TOTAL_EXPECTED_PAID]
principalPaymentSettings object
Defines the principal payment settings constraints for the loans that will be created based on this product.
amount object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the decimal constraint, auto generated, unique
The maximum value.
The minimum value.
How many repayments the principal has to be paid
The encoded key of the settings, auto generated, unique
If true, the fees will be included along with the principal in the repayment floor amount, for a revolving credit account
If true, the interest will be included along with the principal in the repayment floor amount, for a revolving credit account
percentage object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the decimal constraint, auto generated, unique
The maximum value.
The minimum value.
The maximum principal due amount a repayment made with this settings can have
The minimum principal due amount a repayment made with this settings can have
The principal payment method (for revolving credits)
Possible values: [FLAT, OUTSTANDING_PRINCIPAL_PERCENTAGE, PRINCIPAL_PERCENTAGE_LAST_DISB, TOTAL_BALANCE_PERCENTAGE, TOTAL_BALANCE_FLAT, TOTAL_PRINCIPAL_PERCENTAGE]
The minimum total due amount a repayment made with this settings can have
The principal payment method (for revolving credits)
Possible values: [FLAT, OUTSTANDING_PRINCIPAL_PERCENTAGE, PRINCIPAL_PERCENTAGE_LAST_DISB, TOTAL_BALANCE_PERCENTAGE, TOTAL_BALANCE_FLAT, TOTAL_PRINCIPAL_PERCENTAGE]
A list of basic repayment allocation elements such as the principal, interest & fees.
Possible values: [PRINCIPAL, INTEREST, FEE, PENALTY]
penaltySettings object
Defines the penalty settings for the product that will be used by the loan accounts based on this product
The penalty calculation method
Possible values: [NONE, OVERDUE_BALANCE, OVERDUE_BALANCE_AND_INTEREST, OVERDUE_BALANCE_INTEREST_AND_FEE, OUTSTANDING_PRINCIPAL]
Number of days to wait before applying the loan penalty amounts
penaltyRate object
Decimal constraints, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the decimal constraint, auto generated, unique
The maximum value.
The minimum value.
redrawSettings object
The redraw settings for the product.
Indicates whether the product support redraw (prepayments which are stored at loan account level as a Redrawable balance)
revolvingProductCreditBalance object
The response representation of the RevolvingProductCreditBalance.
Allow deposit on Credit Balance when Principal Balance is greater than zero
The automatic allocation method for credit balance
is credit balance enabled
The encoded key of the RevolvingProductCreditBalance, auto generated, unique
The max allowed credit balance
scheduleSettings object
Defines the settings and constraints for schedule for the loans that are created based on this product.
amortizationPeriod object
It holds information about the loan product amortization period. The PMT is calculated as the loan would have [amortisationPeriod] instalments
default value
max value
min value
billingCycles object
Defines the billing cycles settings for revolving credit products
The billing cycle status if it is enabled or disabled
The billing cycle start days in case it is enabled
Interval Repayment Methodology Settings.
firstRepaymentDueDateOffset object
Decimal integer, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the integer constraint, auto generated, unique
The maximum value.
The minimum value.
Specifies the days of the month when the repayment due dates should be. Only available if the Repayment Methodology is ScheduleDueDatesMethodDTO#FIXED_DAYS_OF_MONTH.
Represents the moment the interest will start getting accrued.
Possible values: [DISBURSEMENT, DUE_DATE]
For optimized payments only, indicates whether the installments should remain equal when there is a payment holiday
For optimized payments only, indicates whether the installments should remain equal when the first period is long
numInstallments object
Decimal integer, like min/max/default.
The default value, will be used in case no other value was filled in by the user.
The encoded key of the integer constraint, auto generated, unique
The maximum value.
The minimum value.
previewSchedule object
Defines the Preview Schedule settings for revolving products
Number of Previewed Instalments.
Preview Schedule status.
The repayment method value
Possible values: [AMOUNT, INSTALLMENTS]
The frequency of the loan repayment.
Possible values: [DAYS, WEEKS, MONTHS, YEARS]
The repayment rescheduling method used in calculations.
Possible values: [NONE, NEXT_WORKING_DAY, PREVIOUS_WORKING_DAY, EXTEND_SCHEDULE]
Shows the properties from the repayment schedule can be edited.
Possible values: [ADJUST_PAYMENT_DATES, ADJUST_PRINCIPAL_PAYMENT_SCHEDULE, ADJUST_INTEREST_PAYMENT_SCHEDULE, ADJUST_FEE_PAYMENT_SCHEDULE, ADJUST_PENALTY_PAYMENT_SCHEDULE, ADJUST_NUMBER_OF_INSTALLMENTS, ADJUST_PAYMENT_HOLIDAYS]
The method used by the loans to compute the repayment schedule.
Possible values: [NONE, FIXED, DYNAMIC]
roundingSettings object
Defines the rounding settings used in the loan computation.
Specifies the repayment currency rounding method.
Possible values: [NO_ROUNDING, ROUND_TO_NEAREST_WHOLE_UNIT, ROUND_UP_TO_NEAREST_WHOLE_UNIT]
Determines how the repayment currency rounding is handled on each element from the schedule.
Possible values: [NO_ROUNDING, ROUND_ALL, PAYMENT_DUE]
Specifies the rounding repayment schedule method.
Possible values: [NO_ROUNDING, ROUND_REMAINDER_INTO_LAST_REPAYMENT, ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT]
The schedule due dates method. Used by the loan accounts to determine the due dates of the repayments.
Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]
scheduleEditOptionDetails object
Holds Repayments Schedule Editing options
paymentHolidaysSettings object
Holds Payment Holidays Settings
payment holiday option
Possible values: [EXTEND_LOAN_TERM, KEEP_THE_SAME_LOAN_TERM]
The short month handling method type for a loan account.
Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]
securitySettings object
The settings and constraints for securities.
Shows whether collateral (assets or other goods) are accepted in order to reach required securities percentage from loan amount, as defined in this product.
Shows whether guarantors (other clients) are accepted in order to reach the required securities percentage from loan amount, as defined in this product.
The securities percentage from loan amount that is needed in order for this account to be approved. Null if the securities are not required.
The current state of the loan product.
Possible values: [ACTIVE, INACTIVE]
taxSettings object
Tax settings, defines some settings for taxes on the loan product
Shows whether the tax is added on top of the target amount or not.
Possible values: [INCLUSIVE, EXCLUSIVE]
The tax source from where the loan account taxes will be updated.
Shows whether taxes on fees are enabled for this product or not.
Shows whether taxes on interest are enabled for this product or not.
Shows whether taxes on penalties are enabled for this product or not.
templates object[]
The template documents of the loan product.
The creation date of the document
2016-09-06T13:37:50+03:00The document encodedKey
The last modified date of the document
2016-09-06T13:37:50+03:00The name the document
The type of the template
Possible values: [ACCOUNT, TRANSACTION, ACCOUNT_WITH_TRANSACTIONS]
The type of the loan product.
Possible values: [FIXED_TERM_LOAN, DYNAMIC_TERM_LOAN, INTEREST_FREE_LOAN, TRANCHED_LOAN, REVOLVING_CREDIT, INTEREST_ONLY_EQUAL_INSTALLMENTS, DYNAMIC_MORTGAGE, REVOLVING_CREDIT_CARD]
TRUE Fee should be part of PMT calculation, FALSE otherwise.
TRUE if it is possible to use the interest accrued as total due for the repayment when the repayment period is different than the repayment frequency, FALSE otherwise.
{
"accountLinkSettings": {
"enabled": true,
"linkableDepositProductKey": "string",
"linkedAccountOptions": [
"AUTO_LINK_ACCOUNTS"
],
"settlementMethod": "FULL_DUE_AMOUNTS"
},
"accountingSettings": {
"accountingMethod": "NONE",
"accountingRules": [
{
"encodedKey": "string",
"financialResource": "PORTFOLIO_CONTROL",
"glAccountKey": "string",
"transactionChannelKey": "string"
}
],
"interestAccrualCalculation": "NONE",
"interestAccruedAccountingMethod": "NONE"
},
"adjustInterestForFirstInstallment": true,
"adjustTotalDueForInstallmentsWithDifferentInterval": true,
"allowAdvanceRepayment": true,
"allowCustomRepaymentAllocation": true,
"arrearsSettings": {
"dateCalculationMethod": "ACCOUNT_FIRST_WENT_TO_ARREARS",
"encodedKey": "string",
"monthlyToleranceDay": 0,
"nonWorkingDaysMethod": "INCLUDED",
"toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
"toleranceFloorAmount": 0,
"tolerancePercentageOfOutstandingPrincipal": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"tolerancePeriod": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
}
},
"availabilitySettings": {
"availableFor": [
"INDIVIDUALS"
],
"branchSettings": {
"availableProductBranches": [
"string"
],
"forAllBranches": true
}
},
"category": "PERSONAL_LENDING",
"creationDate": "2016-09-06T13:37:50+03:00",
"creditArrangementSettings": {
"creditArrangementRequirement": "OPTIONAL"
},
"currency": {
"code": "AED",
"currencyCode": "string"
},
"encodedKey": "string",
"feesSettings": {
"allowArbitraryFees": true,
"fees": [
{
"accountingRules": [
{
"encodedKey": "string",
"financialResource": "PORTFOLIO_CONTROL",
"glAccountKey": "string",
"transactionChannelKey": "string"
}
],
"amortizationSettings": {
"amortizationProfile": "NONE",
"encodedKey": "string",
"feeAmortizationUponRescheduleRefinanceOption": "END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT",
"frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES",
"intervalCount": 0,
"intervalType": "PREDEFINED_INTERVALS",
"periodCount": 0,
"periodUnit": "DAYS"
},
"amount": 0,
"amountCalculationFunctionName": "string",
"amountCalculationMethod": "FLAT",
"applyDateMethod": "MONTHLY_FROM_ACTIVATION",
"creationDate": "2016-09-06T13:37:50+03:00",
"defaultFeeRate": 0,
"encodedKey": "string",
"feeApplication": "REQUIRED",
"id": "string",
"includeInPenalty": true,
"interestBearing": true,
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"name": "string",
"percentageAmount": 0,
"scheduleAllocationMethod": "ON_INSTALLMENT",
"state": "ACTIVE",
"taxSettings": {
"taxableCalculationMethod": "DEFAULT"
},
"trigger": "MANUAL"
}
]
},
"fundingSettings": {
"enabled": true,
"funderInterestCommission": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
"lockFundsAtApproval": true,
"organizationInterestCommission": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"requiredFunds": 0
},
"gracePeriodSettings": {
"gracePeriod": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"gracePeriodType": "NONE"
},
"id": "string",
"interestSettings": {
"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"
},
"internalControls": {
"dormancyPeriodDays": 0,
"fourEyesPrinciple": {
"activeForLoanApproval": true
},
"lockSettings": {
"cappingConstraintType": "SOFT_CAP",
"cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
"cappingPercentage": 0,
"lockPeriodDays": 0
}
},
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"loanAmountSettings": {
"loanAmount": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"trancheSettings": {
"maxNumberOfTranches": 0
}
},
"name": "string",
"newAccountSettings": {
"accountInitialState": "PARTIAL_APPLICATION",
"idGeneratorType": "INCREMENTAL_NUMBER",
"idPattern": "string"
},
"notes": "string",
"offsetSettings": {
"allowOffset": true
},
"paymentSettings": {
"amortizationMethod": "STANDARD_PAYMENTS",
"latePaymentsRecalculationMethod": "OVERDUE_INSTALLMENTS_INCREASE",
"paymentMethod": "HORIZONTAL",
"prepaymentSettings": {
"applyInterestOnPrepaymentMethod": "AUTOMATIC",
"elementsRecalculationMethod": "PRINCIPAL_EXPECTED_FIXED",
"ercFreeAllowance": 0,
"futurePaymentsAcceptance": "NO_FUTURE_PAYMENTS",
"prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
"prepaymentRecalculationMethod": "NO_RECALCULATION",
"principalPaidInstallmentStatus": "PARTIALLY_PAID"
},
"principalPaymentSettings": {
"amount": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"defaultPrincipalRepaymentInterval": 0,
"encodedKey": "string",
"includeFeesInFloorAmount": true,
"includeInterestInFloorAmount": true,
"percentage": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"principalCeilingValue": 0,
"principalFloorValue": 0,
"principalPaymentMethod": "FLAT",
"totalDueAmountFloor": 0,
"totalDuePayment": "FLAT"
},
"repaymentAllocationOrder": [
"PRINCIPAL"
]
},
"penaltySettings": {
"loanPenaltyCalculationMethod": "NONE",
"loanPenaltyGracePeriod": 0,
"penaltyRate": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
}
},
"redrawSettings": {
"allowRedraw": true
},
"revolvingProductCreditBalance": {
"allowDepositWithDebitBalance": true,
"creditBalanceAutoAllocation": "string",
"enabled": true,
"encodedKey": "string",
"maxCreditBalance": 0
},
"scheduleSettings": {
"amortizationPeriod": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"billingCycles": {
"enabled": true,
"startDays": [
0
]
},
"defaultRepaymentPeriodCount": 0,
"firstRepaymentDueDateOffset": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"fixedDaysOfMonth": [
0
],
"interestAccrualSince": "DISBURSEMENT",
"keepInstallmentsEqualForPaymentHoliday": true,
"keepInstallmentsEqualIfLongFirstPeriod": true,
"numInstallments": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"previewSchedule": {
"numberOfPreviewedInstalments": 0,
"previewScheduleEnabled": true
},
"repaymentMethod": "AMOUNT",
"repaymentPeriodUnit": "DAYS",
"repaymentReschedulingMethod": "NONE",
"repaymentScheduleEditOptions": [
"ADJUST_PAYMENT_DATES"
],
"repaymentScheduleMethod": "NONE",
"roundingSettings": {
"repaymentCurrencyRounding": "NO_ROUNDING",
"repaymentElementsRoundingMethod": "NO_ROUNDING",
"roundingRepaymentScheduleMethod": "NO_ROUNDING"
},
"scheduleDueDatesMethod": "INTERVAL",
"scheduleEditOptionDetails": {
"paymentHolidaysSettings": {
"paymentHolidaysLoanTermOption": "EXTEND_LOAN_TERM"
}
},
"shortMonthHandlingMethod": "LAST_DAY_IN_MONTH"
},
"securitySettings": {
"isCollateralEnabled": true,
"isGuarantorsEnabled": true,
"requiredGuaranties": 0
},
"state": "ACTIVE",
"taxSettings": {
"taxCalculationMethod": "INCLUSIVE",
"taxSourceKey": "string",
"taxesOnFeesEnabled": true,
"taxesOnInterestEnabled": true,
"taxesOnPenaltyEnabled": true
},
"templates": [
{
"creationDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"name": "string",
"type": "ACCOUNT"
}
],
"type": "FIXED_TERM_LOAN",
"useFeeIncludedInPMT": true,
"useInterestAccruedAsTotalDueWhenIntervalIsDifferent": true
}