Skip to main content
POST
/
v2
/
banking
/
connect
Create Connection
curl --request POST \
  --url https://api.business-os.de/v2/banking/connect \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "info@mustermann.de",
  "return_to": "https://app.business-os.de/close",
  "scopes": [
    "account_details",
    "transactions_details"
  ],
  "custom_fields": {}
}
'
{
  "connect_url": "https://www.saltedge.com/connect?token=xxx",
  "expires_at": "2026-03-24T12:44:03Z"
}

Authorizations

​
x-api-key
string
header
required

Dein Business OS API Key. Erstelle einen unter app.business-os.de → API Keys.

Query Parameters

​
api
enum<string>
default:partner

Salt Edge API: partner (regulierte Banken) oder openbanking (unregulierte wie AMEX, Revolut)

Available options:
partner,
openbanking

Body

application/json
​
email
string<email>

E-Mail-Adresse des Kunden (für Salt Edge Customer)

Example:

"info@mustermann.de"

​
return_to
string<uri>

Redirect-URL nach erfolgreicher Verbindung

Example:

"https://app.business-os.de/close"

​
scopes
string[]

Zugriffsrechte

Example:
["account_details", "transactions_details"]
​
custom_fields
object

Benutzerdefinierte Felder (werden im Callback zurückgegeben)

Example:
{}

Response

Connect Session erstellt

Antwort beim Erstellen einer Connect-Session

​
connect_url
string<uri>

URL zum Salt Edge Connect Widget

Example:

"https://www.saltedge.com/connect?token=xxx"

​
expires_at
string<date-time>

Ablaufzeitpunkt der Session

Example:

"2026-03-24T12:44:03Z"