payment - Zahlungsmethoden - WEBSALE Dokumentation

Der Knoten payment bündelt die komplette Zahlungskonfiguration des Shops inklusive einzelner Zahlungsarten (Anzeige, Regeln) und Payment-Providern wie PayPal, Stripe oder Computop.

`payment*` - Grundstruktur

Nachfolgend der Grundaufbau des Knotens payment

{
  "payment": {
    "payment": {},
    "paymentField": {},
    "computopHosted": {},
    "payPalCheckout": {},
    "payPalCheckoutErrors": {},
    "payPalPlus": {},
    "stripe": {},
    "stripeErrors": {},
    "transactionSettings": {}
  }
}

Parameterbeschreibung

Parameter	Beschreibung
`payment`	Steuert, welche Zahlungsarten im Shop angeboten werden.
`paymentField`	Legt Zusatzfelder an, die im Checkout zusammen mit einer Zahlungsart abgefragt werden, beispielsweise das Geburtsdatum für den Kauf auf Rechnung.
`computopHosted`	Konfiguriert die Anbindung an Computop.
`payPalCheckout`	Konfiguriert die Anbindung an PayPal-Checkout.
`payPalCheckoutErrors`	Legt die Fehlertexte fest, die der Käufer nach einer abgelehnten PayPal-Zahlung sieht.
`payPalPlus`	Konfiguriert die Anbindung an PayPal Plus.
`stripe`	Konfiguriert die Anbindung an Stripe.
`stripeErrors`	Legt die Fehlertexte fest, die der Käufer nach einer abgelehnten Stripe-Zahlung sieht.
`transactionSettings`	Legt zentral fest, welche Funktionen von den Zahlungsanbietern unterstützt werden, beispielsweise `refund`, `cancel`, `refresh` und `capture`.

`payment.computopHosted` - Computop Hosted Payments

Mit payment.computopHosted lässt sich Computop als gehostete Zahlungsseite einbinden. Der Knoten steuert beispielsweise Betriebsmodus (Live / Test), Verschlüsselung und Sprache / Template der Bezahlseite. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.computopHosted (Deeplink-Übersicht)

Beispielkonfiguration (`payment.computopHosted.creditcard`)

