Loan Early Repayment Charge Fees
  • 09 Jul 2024
  • 35 Minutes To Read
  • Dark
    Light
  • PDF

Loan Early Repayment Charge Fees

  • Dark
    Light
  • PDF

Article summary

Description

This extension point in Mortgages allows customers to build functions to calculate the Early Repayment Charge fee to be charged on loan account in case of overpayments before due date. Example: applying a fee when overpayment is made and it exceeds the allowance amount per year limit set on loan account.

Technical contract specification

Extension point ID: LOAN_EARLY_REPAYMENT_CHARGE_FEE_AMOUNT

Input properties

EarlyRepaymentChargeAmountFunctionRequestDto

NameTypeAvailabilityDescription
amountstring(number)Sometimes presentOverpayment paid on which early repayment charge will be calculated
datestring(date-time)Sometimes presentCurrent date on which early repayment charge will be calculated
ercFreeAllowanceAmountstring(number)Sometimes presentErc free allowance Amount
indexRateSources[EarlyRepaymentChargeIndexRateSourceDto]Sometimes presentIndex rate source details for loan account
installments[EarlyRepaymentChargeInstallmentDto]Sometimes presentLoan schedule details
loanAccountEarlyRepaymentChargeLoanAccountDtoSometimes presentLoan account info
loanTransactions[EarlyRepaymentChargeLoanTransactionDto]Sometimes presentLoan transaction details
overpaymentDetails[OverpaymentDetailsDto]Sometimes presentlist of overpayments made and erc transaction linked to the overpayment

Output properties

EarlyRepaymentChargeAmountFunctionResponseDto

NameTypeAvailabilityDescription
ercFeeAmountstring(number)Always presentERC fee amount calculated which will be applied on loan account
ercFreeAllowanceAmountstring(number)Always presentERC fee allowance amount remaining calculated which will be set on loan account. Can return zero if not used by function

Schemas

AccountArrearsSettingsDTO

The account arrears settings, holds the required information for the arrears settings of an account.

NameTypeAvailabilityDescription
dateCalculationMethodArrearsDateCalculationMethodDTOSometimes presentThe arrears date calculation method.
encodedKeystringSometimes presentThe encoded key of the arrears base settings, auto generated, unique.
monthlyToleranceDaystring(number)Sometimes presentDefines monthly arrears tolerance day value.
nonWorkingDaysMethodArrearsNonWorkingDaysMethodDTOSometimes presentShows whether the non working days are taken in consideration or not when applying penaltees/late fees or when setting an account into arrears
toleranceCalculationMethodArrearsToleranceCalculationMethodDTOSometimes presentDefines the tolerance calculation method
toleranceFloorAmountstring(number)Sometimes presentThe tolerance floor amount.
tolerancePercentageOfOutstandingPrincipalstring(number)Sometimes presentDefines the arrears tolerance amount.
tolerancePeriodstring(number)Sometimes presentDefines the arrears tolerance period value.

AccountHolderTypeDTO

Indicated the account holder type.

Enumerated values: CLIENT | GROUP

AccountInterestRateSettingsDTO

NameTypeAvailabilityDescription
encodedKeystringSometimes presentThe encoded key of the interest rate settings, auto generated, unique
indexSourceKeystringSometimes presentIndex rate source key.
interestRatestring(number)Sometimes presentInterest rate value.
interestRateCeilingValuestring(number)Sometimes presentMaximum value allowed for index based interest rate. Valid only for index interest rate.
interestRateFloorValuestring(number)Sometimes presentMinimum value allowed for index based interest rate. Valid only for index interest rate.
interestRateReviewCountstring(number)Sometimes presentInterest rate review frequency unit count. Valid only for index interest rate.
interestRateReviewUnitInterestRateReviewUnitDTOSometimes presentInterest rate review frequency measurement unit. Valid only for index interest rate.
interestRateSourceInterestRateSourceDTOAlways presentInterest calculation method: fixed or indexed(interest spread + active organization index interest rate)
interestSpreadstring(number)Sometimes presentInterest spread value.
validFromstring(date-time)Always presentDate since an interest rate is valid

AmountDTO

Represents a simple installment amount structure.

NameTypeAvailabilityDescription
duestring(number)Sometimes presentThe due amount.
expectedstring(number)Sometimes presentThe expected amount, which is sum of paid and due amounts.
paidstring(number)Sometimes presentThe paid amount.

AmountWithReducedDTO

Represents a simple installment amount structure.

NameTypeAvailabilityDescription
duestring(number)Sometimes presentThe due amount.
expectedstring(number)Sometimes presentThe expected amount, which is sum of paid and due amounts.
paidstring(number)Sometimes presentThe paid amount.
reducedstring(number)Sometimes presentThe reduced amount.

ApplyInterestOnPrepaymentMethodDTO

The apply interest method type for pre-payments.

Enumerated values: AUTOMATIC | MANUAL

ArrearsDateCalculationMethodDTO

The arrears date calculation method.

Enumerated values: ACCOUNT_FIRST_WENT_TO_ARREARS | LAST_LATE_REPAYMENT | ACCOUNT_FIRST_BREACHED_MATERIALITY_THRESHOLD

ArrearsNonWorkingDaysMethodDTO

Shows whether the non working days are taken in consideration or not when applying penaltees/late fees or when setting an account into arrears

Enumerated values: INCLUDED | EXCLUDED

ArrearsToleranceCalculationMethodDTO

Defines the tolerance calculation method

Enumerated values: ARREARS_TOLERANCE_PERIOD | MONTHLY_ARREARS_TOLERANCE_DAY

AssetDTO

NameTypeAvailabilityDescription
amountstring(number)Always presentThe amount used by the client for the guaranty
assetNamestringAlways presentThe name of a value the client guarantees with (populated when the guaranty type is ASSET)
customFieldKeysobjectSometimes present
customFieldsobjectSometimes presentMap of custom field values on account
depositAccountKeystringSometimes presentThe key of the deposit account used by the guarantor (populated when the guaranty type is GUARANTOR). It can be null.
encodedKeystringSometimes presentThe encoded key of the security, auto generated, unique.
guarantorKeystringSometimes presentThe key of the client/group used as the guarantor.
guarantorTypeAccountHolderTypeDTOSometimes presentThe type of the guarantor (client/group)
originalAmountstring(number)Sometimes presentThe original amount used by the client for a collateral asset
originalCurrencyCurrencyDTOSometimes presentThe currency of the original amount used by the client for the collateral asset

