Why cash pools?
When managing funds across multiple financial institutions, you often need to view and analyze balances from different accounts together. For example, you might have:- A Stripe account for card payments
- A PayPal account for alternative payments
- A bank account for direct transfers
- View aggregated balances across all accounts in real-time
- Track historical balances at specific points in time
- Simplify financial reporting with consolidated balance views
- Enable reconciliation against your internal ledger
- Monitor liquidity across multiple financial institutions
Pool structure
A cash pool contains:- ID: Unique UUID identifier
- Name: Human-readable name (must be unique)
- Created at: Timestamp when the pool was created
- Pool accounts: Array of account IDs included in the pool
Creating a cash pool
Cash pools are created via the Payments API with a name and array of account IDs:Using cash pools
Balance queries
Pool balance endpoints aggregate balances from all accounts in the pool by asset:- Fetches balances from all accounts in the pool
- Groups by asset/currency
- Sums amounts for each asset
- Returns array of aggregated balances
Reconciliation policies
Cash pool IDs are used in thepaymentsPoolID
field of reconciliation policies: