Depositaccount
Represents information about a deposit account.
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.
{
"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"
}