BalancesDTO

The loan account balance details.

NameTypeAvailabilityDescription
feesBalancestring(number)Sometimes presentThe fees balance. Represents the total fees expected to be paid on this account at a given moment.
feesDuestring(number)Sometimes presentThe fees due. Representing the total fees due for the account.
feesPaidstring(number)Sometimes presentThe fees paid. Represents the total fees paid for the account.
holdBalancestring(number)Sometimes presentThe sum of all the authorization hold amounts on this account.
interestBalancestring(number)Sometimes presentRepresents the total interest owed by the client (total interest applied for account minus interest paid).
interestDuestring(number)Sometimes presentThe interest due. Indicates how much interest it's due for the account at this moment.
interestFromArrearsBalancestring(number)Sometimes presentThe interest from arrears balance. Indicates interest from arrears owned by the client, from now on. (total interest from arrears accrued for account - interest from arrears paid).
interestFromArrearsDuestring(number)Sometimes presentThe interest from arrears due. Indicates how much interest from arrears it's due for the account at this moment.
interestFromArrearsPaidstring(number)Sometimes presentThe interest from arrears paid, indicates total interest from arrears paid into the account.
interestPaidstring(number)Sometimes presentThe interest paid, indicates total interest paid into the account.
penaltyBalancestring(number)Sometimes presentThe penalty balance. Represents the total penalty expected to be paid on this account at a given moment.
penaltyDuestring(number)Sometimes presentThe penalty due. Represents the total penalty amount due for the account.
penaltyPaidstring(number)Sometimes presentThe Penalty paid. Represents the total penalty amount paid for the account.
principalBalancestring(number)Sometimes presentThe total principal owned by the client, from now on (principal disbursed - principal paid).
principalDuestring(number)Sometimes presentThe principal due, indicates how much principal it's due at this moment.
principalPaidstring(number)Sometimes presentThe principal paid, holds the value of the total paid into the account.
redrawBalancestring(number)Sometimes presentThe total redraw amount owned by the client, from now on.

BillingCycleDaysDTO

Defines the billing cycles settings for a loan account

NameTypeAvailabilityDescription
days[string(number)]Sometimes presentThe billing cycle start days in case it is enabled

CardAcceptorDTO

The details of the card acceptor (merchant) in a transaction hold.

NameTypeAvailabilityDescription
citystringSometimes presentThe city in which the card acceptor has the business.
countrystringSometimes presentThe country in which the card acceptor has the business.
mccstring(number)Sometimes presentThe Merchant Category Code of the card acceptor.
namestringSometimes presentThe name of the card acceptor.
statestringSometimes presentThe state in which the card acceptor has the business.
streetstringSometimes presentThe street in which the card acceptor has the business.
zipstringSometimes presentThe ZIP code of the location in which the card acceptor has the business.

CardTransactionDTO

A card transaction entry which will have a corresponding a financial transaction performed.

NameTypeAvailabilityDescription
advicebooleanAlways presentWhether the given request should be accepted without balance validations.
amountstring(number)Always presentThe amount of money to be withdrawn in the financial transaction.
cardAcceptorNoneSometimes presentThe card acceptor details.
cardTokenstringSometimes presentThe reference token of the card.
currencyCodestringSometimes presentThe ISO currency code in which the card reversal transaction is posted. The amounts are stored in the base currency, but the transaction can be created with a foreign currency.
encodedKeystringSometimes presentThe encoded key of the entity, generated, globally unique
externalAuthorizationReferenceIdstringSometimes presentThe external authorization hold reference ID, which relates this card transaction to a previous authorization hold.
externalReferenceIdstringAlways presentThe external reference ID to be used to reference the card transaction in subsequent requests.
userTransactionTimestringSometimes presentThe formatted time at which the user made this card transaction.

CurrenciesDTO

Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.

Enumerated 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 | 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 | XDR | XOF | XPD | XPF | XPT | XSU | XTS | XUA | XXX | YER | ZAR | ZIG | ZMK | ZWL | ZMW | SSP | NON_FIAT

CurrencyDTO

Represents a currency eg. USD, EUR.

NameTypeAvailabilityDescription
codeCurrenciesDTOSometimes presentFiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.
currencyCodestringSometimes presentCurrency code for NON_FIAT currency.

CustomPaymentAmountDTO

NameTypeAvailabilityDescription
amountstring(number)Always presentThe amount of the payment paid in the transaction for the given type.
customPaymentAmountTypeCustomPaymentAmountTypeDTOAlways presentThe type of the custom payment
predefinedFeeKeystringSometimes presentThe encodedKey of the predefined fee to be paid.
taxOnAmountstring(number)Sometimes presentThe amount of the taxes paid in the transaction for the given type.

CustomPaymentAmountTypeDTO

The type of the custom payment

Enumerated values: PRINCIPAL | INTEREST | MANUAL_FEE | UPFRONT_DISBURSEMENT_FEE | LATE_REPAYMENT_FEE | PAYMENT_DUE_FEE | PENALTY

CustomPredefinedFeeDTO

The custom predefined fees, they may be used as the expected predefined fees that will be applied on the disbursement.

NameTypeAvailabilityDescription
amountstring(number)Sometimes presentThe amount of the custom fee.
encodedKeystringSometimes presentThe encoded key of the custom predefined fee, auto generated, unique.
percentagestring(number)Sometimes presentThe percentage of the custom fee.
predefinedFeeEncodedKeystringSometimes presentThe encoded key of the predefined fee

CustomPredefinedFeeDTO

The custom predefined fees, they may be used as the expected predefined fees that will be applied on the disbursement.

NameTypeAvailabilityDescription
amountstring(number)Sometimes presentThe amount of the custom fee.
encodedKeystringSometimes presentThe encoded key of the custom predefined fee, auto generated, unique.
percentagestring(number)Sometimes presentThe percentage of the custom fee.
predefinedFeeEncodedKeystringSometimes presentThe encoded key of the predefined fee

