The flow covers Account Balance Queries, Transaction Posting, and Ledger History Retrieval.
Phase 1: Account Balance Query
1.1 Get Account Balance
Customers can query their account balance to get real-time balance information.Account Balance
Get account balance and details
Balance Query Steps
1
Request Balance
Customer requests balance for a specific account using the account ID.
2
Retrieve Account
System retrieves account details including:
- Available Balance: Funds available for transactions
- Account Balance: Total account balance
- Account Status: Current account status
- Currency: Account currency
- Account Information: Account number, name, and owner details
3
Return Balance
System returns comprehensive balance information including overdraft limits and lien amounts if applicable.
Phase 2: Transaction Posting
2.1 Post to Account
Customers can execute double-entry transactions by posting debits and credits to accounts.Post to Account
Execute double-entry transaction
Posting Steps
1
Prepare Transaction
Customer prepares transaction details:
- Primary Account: Source or destination account
- Counterparty Accounts: Accounts to credit or debit
- Amount: Transaction amount
- Direction: Debit or credit direction
- Narration: Transaction description
2
Validate Accounts
System validates:
- Account existence
- Account status (must be ACTIVATED)
- Account permissions
- Currency matching
3
Check Balance
For debit transactions, system checks:
- Available balance is sufficient
- Account is not on lien (if applicable)
- Overdraft limits (if applicable)
4
Execute Transaction
System executes double-entry posting:
- Creates debit entry in primary account
- Creates credit entry in counterparty account(s)
- Updates account balances
- Records transaction in ledger
5
Confirmation
Customer receives confirmation with transaction details and updated balances.
Phase 3: Transaction History
3.1 Retrieve Ledger History
Customers can retrieve complete transaction history for their accounts.Ledger History
View account transaction history
History by Interaction ID
View transactions by interaction ID
History by Idempotency Key
View transactions by idempotency key
History Retrieval Steps
1
Request History
Customer requests transaction history for an account with pagination parameters.
2
Retrieve Transactions
System retrieves ledger entries including:
- Transaction amount and type
- Previous and new balances
- Execution date
- Payment reference
- Correlation IDs
3
Apply Pagination
System applies pagination and returns the requested page of transactions.
4
Display History
Customer views complete transaction history with all details.
Complete Ledger Flow
Key Concepts
Double-Entry Posting
Every transaction creates two entries:- Debit Entry: Money leaving an account
- Credit Entry: Money entering an account
- Both entries must balance (total debits = total credits)
Account Balances
- Account Balance: Total balance including all transactions
- Available Balance: Balance available for new transactions (excludes liens and holds)
- Overdraft Balance: Amount of overdraft currently used (if applicable)
- Lien Amount: Amount placed on lien (frozen/unavailable)
Transaction Types
- DEBIT: Money leaving the account
- CREDIT: Money entering the account
- TRANSFER: Money moving between accounts (debit one, credit another)
Idempotency
- Every transaction requires an idempotency key
- Duplicate requests with the same idempotency key return the original transaction
- Prevents accidental duplicate processing
Learn More
See all available ledger API endpoints.