Übersicht - Zahlungsarten

Grundprinzip

Jede Zahlungsart wird zunächst als eigener Konfigurationsknoten unter payment.payment.<ID> angelegt.

Die ID ist frei wählbar; es gibt keine fest vorgegebenen Bezeichnungen pro Zahlungsart. Dadurch können Zahlungsarten beispielsweise unter Knoten wie payment.payment.bill, payment.payment.applepay, payment.payment.googlepay oder payment.payment.paypal definiert werden.

In payment.payment werden unter anderem festgelegt, ob die Zahlungsart aktiv ist, welche Bezeichnung sie im Checkout trägt, welches Bild oder Icon verwendet wird und welche Regeln und Einschränkungen für ihre Verfügbarkeit gelten. Die offizielle Doku beschreibt payment.payment genau als den Bereich, in dem Zahlarten zusammengefasst und Eigenschaften wie active, id, name, image, validations sowie die Anbindung an Online-Clearing konfiguriert werden.

Typische Angaben einer Zahlungsart sind zum Beispiel:

• Aktiv-/Inaktiv-Schaltung
• Name und Beschreibung
• Bild oder Icon
• Zulässigkeit oder Ausschluss für bestimmte Länder
• Zulässigkeit oder Ausschluss für bestimmte Produkte oder Warenkörbe
• Zusätzliche Eingabefelder oder Prüfungen
• Art der Zahlungsabwicklung

Weitere Informationen zu den allgemeinen Konfigurationsmöglichkeiten einer Zahlungsart finden sich auf der Seite payment - Zahlungsmethoden.

---

Offline- und Online-Zahlungsarten

Für die Konfiguration ist zunächst wichtig, zwischen offline und online abgewickelten Zahlungsarten zu unterscheiden. Die Doku nennt für type ausdrücklich typische Werte wie offline für manuell abgewickelte Zahlungen und online für Zahlungen über einen Provider.

Offline-Zahlungsarten

Bei einer reinen Offline-Zahlungsart ist die Konfiguration mit payment.payment.<ID> im Regelfall abgeschlossen. Die Zahlungsart wird angelegt, benannt und im Checkout angeboten, ohne dass eine zusätzliche Provider-Anbindung erforderlich ist.

Ein typisches Beispiel dafür ist Vorauskasse. Hier reicht die Definition der Zahlart in payment.payment.prepayment, da keine Echtzeit-Kommunikation mit einem Zahlungsdienstleister notwendig ist.

Beispielkonfiguration payment.payment.prepayment

{
  "active": true,
  "basicCost": null,
  "description": "Text",
  "discount": 0,
  "displayedPaymentTypes": [],
  "freeFields": null,
  "id": "prepayment",
  "image": "",
  "labels": null,
  "name": "Vorauskasse",
  "onlineClearing": null,
  "orderText": "Text",
  "provider": "",
  "type": "",
  "validations": [ ]
}

Online-Zahlungsarten

Bei Online-Zahlungsarten wird die Zahlungsart ebenfalls zunächst unter payment.payment.<ID> angelegt. Die Zahlungsart selbst bleibt immer zunächst eine eigenständige Konfiguration unter payment.payment.ID.

Erst wenn sie online abgewickelt werden soll, kommt zusätzlich eine passende Online-Anbindung hinzu, in dem bei dem die Zahlungsart beim Parameter onlineClearing mit einem konkreten Provider verknüpft wird, z.B. payment.paypal-checkout

Beispielkonfiguration payment.payment.GooglePay

{
  "active": false,
  "basicCost": null,
  "description": "Text",
  "discount": 0,
  "displayedPaymentTypes": [],
  "freeFields": null,
  "id": "paypalCheckoutGooglePay",
  "image": "",
  "labels": null,
  "name": "GooglePay",
  "onlineClearing": {
    "options": {
      "type": "googlePay",
      "view": "paypal_checkout_pending.htm"
    },
    "service": "payment.paypal-checkout"
  },
  "orderText": "Text",
  "provider": "",
  "type": "",
  "validations": [ ]
}