DaysInMonthDTO

Enumeration for days of month and method of handling shorter months.

NameTypeAvailabilityDescription
daysInMonth[string(number)]Sometimes presentSpecifies the day(s) of the month when the interest application dates should be. Only available if the Interest Application Method is InterestApplicationMethodDTO#FIXED_DAYS_OF_MONTH. Currently only 1 value can be specified.
shortMonthHandlingMethodShortMonthHandlingMethodDTOSometimes presentDetermines how to handle the short months, if they select a fixed day of month > 28. Will be null if no such date is selected. Only available if the Interest Application Method is InterestApplicationMethodDTO#FIXED_DAYS_OF_MONTH.

DisbursementDetailsDTO

The the disbursement details it holds the information related to the disbursement details as disbursement date, first repayment date, disbursement fees.

NameTypeAvailabilityDescription
disbursementDatestring(date-time)Sometimes presentThe activation date, the date when the disbursement actually took place.
encodedKeystringSometimes presentThe encoded key of the disbursement details, auto generated, unique
expectedDisbursementDatestring(date-time)Sometimes presentThe date of the expected disbursement.Stored as Organization Time.
fees[CustomPredefinedFeeDTO]Sometimes presentList of fees that should be applied at the disbursement time.
firstRepaymentDatestring(date-time)Sometimes presentThe date of the expected first repayment. Stored as Organization Time.
transactionDetailsNoneSometimes presentThe input details for the disbursement transaction

EarlyRepaymentChargeIndexRateSourceDto

NameTypeAvailabilityDescription
creationDatestring(date-time)Sometimes presentThe creation date of the index rate source
lastModifiedDatestring(date-time)Sometimes presentThe last date this rate source was modified
namestringSometimes presentThe name of the index rate source.
notesstringSometimes presentThe notes about the the index rate source.
typeIndexTypeDTOSometimes presentThe type of index rate source.

EarlyRepaymentChargeInstallmentDto

NameTypeAvailabilityDescription
dueDatestring(date-time)Sometimes presentThe installment due date.
feeInstallmentFeeDTOSometimes presentThe fee amount that may be applied to the loan account.
feeDetails[InstallmentFeesDto]Sometimes presentThe breakdown of the fee amounts that have been applied to the loan account.
interestInstallmentAllocationElementTaxableAmountDTOSometimes presentThe interest amount that is charged for the use of the loan.
lastPaidDatestring(date-time)Sometimes presentThe installment last paid date.
numberstringSometimes presentThe order number of an installment among all the installments generated for a loan. Loan installments are put in ascending order by due date. The order number only applies to the content of a particular JSON response therefore it is not unique.
penaltyInstallmentAllocationElementTaxableAmountDTOSometimes presentThe penalty amount that can be charged for the loan account.
principalInstallmentAllocationElementAmountDTOSometimes presentThe original loan amount that is disbursed, excluding interest, fees, and penalties.
repaidDatestring(date-time)Sometimes presentThe installment repaid date.
stateInstallmentStateDTOSometimes presentThe installment state.

EarlyRepaymentChargeLoanAccountDto

Loan account info

NameTypeAvailabilityDescription
accountArrearsSettingsAccountArrearsSettingsDTOSometimes presentThe arrears settings for the loan account.
accountHolderTypeAccountHolderTypeDTOAlways presentThe type of the account holder.
accountStateLoanAccountStateDTOSometimes presentThe state of the loan account.
accountSubStateLoanAccountSubStateDTOSometimes presentA second state for the loan account. Beside the account state, a second substate is sometimes necessary to provide more information about the exact lifecycle state of a loan account.For example, even if the account state of a loan account is ACTIVE, it can also have a substate of LOCKED.
accruedIntereststring(number)Sometimes presentThe amount of interest that has been accrued in the loan account.
accruedPenaltystring(number)Sometimes presentThe accrued penalty, represents the amount of penalty that has been accrued in the loan account.
allowOffsetbooleanSometimes presentDEPRECATED - Will always be false.
approvedDatestring(date-time)Sometimes presentThe date the loan account was approved.
arrearsTolerancePeriodstring(number)Sometimes presentThe arrears tolerance (period or day of month) depending on the product settings.
assets[AssetDTO]Sometimes presentThe list of assets associated with the current loan account.
balancesBalancesDTOSometimes presentThe balances details for this loan account.
closedDatestring(date-time)Sometimes presentThe date the loan was closed.
creationDatestring(date-time)Sometimes presentThe date the loan account was created.
currencyCurrencyDTOSometimes presentThe currency in which the amounts are expressed for this account.
customFieldValuesobjectSometimes presentMap of custom field values on account
daysInArrearsstring(number)Sometimes presentThe number of days the loan account is in arrears.
daysLatestring(number)Sometimes presentThe number of days a repayment for the loan account is late.
disbursementDetailsDisbursementDetailsDTOSometimes presentThe details regarding the disbursement.
fundingSources[InvestorFundDTO]Sometimes presentThe list of funds associated with the loan account.
futurePaymentsAcceptanceFuturePaymentsMethodDTOSometimes presentShows whether the repayment transactions with entry date set in the future are allowed or not for this loan account.
guarantors[GuarantorDTO]Sometimes presentThe list of guarantees associated with the loan account.
interestAccruedInBillingCyclestring(number)Sometimes presentThe interest that is accrued in the current billing cycle.
interestCommissionstring(number)Sometimes presentThe value of the interest booked by the organization from the accounts funded by investors. Null if the funds are not enabled.
interestFromArrearsAccruedstring(number)Sometimes presentThe amount of interest from arrears that has been accrued in the loan account.
interestSettingsInterestSettingsDTOSometimes presentThe interest settings details for the loan account.
lastAccountAppraisalDatestring(date-time)Sometimes presentThe date the loan account has last been evaluated for interest, principal, fees, and penalties calculations expressed in the organization time format and time zone.
lastInterestAppliedDatestring(date-time)Sometimes presentThe date of the last time the loan account had interest applied (stored to interest balance), expressed in the organization time format and time zone.
lastInterestReviewDatestring(date-time)Sometimes presentThe date the interest was reviewed last time, stored in the organization time format and time zone.
lastLockedDatestring(date-time)Sometimes presentThe date when the loan account was set for the last time in the LOCKED state expressed in the organization time format and time zone. If null, the account is not locked anymore.
lastModifiedDatestring(date-time)Sometimes presentThe last date the loan was updated.
lastSetToArrearsDatestring(date-time)Sometimes presentThe date when the loan account was set to last standing or null; if never set, it is expressed in your organization time format and time zone.
lastTaxRateReviewDatestring(date-time)Sometimes presentThe date the tax rate on the loan account was last checked, expressed in the organization time format and time zone.
latePaymentsRecalculationMethodLatePaymentRecalculationMethodDTOSometimes presentThe overdue payments recalculation method inherited from the loan product on which this loan account is based.
loanAmountstring(number)Always presentThe loan amount.
loanNamestringSometimes presentThe name of the loan account.
lockedAccountTotalDueTypeLockedAccountTotalDueTypeDTOSometimes presentThe locked account total due type.
lockedOperations[LoanAccountOperationTypeDTO]Sometimes presentA list with operations which are locked when the account is in the AccountState.LOCKED substate.
modifyInterestForFirstInstallmentbooleanSometimes presentAdjust the interest for the first repayment when the first repayment period is different than the repayment frequency
paymentHolidaysAccruedIntereststring(number)Sometimes presentThe amount of interest that has been accrued during payment holidays in the loan account.
paymentMethodPaymentMethodDTOSometimes presentThe interest payment method that determines whether the payments are made horizontally (on the repayments) or vertically (on the loan account).
penaltySettingsPenaltySettingsDTOSometimes presentThe penalty settings details of the loan account.
plannedInstallmentFees[PlannedInstallmentFeeDTO]Sometimes presentThe list with manual fees planned on the installments of the loan account.
prepaymentSettingsPrepaymentSettingsDTOSometimes presentThe prepayment settings details of the loan account.
principalPaymentSettingsPrincipalPaymentAccountSettingsDTOSometimes presentThe settings for revolving credit principal payments.
redrawSettingsLoanAccountRedrawSettingsDTOSometimes presentThe redraw settings for the loan account.
scheduleSettingsScheduleSettingsDTOAlways presentThe schedule settings details for the loan account.
taxRatestring(number)Sometimes presentThe tax rate.
terminationDatestring(date-time)Sometimes presentThe date this loan account was terminated.
tranches[LoanTrancheDetailsDto]Sometimes presentThe list of disbursement tranches available for the loan account.

