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.

url
readonly
string

Institution url.

provider
readonly
string

Institution provider

Possible values: plaid, toshl, saltedge
logo
readonly
string

Institution logo url if institution has a logo.

name
readonly
string

Connected institution name.

from
read, write
string

Custom start date of bank sync in YYYY-MM-DD format, or null for all available.

Format: date
accounts
read, write
array

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

refreshed
readonly
string

Date bank connection was last refreshed.

Format: date-time
auto_refresh
readonly
boolean

Auto refresh is set to true if connection can be automatically refreshed without users interaction.

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.

ext_id
read, write
string

External id of the login (saltedge).

secret
read, write
string

Secret tied to a specific login (saltedge).

instructions
readonly
string

Additional instructions for institution (if available).

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

connect_url
readonly
string

URL where user must be redirected to start the connecting process. The client must append next query parameter to the URL. When user successfully finishes the authentication process token will be appended to the next URL. This is the token that must be used to create a connection.

reminder
read, write
boolean

If set to true a reminder will be sent to the user if a manual sync connection is not refreshed for a while.

* denotes required field/parameter.