Skip to main content

Paymentconfiguration

Model representation of the payment settings configuration

amortizationMethodstring

Payments Method used by loan accounts for repayments schedule generation.

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

latePaymentsRecalculationMethodstring

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]

paymentMethodstring

The payment allocation method used by the loans defining how the payments get performed.

Possible values: [HORIZONTAL, VERTICAL]

prepaymentSettings object

The prepayment settings, holds all prepayment properties.

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

Future payments allowance types.

Possible values: [NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS, ACCEPT_OVERPAYMENTS]

prepaymentAcceptancestring

Pre-payment acceptance types.

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

Used for keeping decimal constraints.

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.

defaultPrincipalRepaymentIntervalinteger<int32>

How many repayments the principal has to be paid

includeFeesInFloorAmountboolean

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

percentage object

Used for keeping decimal constraints.

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.

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

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

Possible values: [FLAT, OUTSTANDING_PRINCIPAL_PERCENTAGE, PRINCIPAL_PERCENTAGE_LAST_DISB, TOTAL_BALANCE_PERCENTAGE, TOTAL_BALANCE_FLAT, TOTAL_PRINCIPAL_PERCENTAGE]

repaymentAllocationOrderstring[]

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

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

Paymentconfiguration
{
"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,
"maxValue": 0,
"minValue": 0
},
"defaultPrincipalRepaymentInterval": 0,
"includeFeesInFloorAmount": true,
"percentage": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"principalCeilingValue": 0,
"principalFloorValue": 0,
"principalPaymentMethod": "FLAT",
"totalDueAmountFloor": 0,
"totalDuePayment": "FLAT"
},
"repaymentAllocationOrder": [
"PRINCIPAL"
]
}