EarlyRepaymentChargeLoanTransactionDto

NameTypeAvailabilityDescription
accountBalancesTransactionBalancesDTOSometimes presentThe account balances changed within the transaction.
adjustmentTransactionKeystringSometimes presentThe encoded key of the transaction that was adjusted as part of this one. Available only for adjustment transactions.
affectedAmountsLoanAffectedAmountsDTOSometimes presentThe amounts affected after completing the transaction.
amountstring(number)Sometimes presentThe amount that was added or removed on the loan account.
bookingDatestring(date-time)Sometimes presentThe date when the corresponding journal entry is booked.
cardTransactionCardTransactionDTOSometimes presentThe card transaction details that correspond to the loan transaction (if applicable).
creationDatestring(date-time)Sometimes presentThe date when this loan transaction was created.
currencyCurrencyDTOSometimes presentThe currency in which the amounts are expressed for the transaction.
customPaymentAmounts[CustomPaymentAmountDTO]Sometimes presentThe list of custom amounts which the user has paid as part of this transaction.
encodedKeystringSometimes presentThe encoded key of transaction.
fees[FeeDTO]Sometimes presentThe amounts that have been applied or paid as part of this transaction and involved predefined fees.
notesstringSometimes presentThe notes or description for the loan transaction.
originalAmountstring(number)Sometimes presentThe amount that was posted in a foreign currency. This amount was converted using the exchange rate available at entry date and set into the amount field.
originalCurrencyCodestringSometimes presentThe currency in which this transaction was posted. The amounts are stored in the base currency, but the user may enter it in a foreign currency.
prepaymentRecalculationMethodPrepaymentRecalculationMethodDTOSometimes presentThe prepayment recalculation method of the loan transaction.
taxesTaxesDTOSometimes presentThe taxes applied on the transaction.
termsLoanTermsDTOSometimes presentRepresents specific information related to loan transaction terms.
typeLoanTransactionTypeDTOSometimes presentThe type of loan transaction.
valueDatestring(date-time)Sometimes presentThe date of the entry in the organization time format and timezone.

ElementsRecalculationMethodDTO

The elements recalculation method types

Enumerated values: PRINCIPAL_EXPECTED_FIXED | TOTAL_EXPECTED_FIXED

FeeAmountDTO

Represents a fee amount.

NameTypeAvailabilityDescription
duestring(number)Sometimes presentThe due amount.
expectedstring(number)Sometimes presentThe expected amount, which is sum of paid and due amounts.
expectedUnappliedstring(number)Sometimes presentThe expected amount, which is the sum of unapplied fee and planned fee due amounts.
paidstring(number)Sometimes presentThe paid amount.

FeeDTO

NameTypeAvailabilityDescription
amountstring(number)Sometimes presentThe amount of the fee that was applied/paid in the transaction for the given predefined fee.
namestringSometimes presentThe name of the predefined fee
predefinedFeeKeystringAlways presentThe encoded key of the predefined fee, auto generated, unique
taxAmountstring(number)Sometimes presentThe amount of the taxes on fee that was applied/paid in the transaction.
triggerTriggerDTOSometimes presentShows the event that will trigger a fee

FuturePaymentsMethodDTO

Shows whether the repayment transactions with entry date set in the future are allowed or not for this loan account.

Enumerated values: NO_FUTURE_PAYMENTS | ACCEPT_FUTURE_PAYMENTS | ACCEPT_OVERPAYMENTS

GracePeriodTypeDTO

The grace period type for a loan account.

Enumerated values: NONE | PAY_INTEREST_ONLY | INTEREST_FORGIVENESS

GuarantorDTO

