---
updatedAt: 2026-10-16T08:11:00.482Z
---

Fetch the complete documentation index at: https://docs.avvio.xyz/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# Get your balance

`GET https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/balance`

What you can currently send.

## Parameters

- `orgId` (path, required) — The opaque organization id issued to you, normally CUID-shaped (for example `cmsx…`). It is not an `org_`-prefixed alias. Pass it unchanged in every organization-scoped path.

## Example

```bash
curl -s "$AVVIO_BASE_URL/payments/organizations/$AVVIO_ORG_ID/balance" \
  -H "x-api-key: $AVVIO_API_KEY"
```

## Responses

- `200` — Everything a payout can draw on, as one number per currency: what the payment network holds for you (`provider`) plus the USD stablecoins in your own wallet (`wallet`, per chain, USDC and USDT at face value). Some routings settle from the network's balance, others price the payout and fund it from your wallet; `balances` is the sum so you never have to know which. Both sources are read live and cached for up to one minute. `ledger`, when present, is our own append-only record of the network-held balance, per currency, with what is currently reserved by holds. It is published beside the others and never summed into them; a difference between `provider` and `ledger` is what `GET /balance_transactions` exists to explain. `unavailable` names any source that could not be read this time. When it is non-empty the figures are a floor, not the balance: retry before deciding you cannot fund a payout. In sandbox the balance is one provider-held USD figure and `wallet` is always empty.
- `401` — The key was refused. Nothing ran. - `UNAUTHORIZED`: missing, invalid or revoked, or a key on a route that does not accept one. - `KEY_EXPIRED`: the key passed the expiry it was issued with. Issue a new one; an expired key cannot be rotated. - `KEY_IP_NOT_ALLOWED`: the key is pinned to source addresses and this request came from another.
- `403` — A valid key that may not make this call. Nothing ran. - `FORBIDDEN`: the key belongs to a different organization. - `ACCOUNT_BLOCKED`: API access for your organization is suspended, and every key is refused until we lift it. Contact support.
- `429` — Too many requests. The default ceiling is **100 requests per minute per API credential** on a 60-second window. High-volume payout and reconciliation routes declare a 600/minute override, and batch submission a 30/minute ceiling. A separate 2,000/minute per-source-IP abuse ceiling always applies. Obey `Retry-After`; it is in seconds and is authoritative. A 429 means the request was refused before the handler ran. Retry reads normally; retry an idempotent mutation with its same `Idempotency-Key`.

Machine contract: [partner-payouts.openapi.yaml](/partner-payouts.openapi.yaml), operation `getBalance`.