Get your balance
GET/v1/balancebalance:read
Returns your current balance. Orders are paid from this balance, so a failed order is often a balance question first.
curl https://partner-api.esimfo.com/v1/balance \ -H 'Authorization: Bearer esf_live_at_...'Response 200
Section titled “Response 200”| Field | Type | Notes |
|---|---|---|
balance |
string | Total balance on the account |
available_balance |
string | Spendable now — total minus amounts reserved by in-flight orders |
currency |
string | ISO 4217 |
{ "balance": "1250.00", "available_balance": "1187.60", "currency": "EUR"}Which figure to use
Section titled “Which figure to use”Check available_balance before ordering. The difference between the two
is money already committed to orders that are still provisioning. Deciding
against balance will occasionally approve an order that then fails with
insufficient_balance.
Use balance for reporting, available_balance for decisions.
Errors
Section titled “Errors”| Status | Code | Cause |
|---|---|---|
| 403 | insufficient_scope |
Key lacks balance:read |
| 429 | rate_limited |
Over the per-minute allowance |
