Creditarrangementaccounts
Represents loan and deposit accounts linked to a credit arrangement.
depositAccounts object[]
List of the deposit accounts linked to the credit arrangement.
The encoded key of the account holder, which is an individual client or group.
Indicated the account holder type.
Possible values: [CLIENT, GROUP]
The state of the deposit account.
Possible values: [PENDING_APPROVAL, APPROVED, ACTIVE, ACTIVE_IN_ARREARS, MATURED, LOCKED, DORMANT, CLOSED, CLOSED_WRITTEN_OFF, WITHDRAWN, CLOSED_REJECTED]
The deposit account type and the product that it belongs to.
Possible values: [CURRENT_ACCOUNT, REGULAR_SAVINGS, FIXED_DEPOSIT, SAVINGS_PLAN, INVESTOR_ACCOUNT]
accruedAmounts object
Represents information about the accrued amounts of deposit accounts.
The amount of positive interest that has been accrued in the account.
The amount of negative interest that has been accrued in the account.
The amount of overdraft interest that has been accrued in the account.
The amount of technical overdraft interest that has been accrued in the account.
The date when the deposit account was activated, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The date when the deposit account was approved, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The key of the branch that this deposit account is assigned to.
The key of the centre that this account is assigned to.
The key of the user that this deposit is assigned to.
balances object
Represents information about the balances of a deposit account.
The current available balance for deposit transactions.
The sum of all the blocked amounts on an account.
The amount of fees due to be paid on this account.
The sum of all the authorization hold amounts that have CRDT as the creditDebitIndicator for an account.
The sum of all the authorization hold amounts that have DBIT as the creditDebitIndicator for an account.
The locked amount that is not available for withdrawal in the account. For more information, see Deposit Account Overview Details.
The overdraft amount that has been taken out in the account. For more information, see Overdraft Products.
The amount of interest due to be paid on an account as a result of an authorized overdraft.
The technical overdraft amount that has been taken out in the account. For more information, see Technical Overdraft.
The amount of interest due to be paid on an account as a result of a technical overdraft.
The current balance of the account.
The date when the deposit account was closed, in UTC.
2016-09-06T13:37:50+03:00The date this deposit account was created, in UTC.
2016-09-06T13:37:50+03:00The key to the credit arrangement where this account is registered.
The currency code.
The encoded key of the deposit account, which is auto-generated and unique.
The ID of the deposit account, which can be generated and customized - but must be unique.
interestSettings object
Represents information about the deposit account's interest settings.
interestPaymentSettings object
Represents information about the interest payment settings.
interestPaymentDates object[]
The list of all dates when the interest is paid into the deposit account.
The day in the month
The month of the year
The interest payment point, which specifies when the interest should be paid to the account.
Possible values: [FIRST_DAY_OF_MONTH, EVERY_WEEK, EVERY_OTHER_WEEK, EVERY_MONTH, EVERY_3_MONTHS, ON_FIXED_DATES, DAILY, ANNUALLY, BI_ANNUALLY, ON_ACCOUNT_MATURITY]
interestRateSettings object
Represents information about the interest rate settings for deposit accounts.
The encoded key for the set of interest settings, which is auto-generated and unique.
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.
Possible values: [ANNUALIZED, EVERY_MONTH, EVERY_FOUR_WEEKS, EVERY_WEEK, EVERY_DAY, EVERY_X_DAYS]
The number of times to apply interest in a time period.
The interest rate for the deposit account.
The number of times to review the interest rate in a time period.
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]
The terms for how interest rate is determined when accruing for an account.
Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]
interestRateTiers object[]
The list of interest rate tiers, which hold the values to define how interest is calculated.
The encoded key of the interest rate tier, auto generated, unique
The top-limit value for the account balance in order to determine if this tier is used or not
The rate used for computing the interest for an account which has the balance less than the ending balance
The index interest rate that is used to calculate the interest rate that is applied to accounts.
internalControls object
Represents information about internal controls.
The maximum deposit balance of the account.
The maximum amount allowed for a withdrawal.
The recommended amount for a deposit.
The target amount for a deposit made towards a savings goal.
The date when the account was last evaluated for interest calculations and maturity, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The date when interest was last calculated for the account, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The date when regular interest was last reviewed, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The date when interest was last applied on the account, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The last update date for the deposit account, in UTC.
2016-09-06T13:37:50+03:00The date when the overdraft interest was last reviewed, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The date when the deposit account was set to In Arrears, or null if the account is not In Arrears. The date is in the organization's timezone and time format.
2016-09-06T13:37:50+03:00Lists all loan account keys on which the deposit account is used as the settlement account.
The date when the deposit account was locked, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The date when the account matures, for fixed or compulsory savings plans, in the organization's timezone and time format.
2016-09-06T13:37:50+03:00The migration event encoded key associated with this deposit account. If this account was imported, you can track which migration event it came from.
The deposit account name.
The notes or description attached to this object.
overdraftInterestSettings object
Represents information about a deposit account's overdraft interest settings.
interestRateSettings object
Represents information about overdraft interest rate settings for deposit accounts.
The encoded key for the set of interest settings, which is auto-generated and unique.
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.
Possible values: [ANNUALIZED, EVERY_MONTH, EVERY_FOUR_WEEKS, EVERY_WEEK, EVERY_DAY, EVERY_X_DAYS]
The number of times to apply interest in a time period.
The interest rate for the deposit account.
The number of times to review the interest rate in a time period.
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]
The terms for how interest rate is determined when accruing for an account.
Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]
interestRateTiers object[]
The list of interest rate tiers, which hold the values to define how interest is calculated.
The encoded key of the interest rate tier, auto generated, unique
The top-limit value for the account balance in order to determine if this tier is used or not
The rate used for computing the interest for an account which has the balance less than the ending balance
The index interest rate that is used to calculate the interest rate that is applied to accounts.
overdraftSettings object
Represents information about a deposit account's overdraft settings.
TRUE if this account supports overdraft, FALSE otherwise.
The expiration date of an overdraft.
2016-09-06T13:37:50+03:00The limit amount that may be taken out as overdraft, where null means 0.
ownershipHistory object[]
The history of deposit account ownership
They key of the previous account holder
The transfer date of the account ownership
2016-09-06T13:37:50+03:00The key to the product type that this account is based on.
The tax source where the account withholding taxes will be updated.
loanAccounts object[]
List of loan accounts linked to the credit arrangement.
accountArrearsSettings object
The account arrears settings, holds the required information for the arrears settings of an account.
The arrears date calculation method.
Possible values: [ACCOUNT_FIRST_WENT_TO_ARREARS, LAST_LATE_REPAYMENT, ACCOUNT_FIRST_BREACHED_MATERIALITY_THRESHOLD]
The encoded key of the arrears base settings, auto generated, unique.
Defines monthly arrears tolerance day value.
Shows whether the non working days are taken in consideration or not when applying penaltees/late fees or when setting an account into arrears
Possible values: [INCLUDED, EXCLUDED]
Defines the tolerance calculation method
Possible values: [ARREARS_TOLERANCE_PERIOD, MONTHLY_ARREARS_TOLERANCE_DAY]
The tolerance floor amount.
Defines the arrears tolerance amount.
Defines the arrears tolerance period value.
The encoded key of the account holder.
Indicated the account holder type.
Possible values: [CLIENT, GROUP]
All the generic account states applicable to loans.
Possible values: [PARTIAL_APPLICATION, PENDING_APPROVAL, APPROVED, ACTIVE, ACTIVE_IN_ARREARS, CLOSED, CLOSED_WRITTEN_OFF, CLOSED_REJECTED]
All the generic account sub states applicable to loans.
Possible values: [PARTIALLY_DISBURSED, LOCKED, LOCKED_CAPPING, REFINANCED, RESCHEDULED, WITHDRAWN, REPAID, REJECTED, WRITTEN_OFF, TERMINATED]
The amount of interest that has been accrued in the loan account.
The accrued penalty, represents the amount of penalty that has been accrued in the loan account.
The encoded key of the transaction that activated the loan account.
Adjust the total due for repayment when the repayment period is different than the repayment frequency
True if advance repayment is allowed; false otherwise.
DEPRECATED - Will always be false.
The date the loan account was approved.
2016-09-06T13:37:50+03:00The arrears tolerance (period or day of month) depending on the product settings.
assets object[]
The list of assets associated with the current 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]
The original amount used by the client for a collateral asset
originalCurrency object
Represents a currency eg. USD, EUR.
Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.
Possible 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, SLE, 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, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZIG, ZWG, ZMK, ZWL, ZMW, SSP, NON_FIAT]
Currency code for NON_FIAT currency.
The key of the branch this loan account is assigned to. The branch is set to unassigned if no branch field is set.
The key of the centre this account is assigned to.
The key of the user this loan account is assigned to.
balances object
The loan account balance details.
Available credit balance on the loan account.
The fees balance. Represents the total fees expected to be paid on this account at a given moment.
The fees due. Representing the total fees due for the account.
The fees paid. Represents the total fees paid for the account.
The sum of all the authorization hold amounts on this account.
Represents the total interest owed by the client (total interest applied for account minus interest paid).
The interest due. Indicates how much interest it's due for the account at this moment.
The 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).
The interest from arrears due. Indicates how much interest from arrears it's due for the account at this moment.
The interest from arrears paid, indicates total interest from arrears paid into the account.
The interest paid, indicates total interest paid into the account.
The penalty balance. Represents the total penalty expected to be paid on this account at a given moment.
The penalty due. Represents the total penalty amount due for the account.
The Penalty paid. Represents the total penalty amount paid for the account.
The total principal owned by the client, from now on (principal disbursed - principal paid).
The principal due, indicates how much principal it's due at this moment.
The principal paid, holds the value of the total paid into the account.
The total redraw amount owned by the client, from now on.
The date the loan was closed.
2016-09-06T13:37:50+03:00The date the loan account was created.
2016-09-06T13:37:50+03:00The key to the line of credit where this account is registered to.
creditBalanceSettings object
Credit balance details for a Revolving Credit loan account.
Flag indicating whether deposits are allowed when the account has a positive principal balance.
The maximum allowed credit balance.
Automatic allocation behavior for credit balance on Revolving Credit accounts.
Possible values: [NO_ALLOCATION, COVER_DUE_AMOUNT, COVER_BALANCE_AMOUNT]
currency object
Represents a currency eg. USD, EUR.
Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.
Possible 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, SLE, 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, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZIG, ZWG, ZMK, ZWL, ZMW, SSP, NON_FIAT]
Currency code for NON_FIAT currency.
The number of days the loan account is in arrears.
The number of days a repayment for the loan account is late.
disbursementDetails object
The the disbursement details it holds the information related to the disbursement details as disbursement date, first repayment date, disbursement fees.
The activation date, the date when the disbursement actually took place.
2016-09-06T13:37:50+03:00The encoded key of the disbursement details, auto generated, unique
The date of the expected disbursement.Stored as Organization Time.
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.
The percentage of the custom fee.
The encoded key of the predefined fee
The date of the expected first repayment. Stored as Organization Time.
2016-09-06T13:37:50+03:00transactionDetails object
Represents the loan transaction details.
The encoded key of the entity, generated, globally unique
Whether the transaction was transferred between loans or deposit accounts
In case of a transaction to a deposit account this represent the deposit account key to which the transaction was made.
The ID of the transaction channel associated with the transaction details.
The encoded key of the transaction channel associated with the transaction details.
The encoded key of the loan account, it is auto generated, and must be unique.
feesSettings object
The fee settings, holds all the properties regarding fees for the loan account.
The accrued fee. Represents the accrued fee for the loan account. The fee on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount.
The accrued fee from arrears. Represents the accrued fee from arrears for the loan account. The fee on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount.
The fee rate. Represents the fee rate for the loan account. The fee on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount.
fundingSources object[]
The list of funds associated with the 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 entity, generated, globally unique
The key of the client/group used as the guarantor.
Indicated the account holder type.
Possible values: [CLIENT, GROUP]
Investor fund unique identifier. All versions of an investor fund will have same id.
The constraint minimum value
Percentage of loan shares this investor owns
Shows whether the repayment transactions with entry date set in the future are allowed or not for this loan account.
Possible values: [NO_FUTURE_PAYMENTS, ACCEPT_FUTURE_PAYMENTS, ACCEPT_OVERPAYMENTS]
guarantors object[]
The list of guarantees associated with the 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]
The ID of the loan account, it can be generated and customized, and must be unique.
The interest that is accrued in the current billing cycle.
The value of the interest booked by the organization from the accounts funded by investors. Null if the funds are not enabled.
The amount of interest from arrears that has been accrued in the loan account.
interestSettings object
The interest settings, holds all the properties regarding interests for the loan account.
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 accrue interest after maturity. If the product support this option, specify if the interest should be accrued after the account maturity date.
Indicates whether late interest is accrued for this loan account
The effective interest rate. Represents the interest rate for the loan accounts with semi-annually compounding product.
The interest application method for a loan account. It shows the method used by the loans defining how the interest gets applied.
Possible values: [AFTER_DISBURSEMENT, REPAYMENT_DUE_DATE, FIXED_DAYS_OF_MONTH]
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.
Possible values: [ONLY_PRINCIPAL, PRINCIPAL_AND_INTEREST, PRINCIPAL_AND_FEE, PRINCIPAL_INTEREST_AND_FEE]
The interest calculation method for a loan account. Shows the different interest calculation methods.
Possible values: [FLAT, DECLINING_BALANCE, DECLINING_BALANCE_DISCOUNTED, EQUAL_INSTALLMENTS]
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.
Possible values: [ANNUALIZED, EVERY_MONTH, EVERY_FOUR_WEEKS, EVERY_WEEK, EVERY_DAY, EVERY_X_DAYS]
The 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.
Interest rate update frequency unit count.
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 to be added to active organization index interest rate in order to find out actual interest rate
The possible values for how we compute and apply the interest
Possible values: [SIMPLE_INTEREST, CAPITALIZED_INTEREST, COMPOUNDING_INTEREST]
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 date the loan account has last been evaluated for interest, principal, fees, and penalties calculations expressed in the organization time format and time zone.
2016-09-06T13:37:50+03:00The date of the last time the loan account had interest applied (stored to interest balance), expressed in the organization time format and time zone.
2016-09-06T13:37:50+03:00The date the interest was reviewed last time, stored in the organization time format and time zone.
2016-09-06T13:37:50+03:00The 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.
2016-09-06T13:37:50+03:00The last date the loan was updated.
2016-09-06T13:37:50+03:00The 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.
2016-09-06T13:37:50+03:00The date the tax rate on the loan account was last checked, expressed in the organization time format and time zone.
2016-09-06T13:37:50+03:00The 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]
The loan amount.
The name of the loan account.
Type of total due amount for a locked account.
Possible values: [BALANCE_AMOUNT, DUE_AMOUNT_ON_LATE_INSTALLMENTS]
A list with operations which are locked when the account is in the AccountState.LOCKED substate.
Possible values: [APPLY_INTEREST, APPLY_FEES, APPLY_PENALTIES]
The migration event encoded key associated with this loan account. If this account was imported, track which 'migration event' they came from.
Adjust the interest for the first repayment when the first repayment period is different than the repayment frequency
The notes about this loan account.
The key of the original rescheduled or refinanced loan account.
The amount of interest that has been accrued during payment holidays in the loan account.
The payment allocation method used by the loans defining how the payments get performed.
Possible values: [HORIZONTAL, VERTICAL]
penaltySettings object
The penalty settings, holds all the fields regarding penalties
The last penalty calculation method, represents on what amount are the penalties calculated.
Possible values: [NONE, OVERDUE_BALANCE, OVERDUE_BALANCE_AND_INTEREST, OVERDUE_BALANCE_INTEREST_AND_FEE, OUTSTANDING_PRINCIPAL]
The penalty rate, represents the rate (in percent) which is charged as a penalty.
plannedInstallmentFees object[]
The list with manual fees planned on the installments of the loan account.
The amount of the planned fee.
The 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.
2016-09-06T13:37:50+03:00The encoded key of the planned installment fee, auto generated, unique.
The encoded key of the installment on which the predefined fee is planned.
The 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.
The encoded key of the predefined fee which is planned.
prepaymentSettings object
The prepayment settings, holds all prepayment properties.
The apply interest method type for pre-payments.
Possible values: [AUTOMATIC, MANUAL]
The elements recalculation method types
Possible values: [PRINCIPAL_EXPECTED_FIXED, TOTAL_EXPECTED_FIXED]
Early repayment charge fee free allowance in percentage per year
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]
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
The principal payment account settings, holds the required information for the principal payment process of an account.
Fixed amount for being used for the repayments principal due.
The encoded key of the principal payment base settings, auto generated, unique.
Boolean flag, if true, the fees will be included along with the principal in the repayment floor amount, for a revolving credit account
Boolean flag, if true, the interest will be included along with the principal in the repayment floor amount, for a revolving credit account
Percentage of principal amount used for the repayments principal due.
The maximum principal due amount a repayment made with this settings can have
The minimum principal due amount a repayment made with this settings can have
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]
The minimum total due amount a repayment made with this settings can have
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]
The key for the type of loan product that this loan account is based on.
redrawSettings object
Represents the redraw settings for a loan account.
TRUE if withdrawing amounts that reduce the next due instalment repayment is restricted, FALSE otherwise.
The key pointing to where this loan account was rescheduled or refinanced to. This value is only not null if rescheduled.
scheduleSettings objectrequired
The schedule settings, holds all schedule properties.
The PMT is calculated as the loan would have [amortizationPeriod] installments.
billingCycle object
Defines the billing cycles settings for a loan account
The billing cycle start days in case it is enabled
The 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)
Specifies the days of the month when the repayment due dates should be. Only available if the Repayment Methodology is FIXED_DAYS_OF_MONTH.
The grace period. Represents the grace period for loan repayment - in number of installments.
The grace period type for a loan account.
Possible values: [NONE, PAY_INTEREST_ONLY, INTEREST_FORGIVENESS]
Flag used when the repayments schedule for the current account was determined by the user, by editing the due dates or the principal due
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 amount for the accounts which have balloon payments or Reduce Number of Installments and Optimized Payments
previewSchedule object
The number of previewed instalments for an account
The number of previewed instalments
The principal repayment interval. Indicates the interval of repayments that the principal has to be paid.
The repayment installments. Represents how many installments are required to pay back the loan.
The repayment period count. Represents how often the loan is to be repaid: stored based on the type repayment option.
The frequency of the loan repayment.
Possible values: [DAYS, WEEKS, MONTHS, YEARS]
The method used by the loans to compute the repayment schedule.
Possible values: [NONE, FIXED, DYNAMIC]
The schedule due dates method. Used by the loan accounts to determine the due dates of the repayments.
Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]
The short month handling method type for a loan account.
Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]
The encoded key of the settlement account.
The tax rate.
The date this loan account was terminated.
2016-09-06T13:37:50+03:00tranches object[]
The list of disbursement tranches available for the loan account.
The amount this tranche has available for disburse
disbursementDetails object
The disbursement details regarding a loan tranche.
The key of the disbursement transaction logged when this tranche was disbursed. This field will be null until the tranche disbursement
The date when this tranche is supposed to be disbursed (as Organization Time)
2016-09-06T13:37:50+03:00The encoded key of the transaction details , auto generated, unique.
fees object[]
Fees that are associated with this tranche
The amount of the custom fee.
The encoded key of the custom predefined fee, auto generated, unique.
The percentage of the custom fee.
The encoded key of the predefined fee
Index indicating the tranche number
Use interest accrued as total due for repayment when the repayment period is different than the repayment frequency
_Example_Custom_Fields _Example_Custom_Fields
An example of some custom field values. For more information on working with custom fields using the API, see Using Custom Fields.
A field that will appear as a checkbox in the UI. In the API, the value will be TRUE or FALSE as a string. The value must be provided as a string, not a boolean.
Possible values: [TRUE, FALSE]
A field that can contain a string of text. Pay attention to proper JSON escaping if providing values for such fields via API.
A field supporting numbers only. Please note: the value is to be provided as a string.
A field that supports enumerated values. Requests will fail if the value provided for such a field is not one of the supported IDs or values.
A date field takes a date in YYYY-MM-DD format.
2018-12-14A date field takes a timestamp in YYYY-MM-DDThh:mm:ss.SSS+hh:mm format.
2018-12-14T15:30:00.000+01:30A user link field takes the encodedKey of a Mambu user.
A group link field takes the encodedKey of a group.
A client link field stores the encodedKey of a client.
{
"depositAccounts": [
{
"accountHolderKey": "string",
"accountHolderType": "CLIENT",
"accountState": "PENDING_APPROVAL",
"accountType": "CURRENT_ACCOUNT",
"accruedAmounts": {
"interestAccrued": 0,
"negativeInterestAccrued": 0,
"overdraftInterestAccrued": 0,
"technicalOverdraftInterestAccrued": 0
},
"activationDate": "2016-09-06T13:37:50+03:00",
"approvedDate": "2016-09-06T13:37:50+03:00",
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"balances": {
"availableBalance": 0,
"blockedBalance": 0,
"feesDue": 0,
"forwardAvailableBalance": 0,
"holdBalance": 0,
"lockedBalance": 0,
"overdraftAmount": 0,
"overdraftInterestDue": 0,
"technicalOverdraftAmount": 0,
"technicalOverdraftInterestDue": 0,
"totalBalance": 0
},
"closedDate": "2016-09-06T13:37:50+03:00",
"creationDate": "2016-09-06T13:37:50+03:00",
"creditArrangementKey": "string",
"currencyCode": "string",
"encodedKey": "string",
"id": "string",
"interestSettings": {
"interestPaymentSettings": {
"interestPaymentDates": [
{
"day": 0,
"month": 0
}
],
"interestPaymentPoint": "FIRST_DAY_OF_MONTH"
},
"interestRateSettings": {
"encodedKey": "string",
"interestChargeFrequency": "ANNUALIZED",
"interestChargeFrequencyCount": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "FIXED",
"interestRateTiers": [
{
"encodedKey": "string",
"endingBalance": 0,
"endingDay": 0,
"interestRate": 0
}
],
"interestSpread": 0
}
},
"internalControls": {
"maxDepositBalance": 0,
"maxWithdrawalAmount": 0,
"recommendedDepositAmount": 0,
"targetAmount": 0
},
"lastAccountAppraisalDate": "2016-09-06T13:37:50+03:00",
"lastInterestCalculationDate": "2016-09-06T13:37:50+03:00",
"lastInterestReviewDate": "2016-09-06T13:37:50+03:00",
"lastInterestStoredDate": "2016-09-06T13:37:50+03:00",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"lastOverdraftInterestReviewDate": "2016-09-06T13:37:50+03:00",
"lastSetToArrearsDate": "2016-09-06T13:37:50+03:00",
"linkedSettlementAccountKeys": [
"string"
],
"lockedDate": "2016-09-06T13:37:50+03:00",
"maturityDate": "2016-09-06T13:37:50+03:00",
"migrationEventKey": "string",
"name": "string",
"notes": "string",
"overdraftInterestSettings": {
"interestRateSettings": {
"encodedKey": "string",
"interestChargeFrequency": "ANNUALIZED",
"interestChargeFrequencyCount": 0,
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "FIXED",
"interestRateTiers": [
{
"encodedKey": "string",
"endingBalance": 0,
"endingDay": 0,
"interestRate": 0
}
],
"interestSpread": 0
}
},
"overdraftSettings": {
"allowOverdraft": true,
"overdraftExpiryDate": "2016-09-06T13:37:50+03:00",
"overdraftLimit": 0
},
"ownershipHistory": [
{
"previousOwnerKey": "string",
"transferDate": "2016-09-06T13:37:50+03:00"
}
],
"productTypeKey": "string",
"withholdingTaxSourceKey": "string"
}
],
"loanAccounts": [
{
"accountArrearsSettings": {
"dateCalculationMethod": "ACCOUNT_FIRST_WENT_TO_ARREARS",
"encodedKey": "string",
"monthlyToleranceDay": 0,
"nonWorkingDaysMethod": "INCLUDED",
"toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
"toleranceFloorAmount": 0,
"tolerancePercentageOfOutstandingPrincipal": 0,
"tolerancePeriod": 0
},
"accountHolderKey": "string",
"accountHolderType": "CLIENT",
"accountState": "PARTIAL_APPLICATION",
"accountSubState": "PARTIALLY_DISBURSED",
"accruedInterest": 0,
"accruedPenalty": 0,
"activationTransactionKey": "string",
"adjustTotalDueForInstallmentsWithDifferentInterval": true,
"allowAdvanceRepayment": true,
"allowOffset": true,
"approvedDate": "2016-09-06T13:37:50+03:00",
"arrearsTolerancePeriod": 0,
"assets": [
{
"amount": 0,
"assetName": "string",
"depositAccountKey": "string",
"encodedKey": "string",
"guarantorKey": "string",
"guarantorType": "CLIENT",
"originalAmount": 0,
"originalCurrency": {
"code": "AED",
"currencyCode": "string"
}
}
],
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"balances": {
"creditBalance": 0,
"feesBalance": 0,
"feesDue": 0,
"feesPaid": 0,
"holdBalance": 0,
"interestBalance": 0,
"interestDue": 0,
"interestFromArrearsBalance": 0,
"interestFromArrearsDue": 0,
"interestFromArrearsPaid": 0,
"interestPaid": 0,
"penaltyBalance": 0,
"penaltyDue": 0,
"penaltyPaid": 0,
"principalBalance": 0,
"principalDue": 0,
"principalPaid": 0,
"redrawBalance": 0
},
"closedDate": "2016-09-06T13:37:50+03:00",
"creationDate": "2016-09-06T13:37:50+03:00",
"creditArrangementKey": "string",
"creditBalanceSettings": {
"allowDepositWithDebitBalance": true,
"maxCreditBalance": 0,
"revolvingAccountCreditBalanceAutoAllocationType": "NO_ALLOCATION"
},
"currency": {
"code": "AED",
"currencyCode": "string"
},
"daysInArrears": 0,
"daysLate": 0,
"disbursementDetails": {
"disbursementDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"expectedDisbursementDate": "2016-09-06T13:37:50+03:00",
"fees": [
{
"amount": 0,
"encodedKey": "string",
"percentage": 0,
"predefinedFeeEncodedKey": "string"
}
],
"firstRepaymentDate": "2016-09-06T13:37:50+03:00",
"transactionDetails": {
"encodedKey": "string",
"internalTransfer": true,
"targetDepositAccountKey": "string",
"transactionChannelId": "string",
"transactionChannelKey": "string"
}
},
"encodedKey": "string",
"feesSettings": {
"accruedFee": 0,
"accruedFeeFromArrears": 0,
"feeRate": 0
},
"fundingSources": [
{
"amount": 0,
"assetName": "string",
"depositAccountKey": "string",
"encodedKey": "string",
"guarantorKey": "string",
"guarantorType": "CLIENT",
"id": "string",
"interestCommission": 0,
"sharePercentage": 0
}
],
"futurePaymentsAcceptance": "NO_FUTURE_PAYMENTS",
"guarantors": [
{
"amount": 0,
"assetName": "string",
"depositAccountKey": "string",
"encodedKey": "string",
"guarantorKey": "string",
"guarantorType": "CLIENT"
}
],
"id": "string",
"interestAccruedInBillingCycle": 0,
"interestCommission": 0,
"interestFromArrearsAccrued": 0,
"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"
}
],
"accrueInterestAfterMaturity": true,
"accrueLateInterest": true,
"effectiveInterestRate": 0,
"interestApplicationMethod": "AFTER_DISBURSEMENT",
"interestBalanceCalculationMethod": "ONLY_PRINCIPAL",
"interestCalculationMethod": "FLAT",
"interestChargeFrequency": "ANNUALIZED",
"interestRate": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestSpread": 0,
"interestType": "SIMPLE_INTEREST",
"pmtAdjustmentThreshold": {
"method": "WORKING_DAYS",
"numberOfDays": 0
}
},
"lastAccountAppraisalDate": "2016-09-06T13:37:50+03:00",
"lastInterestAppliedDate": "2016-09-06T13:37:50+03:00",
"lastInterestReviewDate": "2016-09-06T13:37:50+03:00",
"lastLockedDate": "2016-09-06T13:37:50+03:00",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"lastSetToArrearsDate": "2016-09-06T13:37:50+03:00",
"lastTaxRateReviewDate": "2016-09-06T13:37:50+03:00",
"latePaymentsRecalculationMethod": "OVERDUE_INSTALLMENTS_INCREASE",
"loanAmount": 0,
"loanName": "string",
"lockedAccountTotalDueType": "BALANCE_AMOUNT",
"lockedOperations": [
"APPLY_INTEREST"
],
"migrationEventKey": "string",
"modifyInterestForFirstInstallment": true,
"notes": "string",
"originalAccountKey": "string",
"paymentHolidaysAccruedInterest": 0,
"paymentMethod": "HORIZONTAL",
"penaltySettings": {
"loanPenaltyCalculationMethod": "NONE",
"penaltyRate": 0
},
"plannedInstallmentFees": [
{
"amount": 0,
"applyOnDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"installmentKey": "string",
"installmentNumber": 0,
"predefinedFeeKey": "string"
}
],
"prepaymentSettings": {
"applyInterestOnPrepaymentMethod": "AUTOMATIC",
"elementsRecalculationMethod": "PRINCIPAL_EXPECTED_FIXED",
"ercFreeAllowanceAmount": 0,
"ercFreeAllowancePercentage": 0,
"prepaymentRecalculationMethod": "NO_RECALCULATION",
"principalPaidInstallmentStatus": "PARTIALLY_PAID"
},
"principalPaymentSettings": {
"amount": 0,
"encodedKey": "string",
"includeFeesInFloorAmount": true,
"includeInterestInFloorAmount": true,
"percentage": 0,
"principalCeilingValue": 0,
"principalFloorValue": 0,
"principalPaymentMethod": "FLAT",
"totalDueAmountFloor": 0,
"totalDuePayment": "FLAT"
},
"productTypeKey": "string",
"redrawSettings": {
"restrictNextDueWithdrawal": true
},
"rescheduledAccountKey": "string",
"scheduleSettings": {
"amortizationPeriod": 0,
"billingCycle": {
"days": [
0
]
},
"defaultFirstRepaymentDueDateOffset": 0,
"fixedDaysOfMonth": [
0
],
"gracePeriod": 0,
"gracePeriodType": "NONE",
"hasCustomSchedule": true,
"paymentPlan": [
{
"amount": 0,
"encodedKey": "string",
"toInstallment": 0
}
],
"periodicPayment": 0,
"previewSchedule": {
"numberOfPreviewedInstalments": 0
},
"principalRepaymentInterval": 0,
"repaymentInstallments": 0,
"repaymentPeriodCount": 0,
"repaymentPeriodUnit": "DAYS",
"repaymentScheduleMethod": "NONE",
"scheduleDueDatesMethod": "INTERVAL",
"shortMonthHandlingMethod": "LAST_DAY_IN_MONTH"
},
"settlementAccountKey": "string",
"taxRate": 0,
"terminationDate": "2016-09-06T13:37:50+03:00",
"tranches": [
{
"amount": 0,
"disbursementDetails": {
"disbursementTransactionKey": "string",
"expectedDisbursementDate": "2016-09-06T13:37:50+03:00"
},
"encodedKey": "string",
"fees": [
{
"amount": 0,
"encodedKey": "string",
"percentage": 0,
"predefinedFeeEncodedKey": "string"
}
],
"trancheNumber": 0
}
],
"useInterestAccruedAsTotalDueWhenIntervalIsDifferent": true,
"_Example_Custom_Fields": {
"Example_Checkbox_Field": "TRUE",
"Example_Free_Text_Field": "A free text field up to 255 characters in length",
"Example_Number_Field": "46290",
"Example_Select_Field": {
"example_option_id": "873023434",
"example_option_value": "option 5"
},
"Example_Date_Field": "2018-12-14",
"Example_Datetime_Field": "2020-12-20T15:30:00.000+01:00",
"Example_UserLink_Field": "8a19cda5778bea6c01778c17fdff027c",
"Example_GroupLink_Field": "8a19d63c84a36c7f0184a4f33ba85235",
"Example_ClientLink_Field": "8a19cdac84a3a6c01778a4f33baf027c"
}
}
]
}