Refinanceloanaccountaction
The request structure for performing the refinance loan account action
Choose whether to keep the same account ID as the originating account. If true, the 'id' field in the 'loanAccount' object should not be provided.
loanAccount objectrequired
The new loan account settings, allowed on the loan account refinance
accountArrearsSettings object
The arrears settings, allowed on the loan account restructure
The arrears tolerance amount
The arrears tolerance period value
disbursementDetails objectrequired
The disbursement details, allowed on the loan account refinance
The date of the expected disbursement
2016-09-06T13:37:50+03:00fees object[]
List of fees that should be applied at the disbursement time.
The amount of the custom fee.
The encoded key of the custom predefined fee, auto generated, unique.
fee object
The response representation of the PredefinedFee. Represents a fee with a defined name and a fixed value.
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, UNAPPLIED_FUNDS]
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]
The percentage of the custom fee.
The encoded key of the predefined fee
The date of the expected first payment
2016-09-06T13:37:50+03:00The encoded key of the entity, generated, globally unique
guarantors object[]
The guarantees associated with the refinanced loan account
The amount used by the client for the guaranty
The name of a value the client guarantees with (populated when the guaranty type is ASSET)
The key of the deposit account used by the guarantor (populated when the guaranty type is GUARANTOR). It can be null.
The encoded key of the security, auto generated, unique.
The key of the client/group used as the guarantor.
Indicated the account holder type.
Possible values: [CLIENT, GROUP]
Id of the new loan account.
interestSettings object
The interest settings, allowed on the loan account restructure
accountInterestRateSettings object[]
Adjustable interest rates settings for loan account
The encoded key of the interest rate settings, auto generated, unique
Index rate source key.
Interest rate 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]
Interest spread value.
Date since an interest rate is valid
2016-09-06T13:37:50+03:00The interest rate for the restructured loan account
The interest spread for the restructured loan account
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.
The name of the new loan account.
The loan account notes
penaltySettings object
The penalty settings, allowed on the loan account restructure.
The penalty rate
principalPaymentSettings object
The principal payment account settings, allowed on the loan account restructure
Fixed principal payment amount
Principal payment percentage
The key of the loan product that this account is based on
scheduleSettings object
The schedule settings, allowed on the loan account restructure
The PMT is calculated as the loan would have [amortizationPeriod] installments.
billingCycleDays object
Defines the billing cycles settings for a loan account
The billing cycle start days in case it is enabled
The days of the month, when the repayment due dates should be
The grace period
paymentPlan object[]
A list of periodic payments for the current loan account.
The PMT value used in periodic payment
The encoded key of the periodic payment, auto generated, unique.
The installment's position up to which the PMT will be used
The periodic payment
previewSchedule object
The number of previewed instalments for an account
The number of previewed instalments
The number of installments
The payments frequency per set period of time
The frequency of the loan repayment.
Possible values: [DAYS, WEEKS, MONTHS, YEARS]
The top-up amount
writeOffAmounts object
The write-off amounts, allowed on the loan account refinance
Fee write-off amount
Interest write-off amount
Interest Bearing Fees write-off amount
Interest Bearing Fees Interest write-off amount
Penalty write-off amount
{
"keepSameAccountId": true,
"loanAccount": {
"accountArrearsSettings": {
"tolerancePercentageOfOutstandingPrincipal": 0,
"tolerancePeriod": 0
},
"disbursementDetails": {
"expectedDisbursementDate": "2016-09-06T13:37:50+03:00",
"fees": [
{
"amount": 0,
"encodedKey": "string",
"fee": {
"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"
},
"percentage": 0,
"predefinedFeeEncodedKey": "string"
}
],
"firstRepaymentDate": "2016-09-06T13:37:50+03:00"
},
"encodedKey": "string",
"guarantors": [
{
"amount": 0,
"assetName": "string",
"depositAccountKey": "string",
"encodedKey": "string",
"guarantorKey": "string",
"guarantorType": "CLIENT"
}
],
"id": "string",
"interestSettings": {
"accountInterestRateSettings": [
{
"encodedKey": "string",
"indexSourceKey": "string",
"interestRate": 0,
"interestRateCeilingValue": 0,
"interestRateFloorValue": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestSpread": 0,
"validFrom": "2016-09-06T13:37:50+03:00"
}
],
"interestRate": 0,
"interestSpread": 0,
"pmtAdjustmentThreshold": {
"method": "WORKING_DAYS",
"numberOfDays": 0
}
},
"loanName": "string",
"notes": "string",
"penaltySettings": {
"penaltyRate": 0
},
"principalPaymentSettings": {
"amount": 0,
"percentage": 0
},
"productTypeKey": "string",
"scheduleSettings": {
"amortizationPeriod": 0,
"billingCycleDays": {
"days": [
0
]
},
"fixedDaysOfMonth": [
0
],
"gracePeriod": 0,
"paymentPlan": [
{
"amount": 0,
"encodedKey": "string",
"toInstallment": 0
}
],
"periodicPayment": 0,
"previewSchedule": {
"numberOfPreviewedInstalments": 0
},
"repaymentInstallments": 0,
"repaymentPeriodCount": 0,
"repaymentPeriodUnit": "DAYS"
}
},
"topUpAmount": 0,
"writeOffAmounts": {
"fee": 0,
"interest": 0,
"interestBearingFees": 0,
"interestBearingFeesInterest": 0,
"interestFromArrears": 0,
"penalty": 0
}
}