Create Payment

curl --request POST \
  --url https://api.business-os.de/v2/banking/payments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "account_id": "8273645091827364509",
  "amount": "1.00",
  "currency_code": "EUR",
  "template_identifier": "AUTO",
  "creditor_name": "Mustermann GmbH",
  "creditor_iban": "DE27100777770209299700",
  "description": "Rechnung G-RE-2026-03024",
  "reference": "RG-2026-03024",
  "date": "2026-07-01",
  "creditor_country_code": "DE",
  "creditor_address": "Musterstr. 1, 10115 Berlin",
  "creditor_agent": "MUSTBE22",
  "creditor_agent_name": "Musterbank AG",
  "debtor_bic": "DEUTDEFFXXX",
  "mode": "embedded",
  "return_to": "https://app.business-os.de/close",
  "custom_fields": {
    "invoice_id": "G-RE-2026-03024"
  }
}
'

import requests

url = "https://api.business-os.de/v2/banking/payments"

payload = {
    "account_id": "8273645091827364509",
    "amount": "1.00",
    "currency_code": "EUR",
    "template_identifier": "AUTO",
    "creditor_name": "Mustermann GmbH",
    "creditor_iban": "DE27100777770209299700",
    "description": "Rechnung G-RE-2026-03024",
    "reference": "RG-2026-03024",
    "date": "2026-07-01",
    "creditor_country_code": "DE",
    "creditor_address": "Musterstr. 1, 10115 Berlin",
    "creditor_agent": "MUSTBE22",
    "creditor_agent_name": "Musterbank AG",
    "debtor_bic": "DEUTDEFFXXX",
    "mode": "embedded",
    "return_to": "https://app.business-os.de/close",
    "custom_fields": { "invoice_id": "G-RE-2026-03024" }
}
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({
    account_id: '8273645091827364509',
    amount: '1.00',
    currency_code: 'EUR',
    template_identifier: 'AUTO',
    creditor_name: 'Mustermann GmbH',
    creditor_iban: 'DE27100777770209299700',
    description: 'Rechnung G-RE-2026-03024',
    reference: 'RG-2026-03024',
    date: '2026-07-01',
    creditor_country_code: 'DE',
    creditor_address: 'Musterstr. 1, 10115 Berlin',
    creditor_agent: 'MUSTBE22',
    creditor_agent_name: 'Musterbank AG',
    debtor_bic: 'DEUTDEFFXXX',
    mode: 'embedded',
    return_to: 'https://app.business-os.de/close',
    custom_fields: {invoice_id: 'G-RE-2026-03024'}
  })
};

