Skip to main content

Locksettings

Settings applied when transitioning accounts to Locked state

cappingConstraintTypestring

Specifies constraint types for capping charges.

Possible values: [SOFT_CAP, HARD_CAP]

cappingMethodstring

Specifies how principal will be used when calculating capping charges.

Possible values: [OUTSTANDING_PRINCIPAL_PERCENTAGE, ORIGINAL_PRINCIPAL_PERCENTAGE]

cappingPercentagenumber

Specifies the percentage of principal that cannot be exceeded by the sum of interest, fees and penalty balances.

lockPeriodDaysint32

Specifies the number of days for in which the account will be locked if it stays in arrears.

Locksettings
{
  "cappingConstraintType": "SOFT_CAP",
  "cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
  "cappingPercentage": 0,
  "lockPeriodDays": 0
}