Depositproductsconfiguration
Model representation of the deposit products configuration
depositProducts object[]required
List of all deposit products.
accountingSettings object
Accounting settings, defines the accounting settings configuration of the product.
The method of calculation used for accounting.
Possible values: [NONE, CASH, ACCRUAL]
accountingRules object[]
The list of accounting rules of the product.
General ledger financial resource 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, TAXES_PAYABLE, FEE_INCOME, PENALTY_INCOME, NEGATIVE_INTEREST_PAYABLE_RECEIVABLE, NEGATIVE_INTEREST_PAYABLE, 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, PROFIT_EXPENSE, PROFIT_PAYABLE, MUDARIB_SHARE, DISTRIBUTABLE_PROFIT]
The unique identifier of the account that is mapped to the financial resource.
The calculation method used for the interest accrued.
Possible values: [NONE, AGGREGATED_AMOUNT, BREAKDOWN_PER_ACCOUNT]
The accounting method used for the interest accrued.
Possible values: [NONE, DAILY, END_OF_MONTH]
availabilitySettings object
Holds information about product availability.
branchSettings object
Holds information about branch availability for the product.
Indicates if this product should be available for all branches
Holds the ids of the branches this product should be available for.
Marks this product as available for groups.
Marks this product as available for individuals.
Shows the available deposit product categories.
Possible values: [PERSONAL_DEPOSIT, BUSINESS_DEPOSIT, DAILY_BANKING_ACCOUNTS, BUSINESS_BANKING_ACCOUNTS, STORED_VALUE_ACCOUNTS, SHARIAH_CONSUMER_DEPOSITS, SHARIAH_BUSINESS_DEPOSITS, SHARIAH_DAILY_BANKING_ACCOUNTS, SHARIAH_BUSINESS_BANKING_ACCOUNTS, UNCATEGORIZED]
creditArrangementSettings object
The funding settings, holds the settings regarding the funding for the product.
Shows whether accounts created after this product can/should be part of a line of credit.
Possible values: [OPTIONAL, REQUIRED, NOT_REQUIRED]
currencySettings object
The currency settings for the product.
Currencies that can be used by accounts of the product.
Description for the product.
feeSettings object
Defines the fee settings of the product.
Indicates if arbitrary fees will be allowed.
fees object[]
List of all fees that can be applied for accounts of this deposit product.
accountingRules object[]
A list of accounting rules defined for this fee.
General ledger financial resource 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, TAXES_PAYABLE, FEE_INCOME, PENALTY_INCOME, NEGATIVE_INTEREST_PAYABLE_RECEIVABLE, NEGATIVE_INTEREST_PAYABLE, 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, PROFIT_EXPENSE, PROFIT_PAYABLE, MUDARIB_SHARE, DISTRIBUTABLE_PROFIT]
The unique identifier of the account that is mapped to the financial resource.
Indicates if the fee is active.
The amount of the fee.
External function
Shows the amount calculation method of a fee
Possible values: [FLAT, MAMBU_FUNCTION]
Shows when a fee should be applied; to be used with monthly deposit fees.
Possible values: [MONTHLY_FROM_ACTIVATION, FIRST_OF_EVERY_MONTH]
The id of the fee.
The name of the fee.
Shows the event that will trigger a fee.
Possible values: [MANUAL, MONTHLY_FEE]
User-defined ID, globally unique.
interestSettings object
The interest settings, defines constraints regarding interest that will be used on the deposit account based on this product.
Shows the possible values for the calculation balance methods.
Possible values: [MINIMUM, AVERAGE, END_OF_DAY, MINIMUM_TO_END_OF_DAY, FRENCH_INTEREST_ACCRUAL]
Whether locked accounts still collect Interest or not.
Shows how many days in a year should be used for calculations.
Possible values: [ACTUAL_365_FIXED, ACTUAL_364, ACTUAL_360, ACTUAL_ACTUAL_ISDA, E30_360, BUS_252, E30_42_365]
The date when the accounts under this product, will no longer have interest gains provided
1987-04-26The date when the accounts of this product will start to have interest gains provided. Starting with this date 0 interest rate is enforced on the accounts of this product.
1987-04-26interestRateSettings object
The interest rate settings, defines constraints regarding interest that will be used on the deposit account based on this product.
If the product supports this option, specify if the interest should be accrued after the account maturity date.
Interest rate review frequency unit count.
Index rate source id.
Shows the possible values for how often is interest charged on the account based of the product.
Possible values: [ANNUALIZED, EVERY_MONTH, EVERY_FOUR_WEEKS, EVERY_WEEK, EVERY_DAY, EVERY_X_DAYS]
The count of units to apply over the interval.
interestRate object
Used for keeping decimal constraints.
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
Interest rate review 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]
Shows the available deposit product interest rate terms.
Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]
interestRateTiers object[]
The list of interest rate tiers available for the current settings instance.
The top-limit value for the account balance in order to determine if this tier is used or not
The top-limit value for the account period since activation 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 maximum balance used for Interest calculation.
If interest should be payed into the deposit account.
paymentSettings object
Defines the interest payment settings for the deposit product and for deposits created based on this product
paymentDates object[]
List of all dates on which the interest is payed into deposit account
The day in the month
The month of the year
Specifies when the interest should be paid to the deposit 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]
internalControlsSettings object
Constraints and automated actions that will be applied on the accounts.
Specifies the offset availability of the product.
Specifies the number of days for an account to be fully paid in order to auto close it.
Max amount per withdrawal
openingBalance object
Used for keeping decimal constraints.
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
Recommended amount for a deposit
maturitySettings object
Maturity settings for deposit accounts
maturityPeriodInterval object
Maturity period interval constraints
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
Maturity period measurement unit
Possible values: [DAYS, WEEKS, MONTHS]
Name of deposits product.
newAccountSettings object
New Account settings for deposit accounts
The type of generator used for IDs creation.
Possible values: [INCREMENTAL_NUMBER, RANDOM_PATTERN]
The pattern that will be used for ID validation (as referred to as an input mask).
overdraftInterestSettings object
The overdraft interest settings, defines constraints regarding interest that will be used on the account created based on this product.
Whether the accounts for this product may have overdraft.
Whether the accounts for this product may have technical overdraft.
Shows the possible values for the calculation balance methods.
Possible values: [MINIMUM, AVERAGE, END_OF_DAY, MINIMUM_TO_END_OF_DAY, FRENCH_INTEREST_ACCRUAL]
Shows how many days in a year should be used for calculations.
Possible values: [ACTUAL_365_FIXED, ACTUAL_364, ACTUAL_360, ACTUAL_ACTUAL_ISDA, E30_360, BUS_252, E30_42_365]
interestRateSettings object
The overdraft interest rate settings, defines constraints regarding interest that will be used on the account created based on this product.
Interest rate review frequency unit count.
Index rate source id.
Shows the possible values for how often is interest charged on the account based of the product.
Possible values: [ANNUALIZED, EVERY_MONTH, EVERY_FOUR_WEEKS, EVERY_WEEK, EVERY_DAY, EVERY_X_DAYS]
The count of units to apply over the interval.
interestRate object
Used for keeping decimal constraints.
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
Interest rate review 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]
Shows the available deposit product interest rate terms.
Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]
interestRateTiers object[]
The list of interest rate tiers available for the current settings instance.
The top-limit value for the account balance in order to determine if this tier is used or not
The top-limit value for the account period since activation 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
How much money may be taken out for the account to go negative.
Shows the possible states of a product.
Possible values: [ACTIVE, INACTIVE]
taxSettings object
Defines some settings for taxes on the deposit product
Whether withholding taxes are enabled for this product or not
technicalOverdraftInterestSettings object
technicalOverdraftInterestRateSettings object
Interest Rate Settings holds information about technical overdraft interest rate applied to the product.
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 count of units to apply over the interval
interestRateConstraints object
Used for keeping decimal constraints.
The default value, will be used in case no other value was filled in by the user.
The maximum value.
The minimum value.
The interest rate review unit values. Shows how often is index interest rate reviewed.
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Shows the available deposit product interest rate terms.
Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]
interestRateTiers object[]
The list of interest rate tiers available for the current settings instance.
The top-limit value for the account balance in order to determine if this tier is used or not
The top-limit value for the account period since activation 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 type of deposit product. This influences the behavior and possible parameters of the account.
Possible values: [CURRENT_ACCOUNT, REGULAR_SAVINGS, FIXED_DEPOSIT, SAVINGS_PLAN, INVESTOR_ACCOUNT]
{
"depositProducts": [
{
"accountingSettings": {
"accountingMethod": "NONE",
"accountingRules": [
{
"financialResource": "PORTFOLIO_CONTROL",
"glAccountCode": "string"
}
],
"interestAccrualCalculation": "NONE",
"interestAccruedAccountingMethod": "NONE"
},
"availabilitySettings": {
"branchSettings": {
"allBranches": true,
"branches": [
"string"
]
},
"forGroups": true,
"forIndividuals": true
},
"category": "PERSONAL_DEPOSIT",
"creditArrangementSettings": {
"requirement": "OPTIONAL"
},
"currencySettings": {
"currencies": [
"string"
]
},
"description": "string",
"feeSettings": {
"allowArbitraryFees": true,
"fees": [
{
"accountingRules": [
{
"financialResource": "PORTFOLIO_CONTROL",
"glAccountCode": "string"
}
],
"active": true,
"amount": 0,
"amountCalculationFunctionName": "string",
"amountCalculationMethod": "FLAT",
"applyDateMethod": "MONTHLY_FROM_ACTIVATION",
"id": "string",
"name": "string",
"trigger": "MANUAL"
}
]
},
"id": "string",
"interestSettings": {
"calculationBalance": "MINIMUM",
"collectInterestWhenLocked": true,
"daysInYear": "ACTUAL_365_FIXED",
"interestGainsProvidedEndDate": "1987-04-26",
"interestGainsProvidedStartDate": "1987-04-26",
"interestRateSettings": {
"accrueInterestAfterMaturity": true,
"allowNegativeInterestRate": true,
"indexSourceId": "string",
"interestChargeFrequency": "ANNUALIZED",
"interestChargeFrequencyCount": 0,
"interestRate": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "FIXED",
"interestRateTiers": [
{
"endingBalance": 0,
"endingDay": 0,
"interestRate": 0
}
]
},
"maximumBalance": 0,
"paidIntoAccount": true,
"paymentSettings": {
"paymentDates": [
{
"day": 0,
"month": 0
}
],
"paymentPoint": "FIRST_DAY_OF_MONTH"
}
},
"internalControlsSettings": {
"allowOffset": true,
"dormancyPeriodDays": 0,
"maxWithdrawalAmount": 0,
"openingBalance": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"recommendedDepositAmount": 0
},
"maturitySettings": {
"maturityPeriodInterval": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"maturityPeriodUnit": "DAYS"
},
"name": "string",
"newAccountSettings": {
"idGeneratorType": "INCREMENTAL_NUMBER",
"idPattern": "string"
},
"overdraftInterestSettings": {
"allowOverdraft": true,
"allowTechnicalOverdraft": true,
"calculationBalance": "MINIMUM",
"daysInYear": "ACTUAL_365_FIXED",
"interestRateSettings": {
"allowNegativeInterestRate": true,
"indexSourceId": "string",
"interestChargeFrequency": "ANNUALIZED",
"interestChargeFrequencyCount": 0,
"interestRate": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "FIXED",
"interestRateTiers": [
{
"endingBalance": 0,
"endingDay": 0,
"interestRate": 0
}
]
},
"maxOverdraftLimit": 0
},
"state": "ACTIVE",
"taxSettings": {
"withholdingTaxEnabled": true
},
"technicalOverdraftInterestSettings": {
"technicalOverdraftInterestRateSettings": {
"interestChargeFrequency": "ANNUALIZED",
"interestChargeFrequencyCount": 0,
"interestRateConstraints": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "FIXED",
"interestRateTiers": [
{
"endingBalance": 0,
"endingDay": 0,
"interestRate": 0
}
]
}
},
"type": "CURRENT_ACCOUNT"
}
]
}