Zum Hauptinhalt springen
Über den Endpunkt payment/stripeonboarding können Shops verbundene Stripe-Konten verwalten. Über die API können diese Konten erstellt, eingesehen, aktualisiert und gelöscht werden. Zusätzlich generiert die API Onboarding-Links mit Rücksprung- und Refresh-URLs. Zugriffe sind durch feingranulare Berechtigungen (Lesen/Schreiben/Erstellen/Löschen) geschützt. Antworten erfolgen als JSON.

Unterstützte Methoden

Angabe aller unterstützten Methoden.

Stripe-Onboarding-Vorgang

Die globalen Parameter der Stripe-Anbindung sind in der Konfiguration unter payment.stripe hinterlegt. Den Betriebsmodus eines verbundenen Kontos legen Sie beim Anlegen fest. Er bleibt am Eintrag gespeichert.

Datenfelder eines Eintrags

Beispiel

Beispiel von rawResponse

Methoden für Stripe-Onboarding

Dieser Abschnitt beschreibt die Endpunkte zur Verwaltung einzelner Stripe-Onboarding-Einträge.

GET payment/stripeonboarding

Mit diesem Endpunkt kann eine Liste der vorhandenen Onboarding-Einträge des aktuellen Shops geladen werden. Dabei werden Such- und Filterparameter aus der Anfrage berücksichtigt und auf deleted=false begrenzt. Für die Nutzung sind Leseberechtigungen für Stripe-Onboarding-Daten erforderlich.

Beispiel

Antwort

Fehlercodes

GET payment/stripeonboarding/{id}

Mit diesem Endpunkt kann ein einzelner Onboarding-Eintrag anhand seiner ID geladen werden. Für die Nutzung dieses Endpunkts sind Leseberechtigungen für Stripe-Onboarding-Daten erforderlich.

Beispiel

Antwort

Fehlercodes

POST payment/stripeonboarding

Über diesen Endpunkt wird ein verbundenes Stripe-Konto erstellt und dazu ein lokaler Onboarding-Eintrag angelegt. Den Betriebsmodus übergeben Sie im Feld mode des Request-Body. Im Admin-Interface führt die Schaltfläche zum Anlegen zunächst auf die Seite Neues Konto verbinden. Dort wählen Sie unter Modus auswählen zwischen Live-Modus und Sandbox-Modus. Erst danach legt das Admin-Interface den Eintrag an und leitet zu Stripe weiter. Als Ergebnis wird ein Onboarding-Link (URL) zurückgegeben, über den die Einrichtung bei Stripe abgeschlossen werden kann. Für die Nutzung dieses Endpunkts sind Erstellberechtigungen für Stripe-Onboarding-Daten erforderlich.

Beispiel

Request Body

Body-Parameter

Antwort

Fehlercodes

PUT payment/stripeonboarding/{id}

Über diesen Endpunkt kann ein bestehender Onboarding-Eintrag anhand seiner ID aktualisiert werden. Dabei werden zwei sinnvolle Anwendungsfälle über das Feld type im Request-Body unterschieden:
  • type = "finish": Der Eintrag wird mit dem aktuellen Zustand des verbundenen Stripe-Kontos synchronisiert. Dabei werden u. a. übermittelte Stammdaten, ToS-Annahme, Freigabe von Zahlungen und Auszahlungen geprüft und in einen verständlichen Status überführt (beispielsweise „fehlende Daten“, „ToS nicht bestätigt“, „Zahlungen/Auszahlungen deaktiviert“ oder „Auszahlungen aktiviert“). Zusätzlich werden E-Mail, Capabilities, die Standard-Konfiguration der Zahlungsarten und die unveränderte Rohantwort gespeichert. Das Ergebnis ist der aktualisierte Eintrag als JSON.
  • type = "refresh": Es wird ein neuer Onboarding-Link erzeugt, damit der Händler die Einrichtung bei Stripe nahtlos fortsetzen kann (beispielsweise nach einer Unterbrechung oder wenn weitere Angaben nötig sind).
Für die Nutzung dieses Endpunkts sind Schreibberechtigungen für Stripe-Onboarding-Daten erforderlich.

Beispiel

Request Body

Antwort, wenn type gleich "finish" gilt

Antwort, wenn type gleich "refresh" gilt

Fehlercodes

DELETE payment/stripeonboarding/{id}

Mit diesem Endpunkt kann ein bestehender Onboarding-Eintrag anhand seiner ID entfernt werden. Das Konto bei Stripe bleibt bestehen, aber der aktuelle Shop wird keine Zahlungen mehr für dieses Konto verarbeiten. Für die Nutzung dieses Endpunkts sind Löschberechtigungen für Stripe-Onboarding-Daten erforderlich.

Beispiel

Antwort

Fehlercodes

Support

Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum Kundenportal Bitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.