Get Pool Balance
Pool
Get Pool Balance
Returns the current USDC balance breakdown and low-balance alert status for your company, including central pool balance and collated merchant wallet balances.
GET
Get Pool Balance
Headers
string
required
Your test or live SDK API key (
pk_test_... or pk_live_...).Response Fields
string
Total aggregated balance across the central treasury pool and all merchant Privy wallets under the company (in USDC).
string
Current balance in the company’s central deposit/treasury pool (in USDC).
string
Aggregate balance held across all merchant wallets owned by the company (in USDC).
string
Deprecated alias for
pool_balance maintained for backwards compatibility.string
Settlement currency code (
USDC).string
Minimum pool balance threshold before low-balance alerts trigger.
boolean
true if pool_balance is lower than low_threshold.string
Difference between
pool_balance and low_threshold.boolean
Indicates whether auto-top-up is enabled for the company pool.