NameTypeAvailabilityDescription
amountstring(number)Always presentThe amount used by the client for the guaranty
assetNamestringSometimes presentThe name of a value the client guarantees with (populated when the guaranty type is ASSET)
customFieldKeysobjectSometimes present
customFieldsobjectSometimes presentMap of custom field values on account
depositAccountKeystringSometimes presentThe key of the deposit account used by the guarantor (populated when the guaranty type is GUARANTOR). It can be null.
encodedKeystringSometimes presentThe encoded key of the security, auto generated, unique.
guarantorKeystringAlways presentThe key of the client/group used as the guarantor.
guarantorTypeAccountHolderTypeDTOAlways presentThe type of the guarantor (client/group)

IndexTypeDTO

The type of index rate source.

Enumerated values: INTEREST_RATE | TAX_RATE | WITHHOLDING_TAX_RATE | PRINCIPAL_TAX_RATE

InstallmentAllocationElementAmountDTO

Represents an installment allocation element amount structure.

NameTypeAvailabilityDescription
amountAmountDTOSometimes presentThe installment allocation element amount.

InstallmentAllocationElementTaxableAmountDTO

Represents an installment allocation element taxable amount structure.

NameTypeAvailabilityDescription
amountAmountDTOSometimes presentThe installment allocation element amount.
taxAmountDTOSometimes presentThe taxes amount on the income from the installment allocation element amount.

InstallmentFeeDTO

Represents an installment fee structure.

NameTypeAvailabilityDescription
amountNoneSometimes presentThe installment fee amount.
taxAmountDTOSometimes presentThe taxes amount on the income from the installment fee amount.

InstallmentFeesDto

NameTypeAvailabilityDescription
amountAmountWithReducedDTOSometimes presentThe installment allocation element amount.
namestringSometimes presentThe name of the fee
taxAmountWithReducedDTOSometimes presentThe taxes amount on the income from the fee details amount.

InstallmentStateDTO

The installment state.

Enumerated values: PENDING | LATE | PAID | PARTIALLY_PAID | GRACE

InterestApplicationMethodDTO

The interest application method for a loan account. It shows the method used by the loans defining how the interest gets applied.

Enumerated values: AFTER_DISBURSEMENT | REPAYMENT_DUE_DATE | FIXED_DAYS_OF_MONTH

InterestBalanceCalculationMethodDTO

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.

Enumerated values: ONLY_PRINCIPAL | PRINCIPAL_AND_INTEREST

InterestCalculationMethodDTO

The interest calculation method for a loan account. Shows the different interest calculation methods.

Enumerated values: FLAT | DECLINING_BALANCE | DECLINING_BALANCE_DISCOUNTED | EQUAL_INSTALLMENTS

InterestChargeFrequencyMethodDTO

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.

Enumerated values: ANNUALIZED | EVERY_MONTH | EVERY_FOUR_WEEKS | EVERY_WEEK | EVERY_DAY | EVERY_X_DAYS

InterestRateChangePMTAdjustmentThresholdDTO

Represents interest rate change threshold settings for loan accounts and loan products.

NameTypeAvailabilityDescription
methodNoneSometimes presentThe method used to calculate the interest rate change threshold. Supported value is CALENDAR_DAYS
numberOfDaysstring(number)Sometimes presentThe number of days that trigger an interest rate change.

InterestRateChangeThresholdMethodDTO

Represents the method used to calculate the interest rate change threshold. Supported value is CALENDAR_DAYS

Enumerated values: WORKING_DAYS | CALENDAR_DAYS

InterestRateReviewUnitDTO

The interest rate review unit values. Shows how often is index interest rate reviewed.

Enumerated values: DAYS | WEEKS | MONTHS

InterestRateSourceDTO

The interest rate review unit values. Shows how often is index interest rate reviewed.

Enumerated values: FIXED_INTEREST_RATE | INDEX_INTEREST_RATE

InterestSettingsDTO

The interest settings, holds all the properties regarding interests for the loan account.

NameTypeAvailabilityDescription
accountInterestRateSettings[AccountInterestRateSettingsDTO]Sometimes presentAdjustable interest rates settings for loan account
accrueInterestAfterMaturitybooleanSometimes presentThe accrue interest after maturity. If the product support this option, specify if the interest should be accrued after the account maturity date.
accrueLateInterestbooleanSometimes presentIndicates whether late interest is accrued for this loan account
interestApplicationDaysNoneSometimes presentThe day(s) of month on which the interest will be applied and how to handle the short months.
interestApplicationMethodNoneSometimes presentThe interest application method. Represents the interest application method that determines whether the interest gets applied on the account's disbursement or on each repayment.
interestBalanceCalculationMethodNoneSometimes presentThe interest balance calculation method. Represents the option which determines the way the balance for the account's interest is computed.
interestCalculationMethodNoneSometimes presentThe interest calculation method. Holds the type of interest calculation method.
interestChargeFrequencyNoneSometimes presentThe interest change frequency. Holds the possible values for how often is interest charged on loan or deposit accounts
interestRatestring(number)Sometimes presentThe interest rate. Represents the interest rate for the loan account. The interest on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount.
interestRateChangePMTAdjustmentThresholdNoneSometimes presentInterest rate change PMT adjustment threshold settings
interestRateReviewCountstring(number)Sometimes presentInterest rate update frequency unit count.
interestRateReviewUnitInterestRateReviewUnitDTOSometimes presentThe interest rate review unit. Defines the interest rate update frequency measurement unit.
interestRateSourceInterestRateSourceDTOSometimes presentThe interest rate source. Represents the interest calculation method: fixed or (interest spread + active organization index interest rate)
interestSpreadstring(number)Sometimes presentInterest to be added to active organization index interest rate in order to find out actual interest rate
interestTypeInterestTypeDTOSometimes presentThe possible values for how we compute and apply the interest

InterestTypeDTO

The possible values for how we compute and apply the interest

Enumerated values: SIMPLE_INTEREST | CAPITALIZED_INTEREST | COMPOUNDING_INTEREST

InvestorFundDTO

