Skip to main content
GET
Get a bank account balance

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Path Parameters

bankAccountID
string
required

Response

Live balance at the bank. The recommended way to read the amount is the neutral top-level summary (available, held, currency — flat decimal strings, present when the rail supports the summary); the balance object keeps the full rail-native account detail (display name, requisites to receive money).

The response is of type object.

Last modified on August 29, 2026