Get Balance

GET
/api/v1/prefund/balance

Get the tenant's prefund balance per asset, read from the ledger (sole source of truth).

Authorization

headerX-Api-Key<token>

API key in format: sti_env_prefix_secret

Response Body

Default Response

application/json
  1. response
balances*array<>

One entry per asset and network held; empty until the first deposit credits. amount = available + pending.

fee_network*string

Network KYC/KYB and virtual-account fees are debited from.

Value in"ethereum""polygon""solana""tron"
fee_currency*string

Currency those fees are debited in on fee_network.

Value in"usdc""usdt"
withdrawal_fee_minor*string

Flat fee in minor units deducted from every balance withdrawal at payout. "0" when no fee is configured.

transfers_enabled*boolean

Whether the tenant can fund transfers from this balance (funding_source=prefund_balance).

withdrawals_enabled*boolean

Whether the tenant can request withdrawals from this balance.

Example Request
curl -X GET 'https://api.sandbox.stables.money/api/v1/prefund/balance'
Example Response
{  "balances": [    {      "currency": "string",      "amount": "string",      "amount_minor": "string",      "available": "string",      "available_minor": "string",      "pending": "string",      "pending_minor": "string",      "network": "ethereum"    }  ],  "fee_network": "ethereum",  "fee_currency": "usdc",  "withdrawal_fee_minor": "string",  "transfers_enabled": true,  "withdrawals_enabled": true}

Returns one entry per asset and network you hold, read from the ledger. The list is empty until your first deposit credits — an asset you have never funded is absent rather than reported as zero.

Use amount_minor for arithmetic; amount is the same value in major units as a decimal string.

Response fields

FieldDescription
balancesOne entry per asset and network held, each with currency, amount, amount_minor and network.
transfers_enabledWhether you may fund transfers from this balance — see Create Transfer from Balance.

fee_network, fee_currency and withdrawal_fee_minor are also returned. They relate to features that are not currently available and can be ignored.

Balances are enabled per organisation. If this endpoint returns 404, the feature is not switched on for your account — contact your Stables representative.

Related: Balances in the Developer Platform guide covers topping up, checking your balance and reconciling activity.