NameTypeAvailabilityDescription
amountstring(number)Always presentThe amount used by the client for the guaranty
assetNamestringSometimes presentThe name of a value the client guarantees with (populated when the guaranty type is ASSET)
depositAccountKeystringSometimes presentThe key of the deposit account used by the guarantor (populated when the guaranty type is GUARANTOR). It can be null.
encodedKeystringSometimes presentThe encoded key of the entity, generated, globally unique
guarantorKeystringAlways presentThe key of the client/group used as the guarantor.
guarantorTypeAccountHolderTypeDTOAlways presentThe type of the guarantor (client/group)
idstringSometimes presentInvestor fund unique identifier. All versions of an investor fund will have same id.
interestCommissionstring(number)Sometimes presentThe constraint minimum value
sharePercentagestring(number)Sometimes presentPercentage of loan shares this investor owns

LatePaymentRecalculationMethodDTO

The late payment recalculation method. Is used by loan accounts to have the schedule recalculated when late payments are posted on accounts..

Enumerated values: OVERDUE_INSTALLMENTS_INCREASE | LAST_INSTALLMENT_INCREASE

LoanAccountOperationTypeDTO

Enumerated values: APPLY_INTEREST | APPLY_FEES | APPLY_PENALTIES

LoanAccountRedrawSettingsDTO

Represents the redraw settings for a loan account.

NameTypeAvailabilityDescription
restrictNextDueWithdrawalbooleanAlways presentTRUE if withdrawing amounts that reduce the next due instalment repayment is restricted, FALSE otherwise.

LoanAccountStateDTO

All the generic account states applicable to loans.

Enumerated values: PARTIAL_APPLICATION | PENDING_APPROVAL | APPROVED | ACTIVE | ACTIVE_IN_ARREARS | CLOSED

LoanAccountSubStateDTO

All the generic account sub states applicable to loans.

Enumerated values: PARTIALLY_DISBURSED | LOCKED | LOCKED_CAPPING | REFINANCED | RESCHEDULED | WITHDRAWN | REPAID | REJECTED | WRITTEN_OFF | TERMINATED

LoanAffectedAmountsDTO

The amounts affected after completing the loan transaction

NameTypeAvailabilityDescription
deferredInterestAmountstring(number)Sometimes presentHow much interest pre-paid was added/removed in account, within this transaction (including taxes).
feesAmountstring(number)Sometimes presentHow much fees was added/removed in account, within this transaction.
fundersInterestAmountstring(number)Sometimes presentHow much interest is given to the investors, within this transaction (only for p2p products)
interestAmountstring(number)Sometimes presentHow much interest was added/removed in account, within this transaction (including taxes). If there is any deferred interest amount set in this transaction, that amount should be included in this field.
interestFromArrearsAmountstring(number)Sometimes presentHow much interest from arrears was added/removed in account, within this transaction (including taxes).
organizationCommissionAmountstring(number)Sometimes presentHow much interest is given to the organization, within this transaction (only for p2p products)
paymentHolidaysInterestAmountstring(number)Sometimes presentHow much Payment Holidays interest was added/removed in account, within this transaction (including taxes).
penaltyAmountstring(number)Sometimes presentHow much penalties was added/removed in account, within this transaction.
principalAmountstring(number)Sometimes presentHow much principal was added/removed in account, within this transaction.

LoanPenaltyCalculationMethodDTO

The loan penalty calculation method types

Enumerated values: NONE | OVERDUE_BALANCE | OVERDUE_BALANCE_AND_INTEREST | MAMBU_FUNCTION_OVERDUE_PRINCIPAL | OUTSTANDING_PRINCIPAL

LoanTermsDTO

The loan transaction terms

NameTypeAvailabilityDescription
interestSettingsNoneSometimes presentGroups all fields having interest purpose concerning a transaction
periodicPaymentstring(number)Sometimes presentThe periodic payment value logged when changing it for a Balloon Payments account
principalPaymentAmountstring(number)Sometimes presentThe principal payment flat amount logged when changing it for a Revolving Credit account
principalPaymentPercentagestring(number)Sometimes presentThe principal payment percentage value logged when changing it for a Revolving Credit account

LoanTrancheDetailsDto

NameTypeAvailabilityDescription
amountstring(number)Sometimes presentThe amount this tranche has available for disburse
disbursementDetailsTrancheDisbursementDetailsDTOSometimes presentThe disbursement details of this tranche
fees[CustomPredefinedFeeDTO]Sometimes presentFees that are associated with this tranche
moneyAmountMoneySometimes present
trancheNumberstring(number)Sometimes presentIndex indicating the tranche number

LoanTransactionDetailsDTO

Represents the loan transaction details.

NameTypeAvailabilityDescription
customFieldKeysobjectSometimes present
customFieldsobjectSometimes presentMap of custom field values on account
encodedKeystringSometimes presentThe encoded key of the entity, generated, globally unique
internalTransferbooleanSometimes presentWhether the transaction was transferred between loans or deposit accounts
targetDepositAccountKeystringSometimes presentIn case of a transaction to a deposit account this represent the deposit account key to which the transaction was made.
transactionChannelIdstringSometimes presentThe ID of the transaction channel associated with the transaction details.
transactionChannelKeystringSometimes presentThe encoded key of the transaction channel associated with the transaction details.

LoanTransactionTypeDTO

The type of loan transaction.

Enumerated values: IMPORT | DISBURSEMENT | DISBURSEMENT_ADJUSTMENT | WRITE_OFF | WRITE_OFF_ADJUSTMENT | REPAYMENT | PAYMENT_MADE | WITHDRAWAL_REDRAW | WITHDRAWAL_REDRAW_ADJUSTMENT | FEE_APPLIED | FEE_CHARGED | FEES_DUE_REDUCED | FEE_ADJUSTMENT | PENALTY_APPLIED | PENALTY_ADJUSTMENT | PENALTIES_DUE_REDUCED | REPAYMENT_ADJUSTMENT | PAYMENT_MADE_ADJUSTMENT | INTEREST_RATE_CHANGED | TAX_RATE_CHANGED | PENALTY_RATE_CHANGED | INTEREST_APPLIED | INTEREST_APPLIED_ADJUSTMENT | INTEREST_DUE_REDUCED | PENALTY_REDUCTION_ADJUSTMENT | FEE_REDUCTION_ADJUSTMENT | INTEREST_REDUCTION_ADJUSTMENT | DEFERRED_INTEREST_APPLIED | DEFERRED_INTEREST_APPLIED_ADJUSTMENT | DEFERRED_INTEREST_PAID | DEFERRED_INTEREST_PAID_ADJUSTMENT | INTEREST_LOCKED | FEE_LOCKED | PENALTY_LOCKED | INTEREST_UNLOCKED | FEE_UNLOCKED | PENALTY_UNLOCKED | REDRAW_TRANSFER | REDRAW_REPAYMENT | REDRAW_TRANSFER_ADJUSTMENT | REDRAW_REPAYMENT_ADJUSTMENT | TRANSFER | TRANSFER_ADJUSTMENT | BRANCH_CHANGED | TERMS_CHANGED | CARD_TRANSACTION_REVERSAL | CARD_TRANSACTION_REVERSAL_ADJUSTMENT | DUE_DATE_CHANGED | DUE_DATE_CHANGED_ADJUSTMENT | ACCOUNT_TERMINATED | ACCOUNT_TERMINATED_ADJUSTMENT

