Skip to main content
Your business has one balance for each currency. Use balances to check your funds before creating a conversion or payment.

Read your balances

Call GET /v1/balances to list your balances. This example uses fictional amounts:
To read one currency, include its code in the path:
A currency you have not held before returns a zero balance. You can safely repeat these requests.

Understand the amounts

In the example above, you have 250 USDT available and 25 USDT held. The held amount cannot be spent on another payment. Amounts are returned as decimal strings. Use a decimal library for calculations so you do not lose precision. Read each currency’s decimal precision from GET /v1/currencies.

Read a USD estimate and payout allowance

Call GET /v1/balances/summary with balances:read to see estimated USD values and payoutAllowance. This response must not be cached. The exact balances remain decimal strings in their original currencies. USD values are indicative estimates, not a quote or a promise that a payment will be accepted. Profiles belonging to the same business share its payout allowance. A null limit means unlimited; zero prevents new positive payouts when enforcementEnabled is true. Check enforcementEnabled before presenting those limits as active. See Limits for payment checks and errors.

Follow balance changes

Use Transactions to see deposits, conversions and payments. A deposit may need processing before it becomes available. A failed payment may also need time for held funds to be released or deducted funds to be returned. Read your balance again to confirm the amount available. For a payment’s funds status, see Transfers. Crypto deposit addresses receive funds into your business’s currency balance; each address does not have a separate spendable balance.