Deposit Accounts

Overview

The Deposit Accounts module enables you to open, manage, and service customer deposit accounts including savings, current, and fixed deposit accounts.

Deposit Account States

Deposit accounts progress through various states during their lifecycle. Understanding these states is essential for proper account management.

Account Lifecycle Diagram

Account State Reference Table

Value	State	Description	Typical Next States
0	ALL	Special filter value representing all states	(Used in queries only)
1	Partial_Application	Account application is incomplete and being drafted	Pending_Approval, Withdrawn
2	Pending_Approval	Account is complete and awaiting approval	Approved, Rejected
3	Approved	Account has been approved but not yet opened	Active, Withdrawn
4	Rejected	Account application was rejected	(Final state)
5	Active	Account is open and fully operational	In_Arears, Dormant, Locked, Closed, Matured
6	In_Arears	Account has overdraft or negative balance requiring attention	Active, Closed
7	Closed	Account has been closed	(Final state)
8	Closed_Written_Off	Account closed with outstanding balance written off	(Final state)
9	Dormant	Account inactive due to no transactions for extended period	Active, Locked, Closed
10	Locked	Account temporarily locked (fraud, investigation, customer request)	Active, Closed
11	Matured	Fixed deposit has reached maturity date	Closed
12	Withdrawn	Account application was withdrawn before opening	(Final state)

Account Sub-State Reference Table

Sub-states provide additional detail about the account's specific condition within the main state.

Value	Sub-State	Description	Used With States
-1	All	Special filter value for all substates	(Used in queries only)
0	DEFAULT	No special condition - standard state	Any state
1	CLOSE_REJECTED	Closure request was rejected, account remains open	Active
2	CLOSE_WITHDRAWN	Account closed by customer withdrawal	Closed
8	APPROVED	Account has completed approval process	Approved
9	CLOSE_MATURED	Fixed deposit closed at scheduled maturity	Closed, Matured
90	CLOSE_MATURED_PREMATURE	Fixed deposit closed before maturity (early withdrawal penalty may apply)	Closed
10	CLOSE_DORMANT	Account closed due to prolonged dormancy	Closed
12	CLOSE_WRITTEN_OFF	Account closed with balance written off as uncollectable	Closed_Written_Off
13	LOCK	Account is in locked status	Locked

State Lifecycle Flow

┌─────────────────────┐
│ Partial_Application │ ◄── Initial State (Draft)
└──────────┬──────────┘
           │
           ▼
   ┌───────────────────┐
   │ Pending_Approval  │ ◄── Submitted for Review
   └────┬──────────────┘
        │
        ├─────► Rejected (Final)
        ├─────► Withdrawn (Final)
        │
        ▼
   ┌──────────┐
   │ Approved │ ◄── Ready to Open
   └────┬─────┘
        │
        ▼
   ┌────────┐
   │ Active │ ◄── Account Opened, Transactions Allowed
   └─┬──────┘
     │
     ├─────► Dormant ──────► Active (Reactivation)
     │           └──────────► Closed
     │
     ├─────► Locked ────────► Active (Unlock)
     │           └──────────► Closed
     │
     ├─────► In_Arears ─────► Active (Balance Restored)
     │           └──────────► Closed / Closed_Written_Off
     │
     ├─────► Matured ────────► Closed (For Fixed Deposits)
     │
     └─────► Closed (Final)

State Business Rules

Partial_Application (1)

Editable: Yes - full editing allowed
Transactions: None allowed
Actions Available: Edit, Submit for Approval, Withdraw
Sub-States: DEFAULT
User Access: Account Officers, Branch Staff

Pending_Approval (2)

Editable: Limited - requires special permission
Transactions: None allowed
Actions Available: Approve, Reject, Return to Draft
Sub-States: DEFAULT
User Access: Approvers, Managers, Senior Staff

Approved (3)

Editable: No
Transactions: Opening deposit only
Actions Available: Open Account, Undo Approval, Withdraw
Sub-States: APPROVED
User Access: Account Opening Officers, Branch Managers

Active (5)

Editable: Limited (contact info, metadata only)
Transactions: All transaction types allowed
Actions Available: Deposits, Withdrawals, Transfers, Fee Collection, Interest Posting
Sub-States: DEFAULT, CLOSE_REJECTED
User Access: Tellers, Account Officers, Customers (self-service channels)

Dormant (9)

Editable: No
Transactions: Reactivation deposit only
Actions Available: Reactivate, Close Account
Sub-States: DEFAULT, CLOSE_DORMANT
User Access: Managers, Account Reactivation Team
Note: Typically occurs after 6-12 months of inactivity

Locked (10)

Editable: No
Transactions: None allowed
Actions Available: Unlock (with authorization), Close Account
Sub-States: LOCK
User Access: Fraud Team, Senior Management
Reasons: Fraud investigation, legal hold, customer request, KYC issues