LockedAccountTotalDueTypeDTO

Type of total due amount for a locked account.

Enumerated values: BALANCE_AMOUNT | DUE_AMOUNT_ON_LATE_INSTALLMENTS

Money

NameTypeAvailabilityDescription
absoluteValueNoneSometimes present
amountstring(number)Sometimes present
negativebooleanSometimes present
negativeOrZerobooleanSometimes present
numberOfDecimalDigitsstring(number)Sometimes present
positivebooleanSometimes present
positiveOrZerobooleanSometimes present
zerobooleanSometimes present

OverpaymentDetailsDto

NameTypeAvailabilityDescription
ercAllowanceAmountstring(number)Sometimes presentThe erc free allowance amount
overPaymentAmountstring(number)Sometimes presentThe overpayment amount paid
transactionKeystringSometimes present

PaymentMethodDTO

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

Enumerated values: HORIZONTAL | VERTICAL

PenaltySettingsDTO

The penalty settings, holds all the fields regarding penalties

NameTypeAvailabilityDescription
loanPenaltyCalculationMethodNoneSometimes presentThe last penalty calculation method, represents on what amount are the penalties calculated.
penaltyRatestring(number)Sometimes presentThe penalty rate, represents the rate (in percent) which is charged as a penalty.

PeriodicPaymentDTO

NameTypeAvailabilityDescription
amountstring(number)Always presentThe PMT value used in periodic payment
encodedKeystringSometimes presentThe encoded key of the periodic payment, auto generated, unique.
toInstallmentstring(number)Always presentThe installment's position up to which the PMT will be used

PlannedInstallmentFeeDTO

NameTypeAvailabilityDescription
amountstring(number)Sometimes presentThe amount of the planned fee.
applyOnDatestring(date-time)Sometimes presentThe date when a planned fee should be applied, overriding installment's due date. It should match the interval of the installment. If it belong to first installment, it should be between disbursement date and installment due date.
encodedKeystringSometimes presentThe encoded key of the planned installment fee, auto generated, unique.
installmentKeystringSometimes presentThe encoded key of the installment on which the predefined fee is planned.
installmentNumberstring(number)Sometimes presentThe number of the installment on which the predefined fee is planned. It is used only in the case when fees are created at the same time with the loan account creation or during preview schedule, before account creation, otherwise this should be empty and installmentKey will be used to identify an installment.
predefinedFeeKeystringAlways presentThe encoded key of the predefined fee which is planned.

PrepaymentRecalculationMethodDTO

The prepayment recalculation method types.

Enumerated 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

PrepaymentSettingsDTO

The prepayment settings, holds all prepayment properties.

NameTypeAvailabilityDescription
applyInterestOnPrepaymentMethodNoneSometimes presentApply interest on prepayment method copied from loan product on which this account is based.
elementsRecalculationMethodNoneSometimes presentThe elements recalculation method, indicates how the declining balance with equal installments repayments are recalculated.
prepaymentRecalculationMethodPrepaymentRecalculationMethodDTOSometimes presentPrepayment recalculation method copied from the loan product on which this account is based.
principalPaidInstallmentStatusNoneSometimes presentInstallment status for the case when principal is paid off (copied from loan product).

PrincipalPaidInstallmentStatusDTO

The status of installment after the principal was paid off as part of an over-payment.

Enumerated values: PARTIALLY_PAID | PAID | ORIGINAL_TOTAL_EXPECTED_PAID

PrincipalPaymentAccountSettingsDTO

The principal payment account settings, holds the required information for the principal payment process of an account.

NameTypeAvailabilityDescription
amountstring(number)Sometimes presentFixed amount for being used for the repayments principal due.
encodedKeystringSometimes presentThe encoded key of the principal payment base settings, auto generated, unique.
includeFeesInFloorAmountbooleanSometimes presentBoolean flag, if true, the fees will be included along with the principal in the repayment floor amount, for a revolving credit account
includeInterestInFloorAmountbooleanSometimes presentBoolean flag, if true, the interest will be included along with the principal in the repayment floor amount, for a revolving credit account
percentagestring(number)Sometimes presentPercentage of principal amount used for the repayments principal due.
principalCeilingValuestring(number)Sometimes presentThe maximum principal due amount a repayment made with this settings can have
principalFloorValuestring(number)Sometimes presentThe minimum principal due amount a repayment made with this settings can have
principalPaymentMethodPrincipalPaymentMethodDTOSometimes presentThe method of principal payment for revolving credit.
totalDueAmountFloorstring(number)Sometimes presentThe minimum total due amount a repayment made with this settings can have
totalDuePaymentPrincipalPaymentMethodDTOSometimes presentThe method of total due payment for revolving credit

PrincipalPaymentMethodDTO

The principal payment method (for revolving credits)

Enumerated values: FLAT | OUTSTANDING_PRINCIPAL_PERCENTAGE | PRINCIPAL_PERCENTAGE_LAST_DISB | TOTAL_BALANCE_PERCENTAGE | TOTAL_BALANCE_FLAT | TOTAL_PRINCIPAL_PERCENTAGE

RepaymentPeriodUnitDTO

The frequency of the loan repayment.

Enumerated values: DAYS | WEEKS | MONTHS | YEARS

