Toshl Developer

Create a new connection

Create a new bank connection. If user does not have pro account with bank connections enabled, 403 Forbidden is returned.

POST /bank/connections

Required scope:

Parameters

institution *
required
string

Institution id.
token
optional
string

Token used to login user.
ext_id
optional
string

External id of the login (saltedge).
secret
optional
string

Secret tied to a specific login (saltedge).
reminder
optional
boolean

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

true if this connections categorisation is enabled.
repeats
optional
boolean

true if this connections repeat detection is enabled.
transfers
optional
boolean

true if this connections transfer detection is enabled.
from
optional
string

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

Format: date
form
optional
array

Login form fields.
name
optional
string

Field name
label
optional
string

Field label
type
optional
string

Field type

Possible values: text, password, option
value
optional
string

Field value
options
optional
array

Field options

* denotes required field/parameter.

Request

$ curl https://api.toshl.com/bank/connections \
  -H "Authorization: Bearer T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{json}'

Response

HTTP/1.1 201 Created
Location: https://api.toshl.com/bank/connections/42