Skip to main content
Balances are derived from the ledger at read time, not stored on a row. Every confirmed receipt, fee, refund, swap and payout is already reflected in what you read back. Amounts are atomic-unit strings. Convert with the asset’s own atomic_decimals:
Paths are relative to https://api.southpay.io/api/v2.

List balances

GET /balances. Scope balances:read. No parameters.

Response fields

object[]
required
One entry per asset your store holds, sorted by coin symbol.
object[]
required
Cross-chain totals for USDC and USDT. Always exactly two entries in that order, even when you hold none. A zero balance shows as total_atomic: "0" with atomic_decimals: 6.
object
required
Your stablecoin holdings converted to the store’s settlement currency.
settlement_balance counts USDC and USDT only. Non-stablecoin assets such as BTC or ETH appear in balances but contribute nothing to the fiat total.

No pagination

This endpoint returns everything in one response. There is no data wrapper, no meta, no pagination and no page parameter. Balances, payout schedules, webhook endpoints, billing products, prices and subscriptions all behave this way, while payments use meta and payouts use pagination. Do not write a shared paging helper that assumes one shape.

Asset identifiers

asset_id is the primary key for an asset across the whole API. It is not always CHAIN_COIN. Native coins use a bare symbol.
ETH_ETH and BSC_USDT do not exist. Native Ethereum is ETH, and there is no BSC deposit asset at all. BSC appears only as a payout destination network. A request naming a non-existent asset_id returns 404 Asset not found.
Test mode has exactly one usable asset, SETH on Ethereum Sepolia. The seeded USDT_SETH and USDC_SETH assets are inactive, so a test-mode store’s balances list is SETH or empty. See supported currencies and assets for the full live catalogue.

Agentic balances

Agent credentials read balances from GET /api/v2/agentic/balances instead, with scope assets:read. That response has no stablecoin_summary, but accepts an asset_id filter. See Agentic API.

Errors

Last modified on August 21, 2026