In_Arears (6)

Editable: No
Transactions: Deposits only (to restore positive balance)
Actions Available: Accept Deposits, Apply Charges, Close/Write-off
Sub-States: DEFAULT
User Access: Collections, Account Officers
Note: Applies to overdraft facilities or accounts with negative balance

Matured (11)

Editable: No
Transactions: Withdrawal/closure only
Actions Available: Close Account, Renew Fixed Deposit
Sub-States: CLOSE_MATURED, CLOSE_MATURED_PREMATURE
User Access: Account Officers, Tellers
Note: Applies to fixed/term deposits only

Closed States (7, 8, 12)

Editable: No
Transactions: None (read-only)
Actions Available: View History, Generate Statements
Sub-States: CLOSE_WITHDRAWN, CLOSE_WRITTEN_OFF, CLOSE_DORMANT, CLOSE_MATURED
User Access: All staff (read-only)

Transaction Hold States

Transaction holds are used to manage pending transactions, fraud prevention, and settlement processes.

Transaction Hold State Reference Table

Value	State	Description	Typical Next States
1	PENDING	Transaction awaiting processing or clearance	SETTLED, REVERSED, EXPIRED, CANCELLED
2	REVERSED	Transaction has been reversed after processing	(Final state)
3	SETTLED	Transaction completed and funds settled	(Final state)
4	EXPIRED	Transaction hold expired without completion	(Final state)
5	CANCELLED	Transaction cancelled before processing	(Final state)
6	HOLD	Transaction manually placed on hold by operations	SETTLED, CANCELLED, REVERSED
7	SUSPEND	Transaction suspended by system (e.g., fraud detection)	HOLD, CANCELLED, SETTLED

Hold State Business Rules

PENDING (1)

Description: Transaction initiated but awaiting clearance
Duration: Typically 24-72 hours depending on transaction type
Examples: Cheque deposits, card authorizations, inter-bank transfers
Actions: Monitor, expedite clearance

HOLD (6)

Description: Manually placed on hold by authorized staff
Duration: Until investigation completes
Examples: Suspected fraud, large transactions requiring approval
Actions: Release hold, cancel transaction, request additional documentation

SUSPEND (7)

Description: System-generated suspension
Duration: Until manual review completed
Examples: AML flags, velocity checks, pattern recognition alerts
Actions: Review, clear, or escalate to compliance

SETTLED (3)

Description: Transaction successfully completed
Duration: Permanent
Reversible: Only through separate reversal transaction
Impact: Funds available, balance updated

API Integration

Filtering Accounts by State and Sub-State

GET /api/deposits?state=5&subState=0
# Returns all Active accounts with DEFAULT substate

GET /api/deposits?state=9
# Returns all Dormant accounts

GET /api/deposits?state=7
# Returns all Closed accounts (regardless of substate)

Response Format

{
  "id": 67890,
  "accountNumber": "SA-2024-00456",
  "depositAccountState": 5,
  "depositAccountStateDescription": "Active",
  "depositAccountSubState": 0,
  "depositAccountSubStateDescription": "-",
  "availableBalance": 150000.00,
  "accountBalance": 150000.00,
  "daysInactive": 0
}

Transaction Hold Query

GET /api/deposit-transactions?holdState=1
# Returns all PENDING transactions

GET /api/deposit-transactions?holdState=6
# Returns all transactions on HOLD

Key Features

Opening Accounts - Create accounts for savings, current, and fixed deposits
Account Products - Multiple account types with different interest rates and features
Interest Management - Automated interest calculation and posting
Account Status Management - Activate, freeze, lock, or close accounts
Dormancy Management - Automatic dormancy detection and reactivation workflows
Transaction Controls - Hold, suspend, and reverse transactions as needed
Overdraft Management - Monitor and manage accounts in arears
Account Reports - Comprehensive analytics and reporting
Fixed Deposit Management - Maturity tracking and renewal processing

Enumerations Reference - Complete enum reference including all deposit account states
Deposit Transactions - Processing deposits and withdrawals
Clients - Customer management
Process Engine - Workflow automation for account processing

Overview​

Deposit Account States​

Account Lifecycle Diagram​

Account State Reference Table​

Account Sub-State Reference Table​

State Lifecycle Flow​

State Business Rules​

Partial_Application (1)​

Pending_Approval (2)​

Approved (3)​

Active (5)​

Dormant (9)​

Locked (10)​

In_Arears (6)​

Matured (11)​

Closed States (7, 8, 12)​

Transaction Hold States​

Transaction Hold State Reference Table​

Hold State Business Rules​

PENDING (1)​

HOLD (6)​

SUSPEND (7)​

SETTLED (3)​

API Integration​

Filtering Accounts by State and Sub-State​

Response Format​

Transaction Hold Query​

Key Features​

Related Documentation​