fetch('https://api.business-os.de/v2/banking/payments', 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/payments",
  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([
    'account_id' => '8273645091827364509',
    'amount' => '1.00',
    'currency_code' => 'EUR',
    'template_identifier' => 'AUTO',
    'creditor_name' => 'Mustermann GmbH',
    'creditor_iban' => 'DE27100777770209299700',
    'description' => 'Rechnung G-RE-2026-03024',
    'reference' => 'RG-2026-03024',
    'date' => '2026-07-01',
    'creditor_country_code' => 'DE',
    'creditor_address' => 'Musterstr. 1, 10115 Berlin',
    'creditor_agent' => 'MUSTBE22',
    'creditor_agent_name' => 'Musterbank AG',
    'debtor_bic' => 'DEUTDEFFXXX',
    'mode' => 'embedded',
    'return_to' => 'https://app.business-os.de/close',
    'custom_fields' => [
        'invoice_id' => 'G-RE-2026-03024'
    ]
  ]),
  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/payments"

	payload := strings.NewReader("{\n  \"account_id\": \"8273645091827364509\",\n  \"amount\": \"1.00\",\n  \"currency_code\": \"EUR\",\n  \"template_identifier\": \"AUTO\",\n  \"creditor_name\": \"Mustermann GmbH\",\n  \"creditor_iban\": \"DE27100777770209299700\",\n  \"description\": \"Rechnung G-RE-2026-03024\",\n  \"reference\": \"RG-2026-03024\",\n  \"date\": \"2026-07-01\",\n  \"creditor_country_code\": \"DE\",\n  \"creditor_address\": \"Musterstr. 1, 10115 Berlin\",\n  \"creditor_agent\": \"MUSTBE22\",\n  \"creditor_agent_name\": \"Musterbank AG\",\n  \"debtor_bic\": \"DEUTDEFFXXX\",\n  \"mode\": \"embedded\",\n  \"return_to\": \"https://app.business-os.de/close\",\n  \"custom_fields\": {\n    \"invoice_id\": \"G-RE-2026-03024\"\n  }\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/payments")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"8273645091827364509\",\n  \"amount\": \"1.00\",\n  \"currency_code\": \"EUR\",\n  \"template_identifier\": \"AUTO\",\n  \"creditor_name\": \"Mustermann GmbH\",\n  \"creditor_iban\": \"DE27100777770209299700\",\n  \"description\": \"Rechnung G-RE-2026-03024\",\n  \"reference\": \"RG-2026-03024\",\n  \"date\": \"2026-07-01\",\n  \"creditor_country_code\": \"DE\",\n  \"creditor_address\": \"Musterstr. 1, 10115 Berlin\",\n  \"creditor_agent\": \"MUSTBE22\",\n  \"creditor_agent_name\": \"Musterbank AG\",\n  \"debtor_bic\": \"DEUTDEFFXXX\",\n  \"mode\": \"embedded\",\n  \"return_to\": \"https://app.business-os.de/close\",\n  \"custom_fields\": {\n    \"invoice_id\": \"G-RE-2026-03024\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.business-os.de/v2/banking/payments")

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  \"account_id\": \"8273645091827364509\",\n  \"amount\": \"1.00\",\n  \"currency_code\": \"EUR\",\n  \"template_identifier\": \"AUTO\",\n  \"creditor_name\": \"Mustermann GmbH\",\n  \"creditor_iban\": \"DE27100777770209299700\",\n  \"description\": \"Rechnung G-RE-2026-03024\",\n  \"reference\": \"RG-2026-03024\",\n  \"date\": \"2026-07-01\",\n  \"creditor_country_code\": \"DE\",\n  \"creditor_address\": \"Musterstr. 1, 10115 Berlin\",\n  \"creditor_agent\": \"MUSTBE22\",\n  \"creditor_agent_name\": \"Musterbank AG\",\n  \"debtor_bic\": \"DEUTDEFFXXX\",\n  \"mode\": \"embedded\",\n  \"return_to\": \"https://app.business-os.de/close\",\n  \"custom_fields\": {\n    \"invoice_id\": \"G-RE-2026-03024\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "payment_id": "4509182736450918273",
    "payment_url": "https://psd2.business-os.de/payments/connect?token=xxx",
    "expires_at": "2026-03-24T12:44:03Z",
    "end_to_end_id": "BOS-1716480000000-a1b2c3d4"
  }
}

{
  "error": "Missing required parameter: connection_id"
}

Banking PIS

Create Payment

Initiiert eine SEPA oder SEPA Instant Zahlung. Gibt eine Payment-URL zurück, über die der User die Zahlung per TAN bestätigt.

Nur account_id und amount sind pflichtig — alle anderen Werte (Provider, Debitor-IBAN, Banking-API) werden automatisch aus der Account-ID aufgelöst. Der end_to_end_id wird vom Server generiert (BOS-{ts}-{hex}) und in der Response zurückgegeben, damit später die zugehörige Transaction matchbar ist.

Cost: 3 Credits (only charged when payment settles successfully)

POST

banking

payments

Create Payment

curl --request POST \
  --url https://api.business-os.de/v2/banking/payments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "account_id": "8273645091827364509",
  "amount": "1.00",
  "currency_code": "EUR",
  "template_identifier": "AUTO",
  "creditor_name": "Mustermann GmbH",
  "creditor_iban": "DE27100777770209299700",
  "description": "Rechnung G-RE-2026-03024",
  "reference": "RG-2026-03024",
  "date": "2026-07-01",
  "creditor_country_code": "DE",
  "creditor_address": "Musterstr. 1, 10115 Berlin",
  "creditor_agent": "MUSTBE22",
  "creditor_agent_name": "Musterbank AG",
  "debtor_bic": "DEUTDEFFXXX",
  "mode": "embedded",
  "return_to": "https://app.business-os.de/close",
  "custom_fields": {
    "invoice_id": "G-RE-2026-03024"
  }
}
'

import requests

url = "https://api.business-os.de/v2/banking/payments"

