Skip to main content
GET
Get a bank connection

Authorizations

Authorization
string
header
required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Path Parameters

id
string<uuid>
required

Response

The bank connection.

One authorisation with one bank. Several accounts can share a connection, and a workspace can hold several connections to the same bank.

object
string
required
Allowed value: "bank"
id
string<uuid>
required
name
string
required

The bank's name as the provider reports it.

Example:

"ING Bank"

country_code
string | null
required

ISO 3166-1 alpha-2 country of the bank.

Pattern: ^[A-Z]{2}$
Example:

"RO"

status
enum<string>
required

The state of the connection as of ThinkOut's last exchange with the provider.

connected is working. loading is a sync in progress. requires_action needs a person to sign in or re-approve the connection in ThinkOut, and no new transactions arrive until they do. error is a failure ThinkOut could not resolve on its own, and covers any provider state ThinkOut cannot place.

Only connected means the data behind it is current.

Available options:
connected,
loading,
requires_action,
error
last_sync_at
string<date-time> | null
required

When the provider last returned data successfully. null when it never has.

This is the age of the data, not the age of the connection. A connection can sit at connected with a last_sync_at days old, which is the case worth alerting on.

When the bank consent needs renewal, if the provider reports it. Once it passes, the connection stops returning new transactions until someone re-approves it.

created_at
string<date-time>
required

When the connection was first authorised.

updated_at
string<date-time>
required