Skip to main content
GET
Retrieve Bank Account Connection

Authorizations

Authorization
string
header
required

Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>

Use this for: Business-specific operations where the business context is embedded in the token.

Path Parameters

bank_account_id
string<uuid>
required
business_id
string<uuid>
required

Response

Comprehensive serializer for bank account connections.

Provides detailed information about connected bank accounts including status, balance, sync information, and related business context.

id
string<uuid>
required
read-only

Unique bank account connection identifier

account_key
string
required

Provider-specific account key for identifying this account in their system

Maximum string length: 255
balance
number<double> | null
required
read-only

Current account balance in decimal format (e.g., 12500.50 for £12,500.50) - for backward compatibility

balance_cents
integer
required
read-only

Current account balance in cents (e.g., 1250050 for £12,500.50)

Bank link connection status (active, revoked, error)

Bank link UUID that this account belongs to

business_id
string<uuid>
required
read-only

Business UUID that owns this bank account

business_name
string
required
read-only

Business name for display purposes

provider
string
required
read-only

Banking data provider (e.g., plaid, open_banking)

created_at
string<date-time>
required
read-only

Timestamp when bank account was first connected

updated_at
string<date-time>
required
read-only

Timestamp of last update to account information

display_name
string

User-friendly account name (e.g., 'Business Current Account')

Maximum string length: 255
official_name
string

Official bank account name from the financial institution

Maximum string length: 255
mask
string

Last 4 digits of account number for identification (e.g., '1234')

Maximum string length: 10
currency
string

Account currency code (GBP, EUR, USD)

Maximum string length: 3
is_active
boolean

Whether this account connection is active and syncing transactions (false if disconnected)

mapped_account
string<uuid> | null

Chart of accounts ID this bank account is mapped to (null if not mapped)