RepaymentScheduleMethodDTO

The method used by the loans to compute the repayment schedule.

Enumerated values: NONE | FIXED | DYNAMIC

RevolvingAccountSettingsDTO

The number of previewed instalments for an account

NameTypeAvailabilityDescription
numberOfPreviewedInstalmentsstring(number)Sometimes presentThe number of previewed instalments

ScheduleDueDatesMethodDTO

The schedule due dates method. Used by the loan accounts to determine the due dates of the repayments.

Enumerated values: INTERVAL | FIXED_DAYS_OF_MONTH

ScheduleSettingsDTO

The schedule settings, holds all schedule properties.

NameTypeAvailabilityDescription
billingCycleNoneSometimes presentThe billing cycle start days.
defaultFirstRepaymentDueDateOffsetstring(number)Sometimes presentThe default first repayment due date offset, indicates how many days the first repayment due date should be extended(all other due dates from the schedule are relative to first repayment due date - they will also be affected by the offset)
fixedDaysOfMonth[string(number)]Sometimes presentSpecifies the days of the month when the repayment due dates should be. Only available if the Repayment Methodology is FIXED_DAYS_OF_MONTH.
gracePeriodstring(number)Always presentThe grace period. Represents the grace period for loan repayment - in number of installments.
gracePeriodTypeNoneSometimes presentThe grace period type. Representing the type of grace period which is possible for a loan account.
hasCustomSchedulebooleanSometimes presentFlag used when the repayments schedule for the current account was determined by the user, by editing the due dates or the principal due
paymentPlan[PeriodicPaymentDTO]Sometimes presentA list of periodic payments for the current loan account.
periodicPaymentstring(number)Sometimes presentThe periodic payment amount for the accounts which have balloon payments or Reduce Number of Installments and Optimized Payments
previewScheduleNoneSometimes presentThe number of previewed instalments.
principalRepaymentIntervalstring(number)Sometimes presentThe principal repayment interval. Indicates the interval of repayments that the principal has to be paid.
repaymentInstallmentsstring(number)Sometimes presentThe repayment installments. Represents how many installments are required to pay back the loan.
repaymentPeriodCountstring(number)Sometimes presentThe repayment period count. Represents how often the loan is to be repaid: stored based on the type repayment option.
repaymentPeriodUnitNoneSometimes presentThe repayment period unit. Represents the frequency of loan repayment.
repaymentScheduleMethodNoneSometimes presentThe repayment schedule method. Represents the method that determines whether the schedule will be fixed all over the loan account's life cycle or will be dynamically recomputed when required.
scheduleDueDatesMethodNoneSometimes presentThe schedule due dates method. Represents the methodology used by this account to compute the due dates of the repayments.
shortMonthHandlingMethodShortMonthHandlingMethodDTOSometimes presentThe short handling method. Determines how to handle the short months, if they select a fixed day of month > 28. Will be null if no such date is selected and also for the Interval methodology. Only available if the Repayment Methodology is FIXED_DAYS_OF_MONTH.

ShortMonthHandlingMethodDTO

The short month handling method type for a loan account.

Enumerated values: LAST_DAY_IN_MONTH | FIRST_DAY_OF_NEXT_MONTH

TaxesDTO

The taxes applied within a transaction.

NameTypeAvailabilityDescription
deferredTaxOnInterestAmountstring(number)Sometimes presentHow much taxes on the interest that was pre-paid were added/removed in account, within this transaction. If there is any deferred tax on interest amount set in this transaction, that amount should be included in this field.
taxOnFeesAmountstring(number)Sometimes presentHow much taxes on the fees that were paid in this transaction were added/removed in account, within this transaction.
taxOnInterestAmountstring(number)Sometimes presentHow much taxes on the interest that was paid in this transaction were added/removed in account, within this transaction.
taxOnInterestFromArrearsAmountstring(number)Sometimes presentThe amount of taxes on the interest from arrears that were applied/paid in account, within this transaction.
taxOnPaymentHolidaysIntereststring(number)Sometimes presentThe amount of taxes on the Payment Holidays interest that were added/removed in account, within this transaction.
taxOnPenaltyAmountstring(number)Sometimes presentHow much taxes on the penalties that were paid in this transaction were added/removed in account, within this transaction.
taxRatestring(number)Sometimes presentThe tax rate that was set or changed in this transaction.

TrancheDisbursementDetailsDTO

The disbursement details regarding a loan tranche.

NameTypeAvailabilityDescription
disbursementTransactionKeystringSometimes presentThe key of the disbursement transaction logged when this tranche was disbursed. This field will be null until the tranche disbursement
expectedDisbursementDatestring(date-time)Sometimes presentThe date when this tranche is supposed to be disbursed (as Organization Time)

TransactionBalancesDTO

The balances changed within a transaction.

NameTypeAvailabilityDescription
advancePositionstring(number)Sometimes presentCaptures the advance (prepaid) amount.
arrearsPositionstring(number)Sometimes presentCaptures the arrears position amount for the account in arrears.
expectedPrincipalRedrawstring(number)Sometimes presentThe difference between principal balance and redraw balance after each transaction performed on the loan account.
principalBalancestring(number)Sometimes presentThe account redraw balance captured after the transaction update.
redrawBalancestring(number)Sometimes presentThe account redraw balance captured after the transaction update.
totalBalancestring(number)Sometimes presentThe running balance still owed for the loan.

TransactionInterestSettingsDTO

The interest settings, holds all the properties regarding interests for the loan account.

NameTypeAvailabilityDescription
indexInterestRatestring(number)Sometimes presentThe value of the index interest rate
interestRatestring(number)Sometimes presentThe interest rate. Represents the interest rate for the loan account. The interest on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount.

TriggerDTO

Shows the event that will trigger a fee

Enumerated values: MANUAL | MANUAL_PLANNED | DISBURSEMENT | CAPITALIZED_DISBURSEMENT | UPFRONT_DISBURSEMENT | LATE_REPAYMENT | PAYMENT_DUE | PAYMENT_DUE_APPLIED_ON_DUE_DATES | ARBITRARY | IOF | EARLY_REPAYMENT_CHARGE


Was this article helpful?

What's Next