Skip to main content

Balance Management API

The Balance Management API provides endpoints for tenant administrators to view and manage balances within their tenant. These endpoints provide a comprehensive view of all available funds across different blockchain networks.

Endpoints Overview​

EndpointMethodDescription
/manage/users/balancesGETGet summary of all balances for the tenant
/manage/users/balances/{blockchain}GETGet balances for a specific blockchain
/manage/users/balances/syncPOSTSynchronize all balances in the tenant

Authentication​

All balance endpoints require OAuth 2.0 token authentication with tenant administrator or global administrator role. API key authentication is not supported for these endpoints.

Response Structure​

The balance endpoints return detailed information about available funds across different types of wallets and blockchains:

  • Hot Wallet Balances: Funds stored in online wallets for day-to-day operations
  • Cold Wallet Balances: Funds stored in offline wallets for enhanced security
  • Custody Balances: Funds managed by external custody providers

Common Use Cases​

  • Monitoring Available Funds: Get a comprehensive view of all available funds across different blockchains and wallet types
  • Preparing for Withdrawals: Check available balance on a specific blockchain before processing withdrawals
  • Reconciliation: Ensure system balances match actual blockchain and custody provider balances

Best Practices​

  1. Regular Synchronization: Schedule regular balance synchronizations to ensure your records accurately reflect the current state of funds.

  2. Pre-Withdrawal Checks: Before processing large withdrawals, check the available balance on the specific blockchain to ensure sufficient funds are available.

  3. Balance Reconciliation: Periodically reconcile your recorded balances with actual blockchain balances to identify any discrepancies.

  4. Monitor Cold Wallet Balances: Ensure sufficient funds are kept in cold wallets for security, while maintaining adequate hot wallet balances for day-to-day operations.