Toshl Developer

Bank connection

List of users bank (and other institution) connections.

Resource representation

{
  "id": "42",
  "institution": "42",
  "accounts": ["42"],
  "name": "American Express",
  "unsorted": 0,
  "status": "connected"
}

Properties

id
readonly
string

Connection id.

institution
readonly
string

Institution id.

provider
readonly
string

Institution provider

Possible values: plaid, toshl
logo
readonly
string

Institution logo url if institution has a logo.

name
readonly
string

Connected institution name.

accounts
read, write
array

An array of account ids that are refreshed as part of the bank connection.

refreshed
readonly
string

Date bank conneciton was last refreshed.

Format: date-time
review
readonly
integer

Number of entries to review.

status
readonly
string

Bank connection status.

Possible values: connected, inactive, error
deleted
readonly
boolean

Is object deleted.

token
read, write
string

Token used to login user.

form
read, write
array

Login form fields.

name
readonly
string

Field name

label
readonly
string

Field label

type
readonly
string

Field type

Possible values: text, password, option
value
readonly
string

Field value

options
readonly
array

Field options

* denotes required field/parameter.