payload = {
    "account_id": "8273645091827364509",
    "amount": "1.00",
    "currency_code": "EUR",
    "template_identifier": "AUTO",
    "creditor_name": "Mustermann GmbH",
    "creditor_iban": "DE27100777770209299700",
    "description": "Rechnung G-RE-2026-03024",
    "reference": "RG-2026-03024",
    "date": "2026-07-01",
    "creditor_country_code": "DE",
    "creditor_address": "Musterstr. 1, 10115 Berlin",
    "creditor_agent": "MUSTBE22",
    "creditor_agent_name": "Musterbank AG",
    "debtor_bic": "DEUTDEFFXXX",
    "mode": "embedded",
    "return_to": "https://app.business-os.de/close",
    "custom_fields": { "invoice_id": "G-RE-2026-03024" }
}
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({
    account_id: '8273645091827364509',
    amount: '1.00',
    currency_code: 'EUR',
    template_identifier: 'AUTO',
    creditor_name: 'Mustermann GmbH',
    creditor_iban: 'DE27100777770209299700',
    description: 'Rechnung G-RE-2026-03024',
    reference: 'RG-2026-03024',
    date: '2026-07-01',
    creditor_country_code: 'DE',
    creditor_address: 'Musterstr. 1, 10115 Berlin',
    creditor_agent: 'MUSTBE22',
    creditor_agent_name: 'Musterbank AG',
    debtor_bic: 'DEUTDEFFXXX',
    mode: 'embedded',
    return_to: 'https://app.business-os.de/close',
    custom_fields: {invoice_id: 'G-RE-2026-03024'}
  })
};

fetch('https://api.business-os.de/v2/banking/payments', 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/payments",
  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([
    'account_id' => '8273645091827364509',
    'amount' => '1.00',
    'currency_code' => 'EUR',
    'template_identifier' => 'AUTO',
    'creditor_name' => 'Mustermann GmbH',
    'creditor_iban' => 'DE27100777770209299700',
    'description' => 'Rechnung G-RE-2026-03024',
    'reference' => 'RG-2026-03024',
    'date' => '2026-07-01',
    'creditor_country_code' => 'DE',
    'creditor_address' => 'Musterstr. 1, 10115 Berlin',
    'creditor_agent' => 'MUSTBE22',
    'creditor_agent_name' => 'Musterbank AG',
    'debtor_bic' => 'DEUTDEFFXXX',
    'mode' => 'embedded',
    'return_to' => 'https://app.business-os.de/close',
    'custom_fields' => [
        'invoice_id' => 'G-RE-2026-03024'
    ]
  ]),
  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/payments"

	payload := strings.NewReader("{\n  \"account_id\": \"8273645091827364509\",\n  \"amount\": \"1.00\",\n  \"currency_code\": \"EUR\",\n  \"template_identifier\": \"AUTO\",\n  \"creditor_name\": \"Mustermann GmbH\",\n  \"creditor_iban\": \"DE27100777770209299700\",\n  \"description\": \"Rechnung G-RE-2026-03024\",\n  \"reference\": \"RG-2026-03024\",\n  \"date\": \"2026-07-01\",\n  \"creditor_country_code\": \"DE\",\n  \"creditor_address\": \"Musterstr. 1, 10115 Berlin\",\n  \"creditor_agent\": \"MUSTBE22\",\n  \"creditor_agent_name\": \"Musterbank AG\",\n  \"debtor_bic\": \"DEUTDEFFXXX\",\n  \"mode\": \"embedded\",\n  \"return_to\": \"https://app.business-os.de/close\",\n  \"custom_fields\": {\n    \"invoice_id\": \"G-RE-2026-03024\"\n  }\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/payments")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"8273645091827364509\",\n  \"amount\": \"1.00\",\n  \"currency_code\": \"EUR\",\n  \"template_identifier\": \"AUTO\",\n  \"creditor_name\": \"Mustermann GmbH\",\n  \"creditor_iban\": \"DE27100777770209299700\",\n  \"description\": \"Rechnung G-RE-2026-03024\",\n  \"reference\": \"RG-2026-03024\",\n  \"date\": \"2026-07-01\",\n  \"creditor_country_code\": \"DE\",\n  \"creditor_address\": \"Musterstr. 1, 10115 Berlin\",\n  \"creditor_agent\": \"MUSTBE22\",\n  \"creditor_agent_name\": \"Musterbank AG\",\n  \"debtor_bic\": \"DEUTDEFFXXX\",\n  \"mode\": \"embedded\",\n  \"return_to\": \"https://app.business-os.de/close\",\n  \"custom_fields\": {\n    \"invoice_id\": \"G-RE-2026-03024\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.business-os.de/v2/banking/payments")

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  \"account_id\": \"8273645091827364509\",\n  \"amount\": \"1.00\",\n  \"currency_code\": \"EUR\",\n  \"template_identifier\": \"AUTO\",\n  \"creditor_name\": \"Mustermann GmbH\",\n  \"creditor_iban\": \"DE27100777770209299700\",\n  \"description\": \"Rechnung G-RE-2026-03024\",\n  \"reference\": \"RG-2026-03024\",\n  \"date\": \"2026-07-01\",\n  \"creditor_country_code\": \"DE\",\n  \"creditor_address\": \"Musterstr. 1, 10115 Berlin\",\n  \"creditor_agent\": \"MUSTBE22\",\n  \"creditor_agent_name\": \"Musterbank AG\",\n  \"debtor_bic\": \"DEUTDEFFXXX\",\n  \"mode\": \"embedded\",\n  \"return_to\": \"https://app.business-os.de/close\",\n  \"custom_fields\": {\n    \"invoice_id\": \"G-RE-2026-03024\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "payment_id": "4509182736450918273",
    "payment_url": "https://psd2.business-os.de/payments/connect?token=xxx",
    "expires_at": "2026-03-24T12:44:03Z",
    "end_to_end_id": "BOS-1716480000000-a1b2c3d4"
  }
}

