Skip to main content

Paymentsettings

Defines the payment settings for the loan product and for loans crated based on this product.

amortizationMethodstring

Payments Method used by loan accounts for repayments schedule generation.

Possible values: [STANDARD_PAYMENTS, BALLOON_PAYMENTS, OPTIMIZED_PAYMENTS, PAYMENT_PLAN]

latePaymentsRecalculationMethodstringrequired

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]

paymentMethodstringrequired

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

applyInterestOnPrepaymentMethodstring

The apply interest method type for pre-payments.

Possible values: [AUTOMATIC, MANUAL]

elementsRecalculationMethodstring

The elements recalculation method types

Possible values: [PRINCIPAL_EXPECTED_FIXED, TOTAL_EXPECTED_FIXED]

ercFreeAllowancenumber

ERC free allowance in percentage

futurePaymentsAcceptancestringrequired

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]

prepaymentAcceptancestring

Shows whether the pre-payments are allowed or not for this product.

Possible values: [ACCEPT_PREPAYMENTS, NO_PREPAYMENTS]

prepaymentRecalculationMethodstring

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]

principalPaidInstallmentStatusstring

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.

defaultValuenumber

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

encodedKeystring

The encoded key of the decimal constraint, auto generated, unique

maxValuenumber

The maximum value.

minValuenumber

The minimum value.

defaultPrincipalRepaymentIntervalint32

How many repayments the principal has to be paid

encodedKeystring

The encoded key of the settings, auto generated, unique

includeFeesInFloorAmountboolean

If true, the fees will be included along with the principal in the repayment floor amount, for a revolving credit account

includeInterestInFloorAmountboolean

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.

defaultValuenumber

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

encodedKeystring

The encoded key of the decimal constraint, auto generated, unique

maxValuenumber

The maximum value.

minValuenumber

The minimum value.

principalCeilingValuenumber

The maximum principal due amount a repayment made with this settings can have

principalFloorValuenumber

The minimum principal due amount a repayment made with this settings can have

principalPaymentMethodstring

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]

totalDueAmountFloornumber

The minimum total due amount a repayment made with this settings can have

totalDuePaymentstring

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]

repaymentAllocationOrderstring[]required

A list of basic repayment allocation elements such as the principal, interest & fees.

Possible values: [PRINCIPAL, INTEREST, FEE, PENALTY]

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"
]
}