Depositproduct
A deposit product defines the terms and constraints on deposit accounts
accountingSettings objectrequired
Accounting settings, defines the accounting settings for the product.
The calculation method used for accounting.
Possible values: [NONE, CASH, ACCRUAL]
accountingRules object[]
A list of accounting rules for the product.
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]
The encoded key of the account that is mapped to the financialResource
The accounting interest calculation option selected for the product.
Possible values: [NONE, AGGREGATED_AMOUNT, BREAKDOWN_PER_ACCOUNT]
The interval defined for a product when the interest accrues should be maintained.
Possible values: [NONE, DAILY, END_OF_MONTH]
availabilitySettings object
Holds information about product availability.
Possible values: [INDIVIDUALS, PURE_GROUPS]
branchSettings object
Holds information about branch availability for the product.
Holds the encoded keys of the branches this product should be available for.
Indicates if this product should be available for all branches
Indicates the category that the product belongs to
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]
The date this product was created
2016-09-06T13:37:50+03:00creditArrangementSettings object
The funding settings, holds the settings regarding the funding for the loan 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
Currency settings for the product.
currencies object[]
Currencies that can be used by accounts of this product
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 encoded key of the deposit product, auto generated, unique
feesSettings object
Defines fees settings for the product.
Only if true users will be able to apply fees, for current object, of type 'Other'; these fees can have any amount.
fees object[]
List of all fees that can be applied for accounts of this loan product.
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]
The encoded key of the account that is mapped to the financialResource
The amount of the fee
External function
The amount from which the fee is calculated using percentageAmount
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]
Shows the creation date of the fee
2016-09-06T13:37:50+03:00The 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
Shows the last modified date of the fee
2016-09-06T13:37:50+03:00The name of the fee
Indicates the state of the fee
Possible values: [ACTIVE, INACTIVE]
Shows the event that will trigger a fee
Possible values: [MANUAL, MONTHLY_FEE, ARBITRARY]
The id of the product, can be generated and customized, unique
interestSettings object
The interest settings, defines constraints regarding interest that will be used on the deposit account based on this product.
Whether locked accounts still collect Interest or not
How many days in a year should be used for interest calculations
Possible values: [ACTUAL_365_FIXED, ACTUAL_360, ACTUAL_ACTUAL_ISDA, E30_360, E30_42_365, BUS_252]
The balance which is used for the Interest calculation
Possible values: [MINIMUM, AVERAGE, END_OF_DAY, MINIMUM_TO_END_OF_DAY, FRENCH_INTEREST_ACCRUAL]
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-26If interest should be payed into the deposit account
interestPaymentSettings object
Defines the interest payment settings for the deposit product and for deposits created based on this product
interestPaymentDates 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]
interestRateSettings object
The interest settings, defines constraints regarding interest that will be used on the deposit created based on this product.
If the product supports this option, specify if the interest should be accrued after the account maturity date
Indicator whether the deposit product allows negative values for interest rate
The encoded key of the interest rate tier, auto generated, unique
Index rate source key.
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
interestRate object
Decimal constraints, like min/max/default.
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]
The option for how is the interest rate determined when being accrued for an account
Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]
interestRateTiers object[]
The list of interest rate tiers available for the current settings instance
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 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
internalControls object
Constraints and automated actions and that will be applied on the accounts.
Specifies the number of days for an account to be fully paid in order to auto close it.
Max amount per withdrawal
openingBalance object
Decimal constraints, like min/max/default.
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
The last date the product was updated
2016-09-06T13:37:50+03:00maturitySettings object
The maturity settings for the product.
maturityPeriod object
Decimal integer, like min/max/default.
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]
The name of the product
newAccountSettings objectrequired
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).
Some notes/a description about the product
offsetSettings object
The offset settings, holds information about offset.
Specify if the product allow to create accounts which can be used as offset for loans
overdraftInterestSettings object
Overdraft settings for the product
How many days in a year should be used for interest calculations
Possible values: [ACTUAL_365_FIXED, ACTUAL_360, ACTUAL_ACTUAL_ISDA, E30_360, E30_42_365, BUS_252]
The balance which is used for the overdraft interest calculation. Default value is MINIMUM. If set to null on a PUT call and the product allows overdrafts, the null value is ignored and not changed.
Possible values: [MINIMUM, AVERAGE, END_OF_DAY, MINIMUM_TO_END_OF_DAY, FRENCH_INTEREST_ACCRUAL]
interestRateSettings object
The overdraft interest settings, defines constraints regarding interest that will be used on the account created based on this product.
Index rate source key.
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
interestRate object
Decimal constraints, like min/max/default.
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]
The option for how is the interest rate determined when being accrued for an account
Possible values: [FIXED, TIERED, TIERED_PERIOD, TIERED_BAND]
interestRateTiers object[]
The list of interest rate tiers available for the current settings instance
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
overdraftSettings object
The overdraft settings of the deposit product
Whether the accounts for this product may have overdraft
Whether the accounts for this product may have technical overdraft
How much money may be taken out for the account to go negative
Indicates the current state of the product
Possible values: [ACTIVE, INACTIVE]
taxSettings object
Tax settings, defines some settings for taxes on the loan product
Whether withholding taxes are enabled for this product or not
templates object[]
Template documents of the product.
The creation date of the document
2016-09-06T13:37:50+03:00The document encodedKey
The last modified date of the document
2016-09-06T13:37:50+03:00The name the document
The type of the template
Possible values: [ACCOUNT, TRANSACTION, ACCOUNT_WITH_TRANSACTIONS]
Indicates the type of product.
Possible values: [CURRENT_ACCOUNT, REGULAR_SAVINGS, FIXED_DEPOSIT, SAVINGS_PLAN, INVESTOR_ACCOUNT]
{
"accountingSettings": {
"accountingMethod": "NONE",
"accountingRules": [
{
"encodedKey": "string",
"financialResource": "PORTFOLIO_CONTROL",
"glAccountKey": "string"
}
],
"interestAccrualCalculation": "NONE",
"interestAccruedAccountingMethod": "NONE"
},
"availabilitySettings": {
"availableFor": [
"INDIVIDUALS"
],
"branchSettings": {
"availableProductBranches": [
"string"
],
"forAllBranches": true
}
},
"category": "PERSONAL_DEPOSIT",
"creationDate": "2016-09-06T13:37:50+03:00",
"creditArrangementSettings": {
"creditArrangementRequirement": "OPTIONAL"
},
"currencySettings": {
"currencies": [
{
"code": "AED",
"currencyCode": "string"
}
]
},
"encodedKey": "string",
"feesSettings": {
"allowArbitraryFees": true,
"fees": [
{
"accountingRules": [
{
"encodedKey": "string",
"financialResource": "PORTFOLIO_CONTROL",
"glAccountKey": "string"
}
],
"amount": 0,
"amountCalculationFunctionName": "string",
"amountCalculationMethod": "FLAT",
"applyDateMethod": "MONTHLY_FROM_ACTIVATION",
"creationDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"feeApplication": "REQUIRED",
"id": "string",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"name": "string",
"state": "ACTIVE",
"trigger": "MANUAL"
}
]
},
"id": "string",
"interestSettings": {
"collectInterestWhenLocked": true,
"daysInYear": "ACTUAL_365_FIXED",
"interestCalculationBalance": "MINIMUM",
"interestGainsProvidedEndDate": "1987-04-26",
"interestGainsProvidedStartDate": "1987-04-26",
"interestPaidIntoAccount": true,
"interestPaymentSettings": {
"interestPaymentDates": [
{
"day": 0,
"month": 0
}
],
"interestPaymentPoint": "FIRST_DAY_OF_MONTH"
},
"interestRateSettings": {
"accrueInterestAfterMaturity": true,
"allowNegativeInterestRate": true,
"encodedKey": "string",
"indexSourceKey": "string",
"interestChargeFrequency": "ANNUALIZED",
"interestChargeFrequencyCount": 0,
"interestRate": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "FIXED",
"interestRateTiers": [
{
"encodedKey": "string",
"endingBalance": 0,
"endingDay": 0,
"interestRate": 0
}
]
},
"maximumBalance": 0
},
"internalControls": {
"dormancyPeriodDays": 0,
"maxWithdrawalAmount": 0,
"openingBalance": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"recommendedDepositAmount": 0
},
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"maturitySettings": {
"maturityPeriod": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"maturityPeriodUnit": "DAYS"
},
"name": "string",
"newAccountSettings": {
"idGeneratorType": "INCREMENTAL_NUMBER",
"idPattern": "string"
},
"notes": "string",
"offsetSettings": {
"allowOffset": true
},
"overdraftInterestSettings": {
"daysInYear": "ACTUAL_365_FIXED",
"interestCalculationBalance": "MINIMUM",
"interestRateSettings": {
"indexSourceKey": "string",
"interestChargeFrequency": "ANNUALIZED",
"interestChargeFrequencyCount": 0,
"interestRate": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestRateTerms": "FIXED",
"interestRateTiers": [
{
"encodedKey": "string",
"endingBalance": 0,
"interestRate": 0
}
]
}
},
"overdraftSettings": {
"allowOverdraft": true,
"allowTechnicalOverdraft": true,
"maxOverdraftLimit": 0
},
"state": "ACTIVE",
"taxSettings": {
"withholdingTaxEnabled": true
},
"templates": [
{
"creationDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"name": "string",
"type": "ACCOUNT"
}
],
"type": "CURRENT_ACCOUNT"
}