Darstellung
Create Refund (Create Stripe Refund)
Überblick
Mit dem Baustein Create Refund kannst du aus einem Workflow heraus Erstattungen bei deinem Zahlungsdienstleister Stripe erstellen. Der Baustein kommuniziert über eine dedizierte Schnittstelle, deren Parameter du durch die Bausteinkonfiguration festlegst.
Wird der Baustein im Workflow verwendet, erhält der Baustein standardmäßig einen generisch beschreibenden Namen: Create Refund wird zu Create Stripe Refund.
Den Baustein findest du unter: Workflow-Baukasten → DO → Services → Integrations → Stripe
Beispiel
Über einen Workflow sollen Erstattungen in deinem Stripe-System vorgenommen werden.
Konfigurationsoptionen
Der Baustein hat folgende Konfigurationsoptionen:
- Name: Bezeichnung des Bausteins
- Placeholders: Liste der verfügbaren Platzhalter
- Continue on Errors: Wenn aktiviert, läuft der Workflow trotz einer Fehlermeldung des HTTP-Statuscodes (400, 500) der Gegenstelle weiter und wird nicht abgebrochen. Dies bezieht sich nicht auf das Error-Object, das bei erfolgreicher Kommunikation mit dem Endpunkt zurückgegeben werden kann und konkrete Fehlerberichte zu konkreten Daten enthält.
Inputs
Die folgenden Inputs müssen für die Konfiguration des Bausteins definiert werden. Der API Key und alle Felder in den Required Inputs sind immer erforderlich und müssen zwingend angegeben werden. Die Advanced Inputs sind optional und können je nach Anwendungsfall konfiguriert werden.
Falls Stripe einen Fehler zurückgibt, steht ein Error Object zur Verfügung, das mit der Error Response von Stripe gefüllt wird.
API Key (Required)
| Parameter | Type | Description |
|---|---|---|
| API Key | string | Stripe Secret Key, beginnend mit sk_ |
Required Inputs
Die folgenden Parameter sind immer erforderlich und müssen zwingend konfiguriert werden:
| Parameter | Type | Description |
|---|---|---|
| Charge | string | Payment charge, fängt mit ch_ an |
Advanced Inputs (Optional)
Die folgenden Parameter sind optional und können je nach Anwendungsfall konfiguriert werden:
| Parameter | Type | Description |
|---|---|---|
| Amount | integer | Angabe in Cent. Der Betrag beschränkt sich auf den noch erstattungsfähigen Zahlbetrag eines Auftrags |
| Payment Intent | string | ID der PaymentIntent |
| Reason | string | Erstattungsgrund. Mögliche Werte: duplicate, fraudulent, requested_by_customer |
| Refund Application Fee | boolean | Boolescher Wert, der angibt, ob die Anmeldegebühr bei der Erstattung dieser Gebühr erstattet werden soll |
| Reverse Transfer | boolean | Boolescher Wert, der angibt, ob die Überweisung bei der Erstattung dieser Gebühr rückgängig gemacht werden soll. Die Überweisung wird anteilig zum erstatteten Betrag storniert. Eine Überweisung kann nur von der Anwendung storniert werden, welche die Gebühr verursacht hat |
Output des Bausteins
Im weiteren Verlauf des Workflows steht dir der Output Create Refund-Bausteins zur Verfügung.
Der Output entspricht der API-Response der Stripe-Schnittstelle und besteht aus folgenden Elementen:
- Response Item: Rückgabe-Objekt der Daten eines Erstattungsauftrags
- Response Error: Rückgabe -Objekt der Fehlerdaten eines gescheiterten Erstattungsauftrags
- Rückmeldung der Gegenstelle (status_code) entsprechend der HTTP Statuscodes (externer Link)
Create Refund konfigurieren
Öffne den Konfigurationsdialog des Bausteins über mehr → edit.
Gib im Feld Name eine treffende Bezeichnung ein. Zum Beispiel: „Create Stripe Refund“
Stelle anhand deines API Keys (
string) Zugang zu deinem Stripe-Konto her.Definiere den Zahlungsauftrag für die Erstattung, in dem du Charge (
string) im Required Input zuweist
- Konfiguriere optional die Advanced Inputs mit den benötigten Daten zu Amount (
integer), Payment Intent (string), Reason (string), Refund Application Fee (boolean) und Reverse Transfer (boolean)
Klicke auf SAVE.
✓ Der Baustein ist konfiguriert.