{
  "error": "Missing required parameter: connection_id"
}

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

Request-Body zum Initiieren einer Zahlung. Felder werden flach übergeben — provider_code, debtor_iban und die Banking-API werden automatisch aus der Account-ID aufgelöst. end_to_end_id wird immer server-seitig generiert (BOS-{timestamp}-{hex}) für das Payment-↔-Transaction-Matching. Ein vom Client übergebener Wert wird ignoriert.

account_id

string

required

ID des eigenen Bankkontos (Account.id). Daraus werden Provider, Debitor-IBAN und Banking-API automatisch aufgelöst.

Example:

"8273645091827364509"

amount

string

required

Betrag als String (z.B. "1.00" für 1,00 €).

Example:

"1.00"

currency_code

string

default:EUR

Währungscode (ISO 4217). Default EUR.

Example:

"EUR"

template_identifier

enum<string>

default:AUTO

Zahlungsart. Default AUTO: wählt automatisch SEPA_INSTANT, wenn die Bank Instant anbietet, sonst SEPA (bei Terminüberweisung via date immer SEPA); lehnt die Bank den automatisch gewählten Instant-Auftrag ab, wird einmalig als SEPA ausgeführt (Response-Feld template_fallback). Explizit gesetztes SEPA/SEPA_INSTANT wird unverändert verwendet.

Available options:

AUTO,

SEPA,

SEPA_INSTANT

Example:

"AUTO"

creditor_name

string

Name des Empfängers.

Example:

"Mustermann GmbH"

creditor_iban

string

IBAN des Empfängers.

Example:

"DE27100777770209299700"

description

string

Verwendungszweck.

Example:

"Rechnung G-RE-2026-03024"

reference

string

Lokales Label (optional) — z.B. die eigene Rechnungsnummer. Wird gespeichert und bei GET /v2/banking/payments/{id} sowie GET /v2/banking/payments wieder zurückgegeben, nicht an die Bank übermittelt (SEPA kennt kein solches Feld).

Example:

"RG-2026-03024"

date

string<date>

Ausführungsdatum (YYYY-MM-DD) für eine geplante Zahlung (Terminüberweisung). Nur wirksam, wenn das Payment-Template der Bank date unterstützt — die je Template verfügbaren Zusatzfelder liefert GET /v2/banking/payment-templates.

Example:

"2026-07-01"

creditor_country_code

string

ISO-3166-1-alpha-2 Country-Code des Empfängers. Wenn weggelassen, wird er automatisch aus den ersten 2 Zeichen der creditor_iban abgeleitet.

Example:

"DE"

creditor_address

string

Adresse des Empfängers (optional, bankabhängig).

Example:

"Musterstr. 1, 10115 Berlin"

creditor_agent

string

BIC der Empfängerbank (optional).

Example:

"MUSTBE22"

creditor_agent_name

string

Name der Empfängerbank (optional).

Example:

"Musterbank AG"

debtor_bic

string

BIC der eigenen Bank (optional, wird i.d.R. aus der debtor_iban aufgelöst).

Example:

"DEUTDEFFXXX"

mode

string

bankspezifischer Modus (optional, bankabhängig).

Example:

"embedded"

return_to

string<uri>

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

Redirect-URL nach Zahlungsbestätigung im Browser. Default https://app.business-os.de/close.

Example:

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

custom_fields

object

Benutzerdefinierte Felder (werden im Callback zurückgegeben).

Example:

{ "invoice_id": "G-RE-2026-03024" }

Response

Zahlung initiiert — User muss die payment_url aufrufen

Antwort beim Initiieren einer Zahlung. Banking-Response (data) wird durchgereicht, plus der server-seitig generierte end_to_end_id als zusätzliches Top-Level-Field unter data.

data

object

Show child attributes

List Daily Balances List Payments