Skip to content
Developers

API reference / Accounts

GET/v1/accounts/{id}/balances

Read balances

Requires balances:read. Resource restrictions also apply. Read balances.

Reads use stored data and do not refresh the bank.

Request examples

These examples use HTTP directly. Keep API keys on your server.

Shell
curl 'https://api.bankmcp.app/v1/accounts/RESOURCE_ID/balances' \
  -H "Authorization: Bearer $BANKING_API_KEY"
TypeScript
const response = await fetch('https://api.bankmcp.app/v1/accounts/RESOURCE_ID/balances', {
  headers: {
    Authorization: `Bearer ${process.env.BANKING_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`Banking returned ${response.status}`);
const data = await response.json();

Parameters

idpathrequired

string

Response

200 · application/json

environment"sandbox" | "production"required
account_idstringrequired
retrieved_atstring | nullrequired
Show retrieved_at schema
Option 1: string

string

Option 2: null

null

source"stored" | "live"required
warningstring
balancesarray<object>required
Show balances schema
balance_typestring | null
Show balance_type schema
Option 1: string

string

Option 2: null

null

namestring | null
Show name schema
Option 1: string

string

Option 2: null

null

balance_amountobjectrequired
Show balance_amount schema
amountstringrequired

Exact decimal amount as a string

currencystringrequired

ISO 4217 currency code

reference_datestring | null
Show reference_date schema
Option 1: string

string — Calendar date (YYYY-MM-DD)

Option 2: null

null

Errors

Errors contain error, code and an optional action. Read the error and retry guide.

StatusCode
400INVALID_INPUT
401INVALID_API_KEY
403INSUFFICIENT_PERMISSION
404NOT_FOUND
409CONFLICT
413REQUEST_TOO_LARGE
429rate_limit.feature
500REQUEST_FAILED
502INVALID_RESPONSE
503UNAVAILABLE

Try this request

Sent directly to https://api.bankmcp.app. Your key stays in this page’s memory and is never saved.

Resource identifier