Skip to main content

​
What Is Supported

This section currently supports:
  • Organization-scoped balances per currency bucket
  • available_balance, locked_balance, and pending_balance amounts
  • A consolidated total_balance_usd value for quick portfolio-level monitoring

​
Prerequisites

Before using Accounts endpoints:
  • Authenticate with an API key. See Authentication Overview.
  • Use the same environment you are operating in (sk_sandbox_... for test, sk_live_... for live).
  • Ensure your integration handles decimal amounts as strings to preserve precision.

​
How It Works

1

Retrieve balances

Use Get Balances.
2

Validate available balance

Confirm available_balance is sufficient for the operation.
3

Run downstream flows

Initiate actions like Create Payout or Execute Conversion.
4

Re-check after state changes

Fetch balances again when your workflow needs fresh availability.

​
In This Section