Field Descriptions |
| deposit : |
| The amount to be deposit in the fixeddeposit. |
| The amount to be deposited in the deposit account. |
| externalId : |
| A place to put an external reference for this fixeddeposit. e.g. The ID another system uses. + |
| A place to put an external reference for this deposit account. e.g. The ID another system uses. If provided, it must be unique. |
| tenureInMonths : |
| denotes the tenure period of depsoit account. |
| tenureInMonths: |
| denotes the tenure period of deposit account. |
| renewalAllowed : |
| renewalAllowed: |
| Whether the deposit account is eligible for renew after maturity. If 'true' : renewalAllowed otherwise renewal not allowed. |
| isInterestWithdrawable : |
| denotes whether for this deposit account interest is withdrawable or not - If true interest is withdrawable and 'interestCompoundingAllowed' is must be false. |
| isInterestWithdrawable: |
| denotes whether for this deposit account, interest is withdrawable or not + If true interest is withdrawable and 'interestCompoundingAllowed' must be false. |
| interestCompoundingAllowed : |
| interestCompoundingAllowed: |
| denotes interestCompounding is allowed or not for a deposit account If 'false' on simple interest basis the interest is calculated |
| maturityInterestRate : |
| maturityInterestRate: |
| Interest rate applicable on deposit amount upto maturity date, after maturrity if the account is not closed 'preClosureInterestRate' is applicable on deposit amount |
| preClosureInterestRate : |
| preClosureInterestRate: |
| Interest rate applicable on deposit amount if the account is closed before maturity date, and after maturity of account if it is not closed or renewed this interest rate is applicable. |
| interestCompoundedEvery : |
| interestCompoundedEvery: |
| Interest is calculated on deposit account for every interestCompoundedEvery period |
| lockinPeriod : |
| With in a lockinperiod, the deposit account cannot be preclosed |
| lockinPeriod: |
| Within a lockinperiod, the deposit account cannot be preclosed |
This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
GET https://Domain Name/api/v1/depositaccounts/template
+ GET https://Domain Name/api/v1/depositaccounts/template?clientId={clientId}&productId={productId}
+
+{
+ "clientId": 1,
+ "clientName": "First Client",
+ "productId": 1,
+ "productName": "MyFirstDepositProduct",
+ "currency": {
+ "code": "USD",
+ "name": "",
+ "decimalPlaces": 2,
+ "displaySymbol": "",
+ "nameCode": "",
+ "displayLabel": " [USD]"
+ },
+ "deposit": 100,
+ "maturityInterestRate": 6,
+ "tenureInMonths": 12,
+ "projectedCommencementDate": [
+ 2013,
+ 2,
+ 6
+ ],
+ "interestCompoundedEvery": 1,
+ "interestCompoundedEveryPeriodType": {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "renewalAllowed": true,
+ "preClosureAllowed": true,
+ "preClosureInterestRate": 3,
+ "isInterestWithdrawable": false,
+ "interestCompoundingAllowed": true,
+ "interestCompoundedEveryPeriodTypeOptions": [
+ {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ }
+ ],
+ "productOptions": [
+ {
+ "id": 1,
+ "name": "MyFirstDepositProduct"
+ }
+ ],
+ "availableInterestForWithdrawal": 0,
+ "availableWithdrawalAmount": 0,
+ "todaysDate": [
+ 2013,
+ 2,
+ 6
+ ],
+ "isLockinPeriodAllowed": true,
+ "lockinPeriod": 0,
+ "lockinPeriodType": {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "availableInterest": 0,
+ "interestPostedAmount": 0
+}
+
+
+ GET https://Domain Name/api/v1/depositaccounts/template?clientId={clientId}
{
- "clientId": 17,
- "clientName": "Agri",
- "productId": 1,
- "productName": "Micro Savings",
- "currency": {
- "code": "INR",
- "name": "",
- "decimalPlaces": 2,
- "displaySymbol": "",
- "nameCode": "",
- "displayLabel": " [INR]"
- },
- "deposit": 200.000000,
- "maturityInterestRate": 12.000000,
- "tenureInMonths": 0,
- "projectedCommencementDate": [2013,
- 1,
- 30],
- "interestCompoundedEvery": 6,
- "interestCompoundedEveryPeriodType": {
- "id": 2,
- "code": "deposit.interest.compounding.period.periodFrequencyType.months",
- "value": "Months"
- },
- "renewalAllowed": true,
- "preClosureAllowed": true,
- "preClosureInterestRate": 5.000000,
- "isInterestWithdrawable": false,
- "interestCompoundingAllowed": false,
- "interestCompoundedEveryPeriodTypeOptions": [{
- "id": 2,
- "code": "deposit.interest.compounding.period.periodFrequencyType.months",
- "value": "Months"
- }],
- "productOptions": [{
- "id": 5,
- "name": "fgretgr"
- },
- {
- "id": 1,
- "name": "Micro Savings"
- },
- {
- "id": 4,
- "name": "PlusOne Deposit"
- }],
- "availableInterestForWithdrawal": 0,
- "availableWithdrawalAmount": 0,
- "todaysDate": [2013,
- 1,
- 30],
- "isLockinPeriodAllowed": true,
- "lockinPeriod": 0,
- "lockinPeriodType": {
- "id": 2,
- "code": "deposit.interest.compounding.period.periodFrequencyType.months",
- "value": "Months"
- },
- "availableInterest": 0,
- "interestPostedAmount": 0
+ "clientId": 1,
+ "clientName": "First Client",
+ "renewalAllowed": false,
+ "preClosureAllowed": false,
+ "isInterestWithdrawable": false,
+ "interestCompoundingAllowed": true,
+ "interestCompoundedEveryPeriodTypeOptions": [
+ {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ }
+ ],
+ "productOptions": [
+ {
+ "id": 1,
+ "name": "MyFirstDepositProduct"
+ }
+ ],
+ "availableInterestForWithdrawal": 0,
+ "availableWithdrawalAmount": 0,
+ "todaysDate": [
+ 2013,
+ 2,
+ 6
+ ],
+ "isLockinPeriodAllowed": true,
+ "availableInterest": 0,
+ "interestPostedAmount": 0
}