Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
bank-accounts
/
{bank_account_id}
Retrieve Bank Account Connection
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-accounts/{bank_account_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "9f90c3cc-6i00-0h16-eeee-eii81402618g",
  "account_key": "plaid_acc_Barclays_Checking_1234",
  "display_name": "Barclays Business Current Account",
  "official_name": "Barclays Bank PLC - Business Account",
  "mask": "1234",
  "balance": 12500.5,
  "balance_cents": 1250050,
  "currency": "GBP",
  "is_active": true,
  "bank_link_status": "active",
  "bank_link_id": "8e80c3cc-5h99-9g05-dddd-dhh70291507f",
  "business_id": "7d70c3cc-4g88-8f04-cccc-cgg69180406e",
  "business_name": "The Red Lion Pub Ltd",
  "provider": "plaid",
  "mapped_account": "acc-1000-cash",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-03-28T14:22:00Z"
}

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

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

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

​
balance_cents
integer
required

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

​
bank_link_status
string
required

Bank link connection status (active, revoked, error)

​
bank_link_id
string<uuid>
required

Bank link UUID that this account belongs to

​
business_id
string<uuid>
required

Business UUID that owns this bank account

​
business_name
string
required

Business name for display purposes

​
provider
string
required

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

​
created_at
string<date-time>
required

Timestamp when bank account was first connected

​
updated_at
string<date-time>
required

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)