Skip to main content
POST
Create Connection

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

Banking-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 Banking-Customer)

Example:

"info@mustermann.de"

return_to
string<uri>

Redirect-URL nach erfolgreicher Verbindung

Example:

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

scopes
enum<string>[]

Banking-Scopes für die Verbindung. Standard deckt alle drei ab: Kontoinfos, Inhaberdaten und Transaktionen.

Available options:
accounts,
holder_info,
transactions
Example:
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 Connect-Widget

Example:

"https://psd2.business-os.de/connect?token=xxx"

expires_at
string<date-time>

Ablaufzeitpunkt der Session

Example:

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

owner_user_id
string<uuid>

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.

Example:

"d90f20ae-f6c1-46da-a080-3d4c86329bf6"

pending_token
string<uuid>

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).

Example:

"8c4a8b18-9b7c-4f9d-9a3e-1a2b3c4d5e6f"