{
  "callbackUrl": "",
  "capturingMode": "auto",
  "chDesc": "",
  "encryption": "blowfish",
  "hmacKey": "",
  "hostedCheckBoxDefaultChecked": false,
  "hostedTemplateName": "Websale",
  "id": "creditcard",
  "languageCode": "",
  "linkValidForSeconds": 500,
  "mode": "test",
  "passCredentialOnFile": true,
  "pwLarge": "",
  "sendIPAddr": true,
  "sendIPZone": true,
  "sendZone": true,
  "totalSumAddition": 0,
  "uid": "Websale"
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`callbackUrl`	string	Name des Shop-Templates (Views), auf das Computop den Kunden nach der Zahlung zurückleitet. Aus der URL dieses Templates wird die Rückkehr-Adresse gebaut. Der Ausgang der Zahlung wird dabei als URL-Parameter `wsPaymentStatus` (`refresh` bzw. `cancel` bei Abbruch) angehängt.
`capturingMode`	enum	Zulässige Werte: `auto`= die Zahlung wird in einem Schritt geprüft und direkt eingezogen. `manual`= der Betrag wird beim Checkout nur reserviert, aber noch nicht belastet.
`chDesc`	string	Text, der beim Zahler erscheint (beispielsweise auf der Kartenabrechnung).
`encryption`	enum	Zulässige Werte: `aes` = Moderne Verschlüsselungsoption. `blowfish`= ältere Verschlüsselungsoption, die noch unterstützt wird.
`hmacKey`	string	Geheimschlüssel für Prüfungen der Daten gegenüber Computop.
`hostedCheckBoxDefaultChecked`	bool	Setzt eine von Computop bereitgestellte Einverständnis-Checkbox auf aktiv oder nicht aktiv (`true` / `false`).
`hostedTemplateName`	string	Name des Templates der gehosteten Computop-Bezahlseite.
`id`	string	Eindeutige Kennung der Zahlart, beispielsweise `creditcard`. Muss mit der `id` der Zahlungsart unter `payment.payment` übereinstimmen, die über `onlineClearing` auf den Service `payment.computop-hosted` verweist, und einer von Computop unterstützten Zahlart entsprechen. Mehr unter Validierungs- und Prüfservices.
`languageCode`	string	Sprache der Hosted-Page, beispielsweise `de` oder `en`. Leer = Standard von Computop.
`linkValidForSeconds`	int	Gültigkeitsdauer des Zahlungslinks in Sekunden.
`mode`	enum	Betriebsmodus der Computop-Integration. Zulässige Werte: -`test`= für Sandbox Tests - `live`= Verwendung in der Produktion.
`passCredentialOnFile`	bool	Kennzeichnet “Kartendaten hinterlegt” für Folgetransaktionen, sofern unterstüzt.
`pwLarge`	string	Zusätzliches Passwort gemäß Computop-Spezifikation. Das Passwort wird für die verschlüsselte Übertragung verwendet.
`sendIPAddr`	bool	Übermittelt die Kunden-IP-Adresse an Computop.
`sendIPZone`	bool	Übermittelt die aus der IP abgeleitete Zone (beispielsweise Land oder Region) an Computop.
`sendZone`	bool	Übermittelt die Shop-Zone (beispielsweise Lieferzone) an Computop.
`totalSumAddition`	float	Fester Auf-/Abschlag in Währungseinheiten auf die Gesamtsumme der Zahlart, beispielsweise `0.30`. `0`= kein Auf-/Abschlag. Nur möglich, wenn `capturingMode` den Wert `manual` hat.
`uid`	string	Händler-/Account-ID bei Computop.

`payment.payment` - Zahlungsarten anlegen

Der Knoten payment.payment fasst alle Zahlarten des Shops zusammen. Hier kann beispielsweise definiert werden, ob eine Zahlart aktiv ist, wie sie im Checkout heißen und aussehen soll, welcher Provider sie bedient und welche Regeln gelten. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.payment (Deeplink-Übersicht)

Zahlungsarten können an eine Währung oder Region gebunden sein (beispielsweise Bancontact: nur EUR, primär Belgien). Welche Währungen und Länder eine Zahlungsart unterstützt, wird vom Zahlungsanbieter bestimmt. Eine aktivierte Zahlungsart wird daher unabhängig von der Shop-Währung angeboten und kann eventuell beim Zahlungsdienstleister zu einem Fehler führen. Prüfen Sie daher vor der Aktivierung anhand der Anbieter-Dokumentation, ob die Zahlungsart zu Währung und Zielland Ihres Shops passt, und deaktivieren Sie nicht passende Methoden.

Läuft der Bestellablauf über mehrere Seiten und soll das Stripe-Widget bereits vor der Bestellübersicht geladen werden, legen Sie für Google Pay und Apple Pay je eine eigene Zahlungsart mit Stripe als Clearing-Service an. Das Template kann sich dann ab der Zahlungsarten-Seite auf das gewählte Wallet beziehen. Den Einbau im Template beschreibt Stripe im Frontend.

Beispielkonfiguration (`payment.payment.paypalCheckout`)

{
  "active": true,
  "additionalFields": [],
  "availableByDefault": true,
  "basicCost": [
    { "subtotal": 0, "cost": 2.5 },
    { "subtotal": 50, "cost": 0 }
  ],
  "description": "<Textbaustein>",
  "longDescription": "<Textbaustein>",
  "discount": 0,
  "displayedPaymentTypes": null,
  "freeFields": null,
  "id": "paypalCheckout",
  "image": "",
  "labels": ["<Textbaustein>"],
  "name": "<Textbaustein>",
  "onlineClearing": {
    "options": {
      "view": "paypal_checkout_pending.htm"
    },
    "service": "payment.paypal-checkout"
  },
  "orderText": "<Textbaustein>",
  "provider": "",
  "type": "",
  "validations": [
    { "service": "paymentValidation.voucherDeny" }
  ]
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`active`	bool	Zahlart im Checkout ein / aus.
`availableByDefault`	bool	Steuert, ob die Zahlart standardmäßig für alle Kunden verfügbar ist (Standard: `true`). Bei `false` steht die Zahlart Gästen und normalen Kundenkonten nicht zur Verfügung. Sie kann dann gezielt für einzelne Kundenkonten freigeschaltet werden, indem die Zahlart über die Admin-API in die Liste `enabledPaymentMethods` des Kontos aufgenommen wird (siehe API-Referenz Kundendaten). Umgekehrt kann eine standardmäßig verfügbare Zahlart über die Liste `blockedPaymentMethods` für einzelne Konten gesperrt werden.
`id`	string	Eindeutige Kennung der Zahlart, beispielsweise `paypalCheckout`
`name`	Textbaustein (string)	Anzeigename im Checkout, beispielsweise “PayPal”. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`orderText` (demnächst verfügbar)	Textbaustein (string)	Technischer Übergabewert für angebundene Drittsysteme, der mit der Bestellung exportiert wird. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`labels` (demnächst verfügbar)	list / textbaustein (string)	Optionale Kurzkennzeichnung für die Zahlart, die im Checkout als Hinweis angezeigt werden kann. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`type` (demnächst verfügbar)	string	Beschreibt die Art der Zahlabwicklung und hilft bei der Darstellung im Checkout. Übliche Werte sind beispielsweise: `online`- Zahlung läuft über einen Provider. `offline`- Zahlung wird manuell abgewickelt.
`onlineClearing`	singleService	Verknüpft die Zahlart mit einer konkreten Online-Zahlungs-Engine und schaltet damit den Echtzeit-Zahlungsablauf frei. Verfügbare Services: `payment.computop-hosted`, `payment.stripe`, `payment.paypal-checkout`. Über `options` wird festgelegt, auf welche Seiten der Kunde während der Zahlung geleitet wird. Für PayPal Kauf auf Rechnung gehört dazu außerdem `clearingFields`, siehe Beispiel: PayPal Kauf auf Rechnung. Mehr unter: Validierungs- und Prüfservices target: `payment`
`provider` (demnächst verfügbar)	string	Technischer Provider-Key (beispielsweise `stripe`)
`image` (demnächst verfügbar)	string	Icon/Logo-URL für die Zahlart.
`basicCost`	list (object)	Kosten der Zahlart, gestaffelt nach der Zwischensumme des Warenkorbs. Pro Eintrag: - `subtotal` (float) - Zwischensumme, ab der der Eintrag gilt - `cost` (float) - Kosten der Zahlart in Währungseinheiten Im Beispiel oben kostet die Zahlart 2,50 und ist ab einer Zwischensumme von 50 kostenlos. Die Kosten fließen im Checkout in `$wsCheckout.sum.paymentCost` ein.
`displayedPaymentTypes`	list (object)	Mit diesem Parameter können für eine Zahlungsart mehrere Einträge mit eigenem Namen, Icon, Bild oder Beschreibung hinterlegt werden. Dies ist vor allem dann relevant, wenn beispielsweise Payment-Provider wie Stripe direkt als Zahlungsarten konfiguriert werden, die enthaltenen Zahlungsmöglichkeiten jedoch außerhalb des Bestellablaufs separat dargestellt werden sollen - beispielsweise im Footer oder auf einer Zahlungsarten-Informationsseite. Die Anzeige der enthaltenen Zahlungsmöglichkeiten im Bestellablauf erfolgt in der Regel über den jeweiligen Provider. Pro Eintrag können folgende Eigenschaften gesetzt werden: - `name` - Anzeigename der Zahlungsoption - `image` - Pfad oder URL zu einem Bild / Icon der Zahlungsoption - `description` - Beschreibungstext der Zahlungsoption Die Ausgabe im Template erfolgt über die Variable des $wsConfig-Moduls, über die die konfigurierten Einträge im Frontend an der gewünschten Stelle ausgegeben werden können.
`validations`	multiService	Regeln und Checks für die Verfügbarkeit einer Zahlart (beispielsweise `paymentValidation.voucherDeny`- sperrt die Zahlart bei Gutschein-Warenkörben, `paymentValidation.userAgent` - schränkt die Zahlart auf bestimmte Geräte oder Browser ein). Mehr unter: Validierungs- und Prüfservices target: `paymentValidation`
`discount` (demnächst verfügbar)	float	Rabatt / Abschlag in Währungseinheiten. (beispielsweise `2.00`- Kunde zahlt 2 € weniger mit dieser Zahlart).
`description`	Textbaustein (string)	Längere Beschreibung / Hinweise zur Zahlungsart. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`longDescription`	Textbaustein (string)	Noch ausführlichere Variante des Beschreibungstextes als `description`, beispielsweise für eine Zahlungsarten-Informationsseite oder ausführliche Hinweise. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`freeFields`	list (string)	Freie Felder, beispielsweise für zusätzliche Angaben beim Rechnungskauf wie Geburtsdatum oder Firmeninformationen. Wird aktuell nur für Computop verwendet. Für neue Zusatzfelder nutzen Sie `additionalFields`.
`additionalFields`	multiAssoc, optional	Zusatzfelder, die im Checkout zusammen mit dieser Zahlungsart abgefragt werden. Die Felder werden in `payment.paymentField` angelegt und hier per Knoten-ID zugeordnet. target: `payment.paymentField`

`payment.paymentField` - Zusatzfelder für Zahlungsarten

Manche Zahlungsarten brauchen Angaben, die nicht in der Adresse stehen. PayPal Kauf auf Rechnung verlangt beispielsweise das Geburtsdatum und die Telefonnummer des Käufers. Mit dem Knoten payment.paymentField legen Sie solche Zusatzfelder an. Der Shop fragt sie im Checkout zusammen mit der Zahlungsart ab und schreibt die Eingaben in die Bestelldaten. Von dort lassen sie sich wie alle anderen Bestelldaten an externe Systeme exportieren. Ein Zusatzfeld entsteht in drei Schritten:

Feld in payment.paymentField anlegen.
Feld der Zahlungsart unter additionalFields zuordnen, siehe payment.payment.
Feld im Template ausgeben und mit der Aktion CheckoutSetPaymentFields speichern. Die Felder einer Zahlungsart stehen im Template unter $wsConfig.payments im Eintrag fields bereit.

Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.paymentField (Deeplink-Übersicht)

Beispielkonfiguration (`payment.paymentField.birthdatePayPal`)

Das Beispiel legt ein Pflichtfeld für das Geburtsdatum an. Der Wert wird im Kundenkonto gemerkt und muss dem Format JJJJ-MM-TT entsprechen.

{
  "displayConditions": null,
  "infoText": null,
  "label": "config.payment.paymentField.birthdate.label",
  "name": "bday",
  "rememberInput": true,
  "required": true,
  "type": {
    "checkbox": null,
    "date": {},
    "select": null,
    "text": null
  },
  "validations": [
    {
      "options": {
        "expression": "(19|20)[0-9]{2}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])"
      },
      "service": "dataChecker.regex"
    }
  ]
}

dataChecker.regex prüft, ob der gesamte Wert zum Ausdruck passt. Ein Datumsfeld liefert Monat und Tag immer zweistellig, beispielsweise 1990-05-01. Der Ausdruck muss deshalb führende Nullen zulassen.

Parameterbeschreibung

Parameter	Typ	Beschreibung
`name`	string	Technischer Name des Feldes. Unter diesem Namen steht der Wert im Template, in den Bestelldaten und in Verweisen aus anderen Konfigurationen, beispielsweise in `clearingFields` einer Zahlungsart. Maßgeblich ist dieser Name, nicht die ID des Konfigurationsknotens.
`label`	Textbaustein (string)	Beschriftung des Feldes im Checkout. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`infoText`	Textbaustein (string), optional	Zusätzlicher Hinweis zum Feld, beispielsweise warum die Angabe gebraucht wird. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`required`	bool	Kennzeichnet das Feld als Pflichtfeld. Ein leeres Pflichtfeld verhindert den Bestellabschluss mit dem Fehlercode `requiredPaymentFieldEmpty`, eine nicht gesetzte Pflicht-Checkbox mit `requiredPaymentCheckboxUnchecked`.
`type`	oneOf	Feldtyp. Genau eine Option ist gesetzt, die übrigen stehen auf `null`. - `text` - Texteingabe - `checkbox` - Checkbox, der gespeicherte Wert ist `true` oder `false` - `select` - Auswahlliste. Die Einträge stehen unter `select.options` mit je `value` (übergebener Wert) und `label` (angezeigter Text, Textbaustein). Ein Wert, der nicht in der Liste steht, wird nicht übernommen. - `date` - Datumseingabe
`rememberInput`	bool	Merkt sich den eingegebenen Wert nach der Bestellung im Kundenkonto, siehe Eingaben merken.
`validations`	multiService, optional	Prüfungen für den eingegebenen Wert. Verwendbar sind alle Services aus `dataChecker.*`. Schlägt eine Prüfung fehl, lautet der Fehlercode `fieldCheckFailed`. Der Fehlertext stammt aus `general.dataCheckerValidationErrors`. target: `dataChecker`
`displayConditions`	multiService, optional	Bedingungen, unter denen das Feld im Checkout angezeigt wird. Alle Bedingungen müssen erfüllt sein. Ohne Bedingung wird das Feld immer angezeigt. Verwendbar sind die Services aus `paymentFieldDisplayCheck.*`. target: `paymentFieldDisplayCheck`

Ein Feld, dessen Anzeigebedingungen nicht erfüllt sind, gilt als nicht vorhanden. Es erscheint nicht im Template, wird nicht geprüft und blockiert auch als Pflichtfeld den Bestellabschluss nicht.

Mehrere Felder mit demselben Namen

Weil der Shop Zusatzfelder über name anspricht, können mehrere Konfigurationsknoten denselben Namen tragen. So lässt sich dieselbe Angabe je nach Situation unterschiedlich abfragen, beispielsweise mit länderabhängigen Auswahllisten oder Prüfungen. Die Varianten unterscheiden sich dann über displayConditions.

Die Anzeigebedingungen gleichnamiger Felder müssen sich gegenseitig ausschließen. Sind zwei gleichnamige Felder gleichzeitig sichtbar, schreiben beide in denselben Wert.

Eingaben merken

Mit rememberInput: true speichert der Shop den eingegebenen Wert nach der Bestellung im Kundenkonto. Das gilt nur für angemeldete Kunden. Bei Gastbestellungen bleibt der Wert in der laufenden Sitzung und wird nicht gespeichert. Der gemerkte Wert wird beim nächsten Checkout nicht automatisch eingesetzt. Das Template entscheidet, ob es das Feld damit vorbelegt. Der Wert steht dort als rememberedValue am Feld bereit, siehe $wsConfig.payments.

Zusatzfelder in den Bestelldaten

Mit der Bestellung schreibt der Shop die Zusatzfelder der gewählten Zahlungsart in den Block order.paymentFields. Schlüssel ist der technische Name des Feldes, Wert die Eingabe des Kunden:

"paymentFields": {
  "bday": "1990-05-01",
  "phone": "+491701234567"
}

Enthalten sind alle Felder, die der Zahlungsart zugeordnet sind. Ein Feld, das wegen seiner Anzeigebedingung nicht angezeigt wurde, steht mit leerem Wert darin oder mit einer früheren Eingabe aus derselben Sitzung.

Beispiel: PayPal Kauf auf Rechnung

PayPal braucht für den Kauf auf Rechnung das Geburtsdatum und die Telefonnummer des Käufers. Welche Zusatzfelder diese Angaben liefern, legen Sie in der Zahlungsart unter onlineClearing.options.clearingFields fest:

"onlineClearing": {
  "options": {
    "clearingFields": {
      "birthdate": "bday",
      "phone": "phone"
    },
    "type": "invoice"
  },
  "service": "payment.paypal-checkout"
}

Der Shop übergibt den Wert des Zusatzfeldes bday als Geburtsdatum und den Wert von phone als Telefonnummer an PayPal. Eingetragen wird jeweils der technische Name aus name, nicht die ID des Konfigurationsknotens. Beide Felder müssen der Zahlungsart zusätzlich unter additionalFields zugeordnet sein, sonst fragt der Checkout sie nicht ab.

Parameter	Typ	Beschreibung
`clearingFields.birthdate`	string	Technischer Name des Zusatzfeldes, dessen Wert als Geburtsdatum an PayPal geht. PayPal erwartet das Format `JJJJ-MM-TT`.
`clearingFields.phone`	string	Technischer Name des Zusatzfeldes, dessen Wert als Telefonnummer an PayPal geht.

Bei der Telefonnummer liest der Shop die Ländervorwahl aus dem Anfang der Eingabe. Beginnt die Nummer mit + oder 00, gelten die folgenden zwei Ziffern als Ländervorwahl. Fehlt beides, nimmt der Shop die Vorwahl 49 für Deutschland an. Ländervorwahlen mit einer oder drei Ziffern, beispielsweise +1 oder +352, teilt diese Regel falsch auf. Nummern mit höchstens vier Zeichen übergibt der Shop nicht. Eine Prüfung per validations im Zusatzfeld fängt falsche Formate ab, bevor PayPal die Zahlung ablehnt.

Ohne clearingFields übernimmt der Shop Geburtsdatum und Telefonnummer aus der Rechnungsadresse. Dieses Verhalten ist nur noch für bestehende Shops vorgesehen und gilt als veraltet. Neue Einrichtungen nutzen Zusatzfelder.

`payment.payPalCheckout` - PayPal Checkout Konfiguration

Der Knoten payment.payPalCheckout konfiguriert den PayPal Checkout im Shop. Darunter beispielsweise die Aktivschaltung, die Einstellung des Modus (Live / Testmodus) und die Sprache. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.payPalCheckout (Deeplink-Übersicht)

Beispielkonfiguration

{
  "active": true,
  "approvalTemplate": "",
  "brandName": "Websale AG",
  "cancelTemplate": "",
  "customerServiceInstructions": null,
  "denyPendingPayments": true,
  "dummyProductAddition": "dummy product",
  "errorTemplate": "",
  "expressCheckoutAllow": true,
  "expressCheckoutApplePayAllow": false,
  "expressCheckoutGooglePayAllow": false,
  "languageCode": "de-DE",
  "logoUrl": "",
  "mode": "sandbox",
  "payerId": ""
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`active` (demnächst verfügbar)	bool	Schaltet PayPal Checkout ein / aus.
`payerId`	string	Paypal Merchant-ID des Händlerkontos.
`dummyProductAddition`	string	Optionaler Zusatztext für Artikelnamen, falls PayPal eine Mindestangabe fordert, beispielsweise als Platzhalter bei leeren Namen.
`denyPendingPayments`	bool	`true`- Bestellungen mit dem PayPal-Status “pending” werden abgelehnt bzw. nicht fortgeführt. Der Käufer sieht dann den Text `pendingPaymentDenied` aus `payment.payPalCheckoutErrors`. `false`- “pending” wird zugelassen.
`brandName`	string	Händlername, der angezeigt wird.
`languageCode`	string	Anzeigesprache für PayPal, beispielsweise `de-DE` oder `en-US`.
`logoUrl`	string	URL zu einem Logo für die Darstellung im PayPal-Checkout.
`customerServiceInstructions`	list (string)	Optionale Kundenhinweise, die im PayPal-Kontext angezeigt werden können.
`mode`	enum	Betriebsmodus des PayPal-Checkouts. `sandbox`- Testmodus `live`- Produktivmodus Default: `sandbox`
`pendingTemplate`	string	Name des Shop-Templates (Views), das der Kunde sieht, solange eine PayPal-Zahlung noch aussteht, beispielsweise beim Kauf auf Rechnung. Greift, wenn in `onlineClearing` der Zahlungsart keine Option `view` gesetzt ist. Ist auch dieser Wert leer, nutzt der Shop `pendingTemplate` aus `general.subshopView`.
`approvalTemplate`	string	Name des Shop-Templates (Views), auf das der Kunde nach erfolgreicher Bestätigung der PayPal-Zahlung zurückgeleitet wird. Aus der URL dieses Templates wird die Rückkehr-Adresse gebaut, mit dem URL-Parameter `wsPaymentStatus=refresh`. Sie steht im Frontend als `approvalUrl` bzw. `expressApprovalUrl` in der Rückgabe von `$wsPayPalCheckout.loadData()` zur Verfügung. Default: `checkout.htm`
`errorTemplate`	string	Name des Shop-Templates (Views), auf das der Kunde bei einem Fehler im PayPal-SDK geleitet wird (URL-Parameter `wsPaymentStatus=error`). Dort sieht der Kunde den Grund unter `$wsCheckout.problems.clearing`. Im Frontend als `errorUrl` in der Rückgabe von `loadData()` verfügbar. Default: `checkout.htm`
`cancelTemplate`	string	Name des Shop-Templates (Views), auf das der Kunde nach dem Abbruch der PayPal-Zahlung geleitet wird (URL-Parameter `wsPaymentStatus=cancel`). Im Frontend als `cancelUrl` in der Rückgabe von `loadData()` verfügbar. Default: `checkout.htm`
`expressCheckoutAllow`	bool	Erlaubt PayPal Express (Direktkauf-Buttons beispielsweise im Warenkorb oder am Produkt). Default: `false`
`expressCheckoutApplePayAllow`	bool	Erlaubt Apple Pay Express über die PayPal Commerce Platform. Ob Apple Pay Express im Frontend angeboten werden kann, gibt `$wsPayPalCheckout.expressCheckoutApplePay` aus.
`expressCheckoutGooglePayAllow`	bool	Erlaubt Google Pay Express über die PayPal Commerce Platform. Ob Google Pay Express im Frontend angeboten werden kann, gibt `$wsPayPalCheckout.expressCheckoutGooglePay` aus.

`payment.payPalCheckoutErrors` - Fehlertexte zu abgelehnten PayPal-Zahlungen

Lehnt PayPal eine Zahlung ab oder scheitert die Prüfung des Shops, kehrt der Käufer in den Checkout zurück und sieht dort den Grund. Der Knoten payment.payPalCheckoutErrors legt fest, welcher Text dabei erscheint. Jedem Ablehnungsgrund, den PayPal meldet, ist ein eigener Parameter zugeordnet. Hinzu kommen Gründe aus den eigenen Prüfungen des Shops, die PayPal selbst nie meldet. Im Template steht der Grund unter $wsCheckout.problems.clearing zur Verfügung. Die Eigenschaft code enthält den Namen des Parameters, text den fertigen Text aus diesem Knoten. Meldet PayPal einen Grund, für den es hier keinen Parameter gibt, verwendet der Shop den allgemeinen Text aus checkout.clearingErrors. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.payPalCheckoutErrors (Deeplink-Übersicht)

**Fehlertexte sind schreibgeschützt.** Die Fehlercode-Felder auf dieser Seite enthalten den Namen eines Textbausteins (ws.error.<configId>.<errorCode>), nicht den Fehlertext. Gepflegt wird der Text ausschließlich im Textbaustein-Dienst des Admin-Interface – Änderungen an der Konfiguration werden beim Speichern abgewiesen, auch über die [REST API](/schnittstellen/admin-interface-api/api-referenz-konfiguration). E-Mail-Vorlagen sind nicht betroffen.

Nachfolgend ein Ausschnitt aus der Konfiguration für payment.payPalCheckoutErrors:

{
  "errorCodes": {
    "cardExpired": "<Textbaustein>",
    "instrumentDeclined": "<Textbaustein>",
    "orderAmountMismatch": "<Textbaustein>",
    "threeDSecureFailed": "<Textbaustein>"
  }
}

Parameterbeschreibung

Alle Parameter liegen unter errorCodes und sind vom Typ string. Jeder Parameter verweist auf einen Textbaustein mit der Bezeichnung ws.error.payPalCheckout.<Parameter>, beispielsweise ws.error.payPalCheckout.cardExpired. In der Tabelle steht der deutsche Standardtext. Dieser Text wird über einen Textbaustein realisiert.
Alles zu Textbausteinen in Konfigurationen finden Sie hier. Von PayPal gemeldete Gründe

Parameter	Meldung von PayPal	Standardtext
`applePayAmountMismatch`	`APPLE_PAY_AMOUNT_MISMATCH`	Der Apple Pay-Betrag stimmt nicht mit dem Bestellbetrag überein. Bitte versuchen Sie es erneut.
`authorizationAmountExceeded`	`AUTHORIZATION_AMOUNT_EXCEEDED`	Der autorisierte Betrag wurde überschritten. Bitte kontaktieren Sie Ihre Bank oder wählen Sie eine andere Zahlungsart.
`bankNotSupportedForVerification`	`BANK_NOT_SUPPORTED_FOR_VERIFICATION`	Ihre Bank unterstützt die erforderliche Verifizierung nicht. Bitte wählen Sie eine andere Zahlungsart.
`bankVerificationRequired`	`BANK_VERIFICATION_REQUIRED`	Ihre Bank erfordert eine zusätzliche Verifizierung. Bitte folgen Sie den Anweisungen Ihrer Bank.
`billingAddressInvalid`	`BILLING_ADDRESS_INVALID`	Die angegebene Rechnungsadresse ist ungültig. Bitte überprüfen Sie Ihre Eingabe.
`cardBrandNotSupported`	`CARD_BRAND_NOT_SUPPORTED`	Diese Kartenmarke wird nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`cardCountryNotSupported`	`CARD_COUNTRY_NOT_SUPPORTED`	Karten aus diesem Land werden nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`cardDataNotFound`	`CARD_DATA_NOT_FOUND`	Die Kartendaten konnten nicht gefunden werden. Bitte versuchen Sie es erneut oder wählen Sie eine andere Zahlungsart.
`cardExpired`	`CARD_EXPIRED`	Die Karte ist abgelaufen. Bitte verwenden Sie eine andere Karte.
`cardTypeNotSupported`	`CARD_TYPE_NOT_SUPPORTED`	Dieser Kartentyp wird nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`cityRequired`	`CITY_REQUIRED`	Bitte geben Sie einen Ort an.
`complianceViolation`	`COMPLIANCE_VIOLATION`	Die Zahlung konnte aus regulatorischen Gründen nicht durchgeführt werden.
`contingencyNotSuccessful`	`CONTINGENCY_NOT_SUCCESSFUL`	Die Zahlungsauthentifizierung war nicht erfolgreich. Bitte versuchen Sie es erneut oder wählen Sie eine andere Zahlungsart.
`countryNotSupportedByPaymentSource`	`COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE`	Ihr Land wird von dieser Zahlungsart nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`currencyNotSupportedForBank`	`CURRENCY_NOT_SUPPORTED_FOR_BANK`	Diese Währung wird von Ihrer Bank nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`currencyNotSupportedForCardType`	`CURRENCY_NOT_SUPPORTED_FOR_CARD_TYPE`	Diese Währung wird von diesem Kartentyp nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`domesticTransactionRequired`	`DOMESTIC_TRANSACTION_REQUIRED`	Diese Karte kann nur für inländische Transaktionen verwendet werden. Bitte wählen Sie eine andere Zahlungsart.
`ibanCountryNotSupported`	`IBAN_COUNTRY_NOT_SUPPORTED`	Das Land dieser IBAN wird nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`instrumentDeclined`	`INSTRUMENT_DECLINED`	Das gewählte Zahlungsmittel wurde abgelehnt. Bitte wählen Sie eine andere Zahlungsart oder kontaktieren Sie Ihre Bank.
`invalidExpiryDate`	`INVALID_EXPIRY_DATE`	Das angegebene Ablaufdatum ist ungültig. Bitte überprüfen Sie Ihre Eingabe.
`invalidIban`	`INVALID_IBAN`	Die angegebene IBAN ist ungültig. Bitte überprüfen Sie Ihre Eingabe.
`invalidPostalCode`	`INVALID_POSTAL_CODE`	Die angegebene Postleitzahl ist ungültig. Bitte überprüfen Sie Ihre Eingabe.
`invalidPostalCodeLength`	`INVALID_POSTAL_CODE_LENGTH`	Die angegebene Postleitzahl hat eine ungültige Länge. Bitte überprüfen Sie Ihre Eingabe.
`invalidSecurityCodeLength`	`INVALID_SECURITY_CODE_LENGTH`	Die eingegebene Prüfnummer hat eine ungültige Länge. Bitte überprüfen Sie Ihre Eingabe.
`payeeBlockedTransaction`	`PAYEE_BLOCKED_TRANSACTION`	Die Zahlung konnte nicht abgeschlossen werden. Bitte wählen Sie eine andere Zahlungsart.
`payerAccountLockedOrClosed`	`PAYER_ACCOUNT_LOCKED_OR_CLOSED`	Ihr PayPal-Konto ist gesperrt oder geschlossen. Bitte kontaktieren Sie PayPal oder wählen Sie eine andere Zahlungsart.
`payerCannotPay`	`PAYER_CANNOT_PAY`	Mit diesem Konto kann keine Zahlung durchgeführt werden. Bitte wählen Sie eine andere Zahlungsart.
`payerNotSupportedByPaymentSource`	`PAYER_NOT_SUPPORTED_BY_PAYMENT_SOURCE`	Ihr Konto wird von dieser Zahlungsart nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`paymentDenied`	`PAYMENT_DENIED`	Die Zahlung wurde abgelehnt. Bitte kontaktieren Sie Ihre Bank oder wählen Sie eine andere Zahlungsart.
`paymentSourceCannotBeUsed`	`PAYMENT_SOURCE_CANNOT_BE_USED`	Dieses Zahlungsmittel kann nicht verwendet werden. Bitte wählen Sie eine andere Zahlungsart.
`paymentSourceDeclinedByProcessor`	`PAYMENT_SOURCE_DECLINED_BY_PROCESSOR`	Die Zahlung wurde vom Zahlungsdienstleister abgelehnt. Bitte wählen Sie eine andere Zahlungsart.
`paymentSourceInfoCannotBeVerified`	`PAYMENT_SOURCE_INFO_CANNOT_BE_VERIFIED`	Die Zahlungsinformationen konnten nicht verifiziert werden. Bitte überprüfen Sie Ihre Eingabe oder wählen Sie eine andere Zahlungsart.
`postalCodeRequired`	`POSTAL_CODE_REQUIRED`	Bitte geben Sie eine Postleitzahl an.
`preferredBrandNotSupported`	`PREFERRED_BRAND_NOT_SUPPORTED`	Die bevorzugte Kartenmarke wird nicht unterstützt. Bitte wählen Sie eine andere Zahlungsart.
`puiDuplicateOrder`	`PUI_DUPLICATE_ORDER`	Diese Bestellung wurde bereits verarbeitet. Bitte prüfen Sie Ihre Bestellungen.
`referencedCardExpired`	`REFERENCED_CARD_EXPIRED`	Die hinterlegte Karte ist abgelaufen. Bitte aktualisieren Sie Ihre Zahlungsdaten oder wählen Sie eine andere Zahlungsart.
`shippingAddressInvalid`	`SHIPPING_ADDRESS_INVALID`	Die angegebene Lieferadresse ist ungültig. Bitte überprüfen Sie Ihre Eingabe.
`transactionBlockedByPayee`	`TRANSACTION_BLOCKED_BY_PAYEE`	Die Transaktion wurde abgelehnt. Bitte wählen Sie eine andere Zahlungsart.
`transactionLimitExceeded`	`TRANSACTION_LIMIT_EXCEEDED`	Das Transaktionslimit wurde überschritten. Bitte kontaktieren Sie Ihre Bank oder wählen Sie eine andere Zahlungsart.
`transactionReceivingLimitExceeded`	`TRANSACTION_RECEIVING_LIMIT_EXCEEDED`	Das Empfangslimit für Zahlungen wurde überschritten. Bitte versuchen Sie es später erneut oder wählen Sie eine andere Zahlungsart.
`transactionRefused`	`TRANSACTION_REFUSED`	Die Transaktion wurde abgelehnt. Bitte kontaktieren Sie Ihre Bank oder wählen Sie eine andere Zahlungsart.

Gründe aus den Prüfungen des Shops

Parameter	Auslöser	Standardtext
`orderStateInvalid`	Die PayPal-Bestellung hat bei der Prüfung durch den Shop keinen gültigen Status.	Die PayPal-Zahlung konnte nicht abgeschlossen werden. Bitte versuchen Sie es erneut.
`orderAmountMismatch`	Der Betrag der PayPal-Bestellung weicht vom Warenkorb ab.	Der Betrag der PayPal-Zahlung stimmt nicht mit Ihrem Warenkorb überein. Bitte starten Sie die Zahlung erneut.
`threeDSecureFailed`	Die 3-D-Secure-Prüfung der Karte ist fehlgeschlagen.	Die 3D-Secure-Prüfung Ihrer Karte ist fehlgeschlagen. Bitte versuchen Sie es erneut oder wählen Sie eine andere Zahlungsart.
`pendingPaymentDenied`	PayPal meldet die Zahlung als ausstehend und unter `payment.payPalCheckout` ist `denyPendingPayments` aktiv.	Die PayPal-Zahlung konnte nicht sofort bestätigt werden. Bitte wählen Sie eine andere Zahlungsart.
`captureOrderStatusInvalid`	Die PayPal-Bestellung hat beim Einzug weder den Status abgeschlossen noch ausstehend.	Die PayPal-Zahlung konnte nicht abgeschlossen werden. Bitte versuchen Sie es erneut oder wählen Sie eine andere Zahlungsart.
`captureDeclined`	PayPal hat die Bestellung abgeschlossen, den Einzug des Betrags aber abgelehnt.	Die Zahlung wurde von PayPal abgelehnt. Bitte wählen Sie eine andere Zahlungsart.
`captureStatusUnknown`	Der Status des Einzugs lässt sich nicht ermitteln.	Der Status Ihrer PayPal-Zahlung konnte nicht ermittelt werden. Bitte prüfen Sie in Ihrem PayPal-Konto, ob die Zahlung ausgeführt wurde, bevor Sie es erneut versuchen.

`payment.payPalPlus` - PayPal Plus Konfiguration

PayPal Plus war eine integrierte Zahlungslösung für Online-Händler, die PayPal, Lastschrift, Kreditkarte und Kauf auf Rechnung in einem Modul gebündelt hat. Inzwischen wurde PayPal Plus durch das neue PayPal Checkout abgelöst. Die Integration wurde daher aus der aktuellen Software-Generation entfernt.Der Knoten payment.payPalPlus konfigurierte ehemals PayPal Plus im Shop. Darunter beispielsweise die Aktivschaltung, die Einstellung des Modus (Live / Testmodus) und die Sprache.Beispielkonfiguration

{
  "active": false,
  "denyPendingPayments": true,
  "dummyProductAddition": "dummy product",
  "experienceProfileID": "<PROFILEID>",
  "merchantId": "<MERCHANTID>",
  "mode": "sandbox"
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`active` (demnächst verfügbar)	bool	Schaltet PayPal Plus ein / aus.
`merchantId`	string	Paypal Merchant-ID des Händlerkontos.
`dummyProductAddition`	string	Optionaler Zusatztext für Artikelnamen, falls PayPal eine Mindestangabe fordert, beispielsweise als Platzhalter bei leeren Namen.
`experienceProfileID`	string	ID eines PayPal-Experience-Profils (steuert u.a. Darstellung / Branding im PayPal-Flow).
`denyPendingPayments`	bool	`true`- Bestellungen mit dem PayPal-Status “pending” werden abgelehnt bzw. nicht fortgeführt. `false`- “pending” wird zugelassen.
`mode`	enum	Betriebsmodus von PayPalPlus. `sandbox`- Testmodus `live`- Produktivmodus Default: `sandbox`

`payment.stripe` - Stripe Konfiguration

Der Knoten payment.stripe konfiguriert Stripe als Zahlungsdienstleister. Darunter beispielsweise die Aktivschaltung, die Einstellung des Modus (Live / Testmodus) und die Sprache. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.stripe (Deeplink-Übersicht)

Beispielkonfiguration

{
  "active": false,
  "autoRefundOnError": true,
  "mode": "sandbox",
  "savedPaymentMethods": {
    "displaySavedPaymentMethods": false,
    "maxDisplayedSavedPaymentMethods": 3,
    "paymentMethodAllowDelete": false,
    "paymentMethodAllowSave": false
  },
  "targetAccount": ""
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`active`	bool	Schaltet den Stripe-Connector ein / aus.
`mode`	enum	Betriebsmodus von Stripe. `sandbox`- Testmodus `live`- Produktivmodus Default: `sandbox`
`targetAccount`	string	Stripe-Konto (beispielsweise Account-ID), an das Zahlungen gebucht werden.
`autoRefundOnError`	bool	Aktiviert die automatische Rückerstattung, wenn während der Bestellverarbeitung seitens Websale ein Fehler auftritt. Bereits bezahlte, aber ungültige Bestellungen werden dadurch automatisch erstattet. Ist die Option deaktiviert, müssen solche Fälle manuell in Stripe rückerstattet werden. Default: `true`
`savedPaymentMethods`	object	Steuerung der gespeicherten Zahlungsarten.
`displaySavedPaymentMethods`	bool	Bereits gespeicherte Zahlungsarten im Checkout anzeigen.
`maxDisplayedSavedPaymentMethods`	int	Maximal anzuzeigende gespeicherte Zahlungsarten. Default: `3`
`paymentMethodAllowSave`	bool	Kunden dürfen neue Zahlungsmittel speichern.
`paymentMethodAllowDelete`	bool	Kunden dürfen gespeicherte Zahlungsarten löschen.

`payment.stripeErrors` - Fehlertexte zu abgelehnten Stripe-Zahlungen

Lehnt Stripe eine Zahlung ab, kehrt der Käufer in den Checkout zurück und sieht dort den Grund. Der Knoten payment.stripeErrors legt fest, welcher Text dabei erscheint. Jedem Ablehnungsgrund, den Stripe meldet, ist ein eigener Parameter zugeordnet. Der Shop wertet zuerst den genauen Ablehnungsgrund von Stripe aus (decline_code) und danach den allgemeineren Fehlercode (code). Im Template steht der Grund unter $wsCheckout.problems.clearing zur Verfügung. Die Eigenschaft code enthält den Namen des Parameters, text den fertigen Text aus diesem Knoten. Meldet Stripe einen Grund, für den es hier keinen Parameter gibt, verwendet der Shop den allgemeinen Text aus checkout.clearingErrors. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.stripeErrors (Deeplink-Übersicht)

Nachfolgend ein Ausschnitt aus der Konfiguration für payment.stripeErrors:

{
  "errorCodes": {
    "cardDeclined": "<Textbaustein>",
    "expiredCard": "<Textbaustein>",
    "incorrectCvc": "<Textbaustein>",
    "insufficientFunds": "<Textbaustein>"
  }
}

Parameterbeschreibung

Alle Parameter liegen unter errorCodes und sind vom Typ string. Jeder Parameter verweist auf einen Textbaustein mit der Bezeichnung ws.error.stripe.<Parameter>, beispielsweise ws.error.stripe.insufficientFunds. Die deutschen Standardtexte sehen Sie im Textbaustein-Dienst. Dieser Text wird über einen Textbaustein realisiert.
Alles zu Textbausteinen in Konfigurationen finden Sie hier.

Parameter	Meldung von Stripe
`accountClosed`	`account_closed`
`amountTooLarge`	`amount_too_large`
`amountTooSmall`	`amount_too_small`
`approveWithId`	`approve_with_id`
`authenticationFailure`	`authentication_failure`
`authenticationRequired`	`authentication_required`
`bankAccountDeclined`	`bank_account_declined`
`bankAccountRestricted`	`bank_account_restricted`
`bankAccountUnusable`	`bank_account_unusable`
`callIssuer`	`call_issuer`
`cardDeclineRateLimitExceeded`	`card_decline_rate_limit_exceeded`
`cardDeclined`	`card_declined`
`cardNotSupported`	`card_not_supported`
`cardVelocityExceeded`	`card_velocity_exceeded`
`complianceViolation`	`compliance_violation`
`currencyNotSupported`	`currency_not_supported`
`debitNotAuthorized`	`debit_not_authorized`
`doNotHonor`	`do_not_honor`
`duplicateTransaction`	`duplicate_transaction`
`emailInvalid`	`email_invalid`
`expiredCard`	`expired_card`
`expiredPaymentInformation`	`expired_payment_information`
`expiredPaymentMethod`	`expired_payment_method`
`genericDecline`	`generic_decline`
`incorrectAddress`	`incorrect_address`
`incorrectCvc`	`incorrect_cvc`
`incorrectNumber`	`incorrect_number`
`incorrectPostalCode`	`incorrect_postal_code`
`incorrectZip`	`incorrect_zip`
`insufficientFunds`	`insufficient_funds`
`invalidAccount`	`invalid_account`
`invalidAmount`	`invalid_amount`
`invalidBillingAgreement`	`invalid_billing_agreement`
`invalidCustomerAccount`	`invalid_customer_account`
`invalidCvc`	`invalid_cvc`
`invalidExpiryMonth`	`invalid_expiry_month`
`invalidExpiryYear`	`invalid_expiry_year`
`invalidNumber`	`invalid_number`
`invalidPaymentInformation`	`invalid_payment_information`
`issuerNotAvailable`	`issuer_not_available`
`mobileDeviceAuthenticationRequired`	`mobile_device_authentication_required`
`newAccountInformationAvailable`	`new_account_information_available`
`noActionTaken`	`no_action_taken`
`notPermitted`	`not_permitted`
`partnerGenericDecline`	`partner_generic_decline`
`partnerHighRiskCustomer`	`partner_high_risk_customer`
`paymentIntentAuthenticationFailure`	`payment_intent_authentication_failure`
`paymentIntentPaymentAttemptExpired`	`payment_intent_payment_attempt_expired`
`paymentIntentPaymentAttemptFailed`	`payment_intent_payment_attempt_failed`
`paymentLimitExceeded`	`payment_limit_exceeded`
`paymentMethodCustomerDecline`	`payment_method_customer_decline`
`paymentMethodNotAvailable`	`payment_method_not_available`
`paymentMethodProviderDecline`	`payment_method_provider_decline`
`paymentMethodProviderTimeout`	`payment_method_provider_timeout`
`pickupCard`	`pickup_card`
`postalCodeInvalid`	`postal_code_invalid`
`processingError`	`processing_error`
`recurringNotSupportedByBank`	`recurring_not_supported_by_bank`
`reenterTransaction`	`reenter_transaction`
`referToCustomer`	`refer_to_customer`
`restrictedCard`	`restricted_card`
`revocationOfAllAuthorizations`	`revocation_of_all_authorizations`
`revocationOfAuthorization`	`revocation_of_authorization`
`securityViolation`	`security_violation`
`serviceNotAllowed`	`service_not_allowed`
`stopPaymentOrder`	`stop_payment_order`
`testmodeDecline`	`testmode_decline`
`transactionNotAllowed`	`transaction_not_allowed`
`withdrawalCountLimitExceeded`	`withdrawal_count_limit_exceeded`

`payment.transactionSettings` - Transaktionseinstellungen (global)

Über den Knoten payment.transactionSettings werden die Aktionen festgelegt, die im Store-Backend für Zahlungen ausgeführt werden können, beispielsweise Rückzahlungen, Stornierungen, Aktualisierung des Status oder das Einziehen des Betrags. Für jeden Zahlungsanbieter wird konfiguriert, ob die jeweilige Aktion erlaubt ist und welche Eingaben dabei abgefragt werden. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/payment.transactionSettings (Deeplink-Übersicht)

Beispielkonfiguration

{
  "clearers": [
    {
      "name": "paypalCheckout",
      "options": [
        { "name": "refund",  "active": true,  "additionalFields": [
          { "name": "amount",  "type": "decimal", "required": true },
          { "name": "reason",  "type": "string",  "required": false }
        ]},
        { "name": "cancel",  "active": true,  "additionalFields": [] },
        { "name": "refresh", "active": true,  "additionalFields": [] },
        { "name": "capture", "active": false, "additionalFields": [] }
      ]
    },
    {
      "name": "stripe",
      "options": [
        { "name": "refund",  "active": true,  "additionalFields": [
          { "name": "amount",     "type": "decimal", "required": false },
          { "name": "reference",  "type": "string",  "required": false }
        ]},
        { "name": "cancel",  "active": true,  "additionalFields": [] },
        { "name": "refresh", "active": true,  "additionalFields": [] },
        { "name": "capture", "active": true,  "additionalFields": [
          { "name": "amount", "type": "decimal", "required": true }
        ]}
      ]
    }
  ]
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`clearers`	list (object)	Liste der angebundenen Zahlungsabwickler, für die Transaktionseinstellungen konfiguriert werden sollen.
`name`	string	Technischer Name des Providers, beispielsweise `paypalCheckout` oder `stripe`.
`options`	list (object)	Definiert pro Provider die erlaubten Aktionen und deren Eingabefelder.
`name`	enum	Mögliche Optionen: `refund`, `cancel`, `refresh`, `capture`
`active`	bool	Aktiviert / Deaktiviert die Aktion im Store Backend.
`name`	string	Feldname, beispielsweise `amount`.
`type`	string	Datentyp des Feldes, beispielsweise `string` oder `int`.
`required`	bool	Definiert, ob es ein Pflichtfeld für die Aktion ist.

`payment.*` - Validierungs- und Prüfservices

Die fest vorgegebenen Validierungs- und Prüfservices für den Knoten payment werden in Validations und Services verwendet. Eine Übersicht ist hier zu finden: Validierungs- und Prüfservices Die Online-Clearing-Services, auf die das Feld onlineClearing einer Zahlungsart verweist, beschreibt ebenfalls die Seite Validierungs- und Prüfservices.

​payment* - Grundstruktur

​Parameterbeschreibung

​payment.computopHosted - Computop Hosted Payments

​Beispielkonfiguration (payment.computopHosted.creditcard)

​Parameterbeschreibung

​payment.payment - Zahlungsarten anlegen

​Beispielkonfiguration (payment.payment.paypalCheckout)

​Parameterbeschreibung

​payment.paymentField - Zusatzfelder für Zahlungsarten

​Beispielkonfiguration (payment.paymentField.birthdatePayPal)

​Parameterbeschreibung

​Mehrere Felder mit demselben Namen

​Eingaben merken

​Zusatzfelder in den Bestelldaten

​Beispiel: PayPal Kauf auf Rechnung

​payment.payPalCheckout - PayPal Checkout Konfiguration

​Beispielkonfiguration

​Parameterbeschreibung

​payment.payPalCheckoutErrors - Fehlertexte zu abgelehnten PayPal-Zahlungen

​Parameterbeschreibung

​payment.payPalPlus - PayPal Plus Konfiguration

​payment.stripe - Stripe Konfiguration

​Beispielkonfiguration

​Parameterbeschreibung

​payment.stripeErrors - Fehlertexte zu abgelehnten Stripe-Zahlungen

​Parameterbeschreibung

​payment.transactionSettings - Transaktionseinstellungen (global)

​Beispielkonfiguration

​Parameterbeschreibung

​payment.* - Validierungs- und Prüfservices

`payment*` - Grundstruktur

Parameterbeschreibung

`payment.computopHosted` - Computop Hosted Payments

Beispielkonfiguration (`payment.computopHosted.creditcard`)

Parameterbeschreibung

`payment.payment` - Zahlungsarten anlegen

Beispielkonfiguration (`payment.payment.paypalCheckout`)

Parameterbeschreibung

`payment.paymentField` - Zusatzfelder für Zahlungsarten

Beispielkonfiguration (`payment.paymentField.birthdatePayPal`)

Parameterbeschreibung

Mehrere Felder mit demselben Namen

Eingaben merken

Zusatzfelder in den Bestelldaten

Beispiel: PayPal Kauf auf Rechnung

`payment.payPalCheckout` - PayPal Checkout Konfiguration

Beispielkonfiguration

Parameterbeschreibung

`payment.payPalCheckoutErrors` - Fehlertexte zu abgelehnten PayPal-Zahlungen

Parameterbeschreibung

`payment.payPalPlus` - PayPal Plus Konfiguration

`payment.stripe` - Stripe Konfiguration

Beispielkonfiguration

Parameterbeschreibung

`payment.stripeErrors` - Fehlertexte zu abgelehnten Stripe-Zahlungen

Parameterbeschreibung

`payment.transactionSettings` - Transaktionseinstellungen (global)

Beispielkonfiguration

Parameterbeschreibung

`payment.*` - Validierungs- und Prüfservices