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": [
"accounts",
"holder_info",
"transactions"
],
"custom_fields": {}
}
'import requests
url = "https://api.business-os.de/v2/banking/connect"
payload = {
"email": "info@mustermann.de",
"return_to": "https://app.business-os.de/close",
"scopes": ["accounts", "holder_info", "transactions"],
"custom_fields": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'info@mustermann.de',
return_to: 'https://app.business-os.de/close',
scopes: ['accounts', 'holder_info', 'transactions'],
custom_fields: {}
})
};
fetch('https://api.business-os.de/v2/banking/connect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.business-os.de/v2/banking/connect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'info@mustermann.de',
'return_to' => 'https://app.business-os.de/close',
'scopes' => [
'accounts',
'holder_info',
'transactions'
],
'custom_fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.business-os.de/v2/banking/connect"
payload := strings.NewReader("{\n \"email\": \"info@mustermann.de\",\n \"return_to\": \"https://app.business-os.de/close\",\n \"scopes\": [\n \"accounts\",\n \"holder_info\",\n \"transactions\"\n ],\n \"custom_fields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.business-os.de/v2/banking/connect")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"info@mustermann.de\",\n \"return_to\": \"https://app.business-os.de/close\",\n \"scopes\": [\n \"accounts\",\n \"holder_info\",\n \"transactions\"\n ],\n \"custom_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.business-os.de/v2/banking/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"info@mustermann.de\",\n \"return_to\": \"https://app.business-os.de/close\",\n \"scopes\": [\n \"accounts\",\n \"holder_info\",\n \"transactions\"\n ],\n \"custom_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"connect_url": "https://psd2.business-os.de/connect?token=xxx",
"expires_at": "2026-03-24T12:44:03Z",
"owner_user_id": "d90f20ae-f6c1-46da-a080-3d4c86329bf6",
"pending_token": "8c4a8b18-9b7c-4f9d-9a3e-1a2b3c4d5e6f"
}Create Connection
Erstellt eine Bank-Connect-Session und gibt die Widget-URL zurück. Der User wird zum Widget weitergeleitet, wählt seine Bank und autorisiert den Zugriff via OAuth.
Cost: 0 Credits
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": [
"accounts",
"holder_info",
"transactions"
],
"custom_fields": {}
}
'import requests
url = "https://api.business-os.de/v2/banking/connect"
payload = {
"email": "info@mustermann.de",
"return_to": "https://app.business-os.de/close",
"scopes": ["accounts", "holder_info", "transactions"],
"custom_fields": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'info@mustermann.de',
return_to: 'https://app.business-os.de/close',
scopes: ['accounts', 'holder_info', 'transactions'],
custom_fields: {}
})
};
fetch('https://api.business-os.de/v2/banking/connect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.business-os.de/v2/banking/connect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'info@mustermann.de',
'return_to' => 'https://app.business-os.de/close',
'scopes' => [
'accounts',
'holder_info',
'transactions'
],
'custom_fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.business-os.de/v2/banking/connect"
payload := strings.NewReader("{\n \"email\": \"info@mustermann.de\",\n \"return_to\": \"https://app.business-os.de/close\",\n \"scopes\": [\n \"accounts\",\n \"holder_info\",\n \"transactions\"\n ],\n \"custom_fields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.business-os.de/v2/banking/connect")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"info@mustermann.de\",\n \"return_to\": \"https://app.business-os.de/close\",\n \"scopes\": [\n \"accounts\",\n \"holder_info\",\n \"transactions\"\n ],\n \"custom_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.business-os.de/v2/banking/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"info@mustermann.de\",\n \"return_to\": \"https://app.business-os.de/close\",\n \"scopes\": [\n \"accounts\",\n \"holder_info\",\n \"transactions\"\n ],\n \"custom_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"connect_url": "https://psd2.business-os.de/connect?token=xxx",
"expires_at": "2026-03-24T12:44:03Z",
"owner_user_id": "d90f20ae-f6c1-46da-a080-3d4c86329bf6",
"pending_token": "8c4a8b18-9b7c-4f9d-9a3e-1a2b3c4d5e6f"
}Authorizations
Dein Business OS API Key. Erstelle einen unter app.business-os.de → API Keys.
Query Parameters
Banking-API: partner (regulierte Banken) oder openbanking (unregulierte wie AMEX, Revolut)
partner, openbanking Body
E-Mail-Adresse des Kunden (für Banking-Customer)
"info@mustermann.de"
Redirect-URL nach erfolgreicher Verbindung
"https://app.business-os.de/close"
Banking-Scopes für die Verbindung. Standard deckt alle drei ab: Kontoinfos, Inhaberdaten und Transaktionen.
accounts, holder_info, transactions ["accounts", "holder_info", "transactions"]
Benutzerdefinierte Felder (werden im Callback zurückgegeben)
{}
Response
Connect Session erstellt
Antwort beim Erstellen einer Connect-Session
URL zum Connect-Widget
"https://psd2.business-os.de/connect?token=xxx"
Ablaufzeitpunkt der Session
"2026-03-24T12:44:03Z"
User-ID, die als Connection-Owner persistiert wird (Dashboard-Flow: der authentifizierte Nutzer; API-Key-Flow: der erste Owner-Member der Ziel-Org). Identisch mit dem owner_user_id-Feld der späteren BankingConnection-Row.
"d90f20ae-f6c1-46da-a080-3d4c86329bf6"
Opaque Korrelations-Token. Wird in den Banking-custom_fields mitgegeben und kommt mit jedem Connection-Webhook zurück — Server-seitig matched darüber die Pre-Insert-Row mit dem eingehenden Banking-Connection-Event (Round-Trip-Key, garantiert dass die neue Connection auf der richtigen Org landet).
"8c4a8b18-9b7c-4f9d-9a3e-1a2b3c4d5e6f"