Deposit Accounts API
Overview
The Deposit Accounts API provides comprehensive endpoints for managing customer deposit accounts, including savings, current, and fixed deposit accounts.
Deposit Account Lifecycle & State Transitions
The deposit account lifecycle tracks accounts from creation through various operational states to closure. Understanding these states is essential for proper account management and transaction processing.
State Descriptions
| State | Description | Transactions Allowed |
|---|---|---|
| Partial Application | Account being created (draft) | None |
| Pending Approval | Submitted, awaiting approval | None |
| Approved | Approved but not yet activated | None |
| Rejected | Application rejected | None |
| Active | Fully operational account | All transactions |
| In Arrears | Account with overdraft/negative balance | Limited (deposits only) |
| Dormant | Inactive for extended period | Reactivation required |
| Locked | Temporarily locked | None |
| Closed | Account closed normally | None |
| Closed Written Off | Account closed with debt write-off | None |
State Change Commands
| Action | Command | From State | To State |
|---|---|---|---|
| Create Account | CreateDepositCommand | - | Partial Application |
| Request Approval | RequestDepositApprovalCommand | Partial Application | Pending Approval |
| Approve Account | ApproveDepositCommand | Pending Approval | Approved |
| Reject Account | RejectDepositCommand | Pending Approval | Rejected |
| Send Back | SetDepositBackToPartialApplicationCommand | Pending Approval | Partial Application |
| Activate Account | ApproveDepositCommand | Approved | Active |
| Lock Account | LockDepositAccountCommand | Active | Locked |
| Unlock Account | UnLockDepositAccountCommand | Locked | Active |
| Close Account | CloseDepositCommand | Active, Dormant, In Arrears | Closed |
| Reopen Account | ReopenClosedDepositCommand | Closed | Active |
| Undo Approval | UndoDepositApprovalCommand | Approved | Pending Approval |
| Mark Dormant | Automatic (system job) | Active | Dormant |
| Overdraft Detection | Automatic (on withdrawal) | Active | In Arrears |
Coming Soon
Documentation for the Deposit Accounts API is currently being developed. This module will include:
- Create Account - Open new deposit accounts
- Update Account - Modify account information
- Get Account Details - Retrieve account information
- List Accounts - Query accounts with filters
- Account Status - Activate, deactivate, close accounts
- Interest Calculation - Manage account interest
Module Status
📝 Status: Documentation in progress
🎯 Target: Q1 2026
📧 Contact: For early access or questions, contact our API team
Related Modules
- Deposit Transactions - Account transaction operations
- Clients - Customer management