Konfiguration

Machen Sie das Modul Stripe Payment für OXID für Ihren OXID eShop betriebsbereit.

Grundsätzliches Vorgehen

  1. Stellen Sie sicher, dass das Modul aktiviert ist.

  2. Ermöglichen Sie die Kommunikation mit Stripe:

    1. Verbinden Sie Ihren OXID eShop per OAuth mit Stripe.

    2. Legen Sie einen Webhook an, damit Stripe Statusmeldungen an Ihren OXID eShop senden kann.

  3. Konfigurieren Sie die von Stripe bereitgestellten Zahlungsmethoden als Zahlungsarten in Ihrem eShop:

    • Aktivieren Sie die Länder, die Sie abdecken wollen.

    • Verknüpfen Sie die Zahlungsarten mit Ihren Versandarten und Versandkostenregeln.

  4. Machen Sie Testzahlungen und passen Sie die Konfiguration an, bis alle Zahlungsprozesse nach Ihren Vorstellungen funktionieren.

  5. Um Stripe Payment für OXID im Live-Modus zu betreiben, wiederholen Sie den Prozess analog.

Stripe Payment aktivieren

Stellen Sie sicher, dass Stripe Payment für OXID in jedem Subshop aktiviert ist, in dem Sie das Modul nutzen wollen.

Vorgehen

  1. Wählen Sie Erweiterungen ‣ Module.

  2. Wählen Sie das Modul Stripe Payment.

  3. Wenn das Modul noch nicht aktiviert ist, wählen Sie Stamm ‣ Aktivieren.

Stripe Payment konfigurieren

Starten Sie das Konfigurieren.

Voraussetzungen

  • Sie haben Stripe Payment aktiviert.

Vorgehen

Wählen Sie Erweiterungen ‣ Module ‣ Stripe Payment ‣ Einstell..

Note

Bei Bedarf Cache leeren

Wenn die Konfigurationseinstellungen nicht korrekt angezeigt werden, leeren Sie den Cache.

Weitere Informationen finden Sie unter Installation im Schritt Cache leeren.

Grundkonfiguration einrichten

Verbinden Sie Stripe Payment mit Stripe.

Voraussetzungen

Vorgehen

  1. Melden Sie sich im Stripe Dashboard an (unter dashboard.stripe.com/dashboard).

  2. Wählen Sie im OXID eShop Admin-Bereich Erweiterungen ‣ Module ‣ Stripe Payment ‣ Einstell..

  3. Wählen Sie unter Grundkonfiguration im Feld Live oder Test API den Modus Test.

  4. Wählen Sie neben dem Feld Test API Key die Schaltfläche Verbinden mit .
    Sie werden aufgefordert, das Stripe-Konto zu wählen oder anzulegen, mit dem Sie Ihren OXID eShop verbinden wollen (Abb.: Stripe-Konto wählen).

    Stripe-Konto wählen

    Abb.: Stripe-Konto wählen

  5. Wählen Sie das gewünschte Konto und bestätigen Sie mit Connect (Abb.: Stripe-Konto wählen, Pos. 1).
    Das System bestätigt das Onboarding (Abb.: Onboarding bestätigt).

    Onboarding bestätigt

    Abb.: Onboarding bestätigt

  6. Wählen Sie die Schaltfläche Zum Admin-Bereich (Abb.: Onboarding bestätigt, Pos. 1).

  7. Wählen Sie Erweiterungen ‣ Module ‣ Stripe Payment ‣ Einstell..
    Unter Grundkonfiguration werden die Felder Test API Key und Test API Publishable Key automatisch ausgefüllt. Neben dem Feld Test API Key wird Verbindung erfolgreich angezeigt (Abb.: Grundkonfiguration nach erfolgreicher Verbindung).

    Grundkonfiguration nach erfolgreicher Verbindung

    Abb.: Grundkonfiguration nach erfolgreicher Verbindung

  8. Speichern Sie Ihre Eingaben.

Note

API-Schlüssel Konflikt

Wenn die Test- und Live-Schlüssel von unterschiedlichen Stripe-Konten stammen, zeigt das System eine Warnung an. Korrigieren Sie in diesem Fall die betroffenen Publishable Key-Felder manuell oder führen Sie die Verbindung erneut durch.

Weitere Grundeinstellungen konfigurieren

Konfigurieren Sie die weiteren Einstellungen unter Grundkonfiguration.

Vorgehen

  1. Wählen Sie unter Erfassungsmodus, wie Zahlungen verarbeitet werden sollen:

    • Automatisch (sofort erfassen): Der Betrag wird sofort erfasst, wenn der Kunde den Checkout abschließt.

    • Manuell (nur autorisieren, später erfassen): Die Zahlung wird nur autorisiert. Sie müssen die Zahlung innerhalb von 7 Tagen manuell auf der Bestell-Detailseite im Reiter Stripe erfassen.

  2. Optional: Aktivieren Sie das Kontrollkästchen Kunden-E-Mail-Adresse an Stripe senden, wenn Stripe Benachrichtigungen an die E-Mail-Adresse des Kunden senden soll (statt an die Stripe-Account-E-Mail-Adresse).

  3. Empfohlen: Lassen Sie die folgenden Kontrollkästchen aktiviert:

    • Ergebnisse von Transaktions-Verarbeitung loggen

    • Für Rechnungsland nicht unterstützte Zahlarten entfernen

    • Für Währung nicht unterstützte Zahlarten entfernen

  4. Speichern Sie Ihre Eingaben.

Bestellungen mit Stripe abgleichen

Gleichen Sie den Bezahlstatus Ihrer Bestellungen mit Stripe ab, um Bestellungen zu erkennen, die aufgrund fehlgeschlagener oder verzögerter Webhooks als unbezahlt erscheinen.

Hintergrund

In seltenen Fällen kann es vorkommen, dass eine Bestellung im OXID eShop als unbezahlt erscheint, obwohl der Kunde bei Stripe erfolgreich bezahlt hat. Ursache sind typischerweise fehlgeschlagene oder verzögerte Webhooks.

Für diesen Abgleich stellt Stripe Payment den Console-Command stripe:reconcile-oxpaid bereit.

Vorgehen

Richten Sie auf Ihrem Server einen Cronjob ein, der den Console-Command regelmäßig ausführt, z. B. täglich:

# Bestellungen der letzten 7 Tage abgleichen (Standard)
vendor/bin/oe-console stripe:reconcile-oxpaid

# Bestellungen der letzten 14 Tage abgleichen
vendor/bin/oe-console stripe:reconcile-oxpaid --max-age=14

# Testlauf ohne Änderungen (Vorschau)
vendor/bin/oe-console stripe:reconcile-oxpaid --dry-run

Resultat

Der Command prüft alle Bestellungen innerhalb des angegebenen Zeitraums, die im OXID eShop als unbezahlt markiert sind, und gleicht sie mit dem Zahlungsstatus bei Stripe ab. Erfolgreich bezahlte Bestellungen werden automatisch als bezahlt markiert.

Das Ergebnis wird in der Logdatei log/stripe/stripe_reconciliation_JJJJ-MM-TT.log protokolliert.

Webhook anlegen

Legen Sie einen Webhook an. Damit erlauben Sie es Stripe, Ihren OXID eShop zu kontaktieren und in Echtzeit Statusmeldungen beispielsweise über abgeschlossene Transaktionen zu liefern.

Voraussetzungen

  • Sie haben die Grundkonfiguration abgeschlossen (siehe Grundkonfiguration einrichten).

    Andernfalls erscheint die Fehlermeldung Ihr privater Stripe-Schlüssel wurde noch nicht konfiguriert.

Vorgehen

Wählen Sie unter Webhooks die Schaltfläche Webhooks erstellen und speichern Sie.

Resultat

Der Webhook-Endpunkt und der zugehörige Sicherheitsschlüssel werden automatisch konfiguriert.

Note

Webhook neu generieren

Falls der Webhook fehlerhaft konfiguriert ist, aktivieren Sie das Kontrollkästchen Aktualisierung der Webhooks erzwingen und speichern Sie erneut.

Testzahlungen ausführen

Um die Verbindung zu verifizieren, führen Sie Testzahlungen aus.

Testen Sie die mit Stripe Payment bereitgestellten Zahlungsarten.

Vorgehen

  1. Aktivieren Sie unter Shopeinstellungen ‣ Zahlungsarten die gewünschten Stripe-Zahlungsarten.

  2. Verifizieren Sie die Zuordnung der Zahlungsarten zu den Versandarten und Versandkostenregeln.

  3. Führen Sie eine Bestellung beispielsweise mit Stripe Kreditkarte als Zahlungsart aus und schließen Sie die Testzahlung ab (Abb.: Testzahlung mit Kreditkarte abschließen).

    Testzahlung mit Kreditkarte abschließen

    Abb.: Testzahlung mit Kreditkarte abschließen

  4. Um die Bestellung zu verifizieren, zeigen Sie unter Bestellungen verwalten ‣ Bestellungen ‣ <Bestellung> auf der Registerkarte Stripe die Zahlungsdetails an (Abb.: Zahlungsdetails der Testbestellung prüfen, Pos. 1).

    Zahlungsdetails der Testbestellung prüfen

    Abb.: Zahlungsdetails der Testbestellung prüfen

  5. Verifizieren Sie die Test-Bestellungen im Stripe-Dashboard unter Zahlungen (dashboard.stripe.com/test/payments, Abb.: Testbestellung im Stripe-Dashboard verifizieren).

    Testbestellung im Stripe-Dashboard verifizieren

    Abb.: Testbestellung im Stripe-Dashboard verifizieren

  6. Empfohlen: Prüfen Sie die Transaktionslogs unter <Root-Verzeichnis Ihres OXID eShops>/log/stripe/, z. B. stripe_requests_JJJJ-MM-TT.log.

  7. Optional: Prüfen Sie, ob Sie Ihre Zahlungsarten und Währungseinstellungen wie gewünscht konfiguriert haben.
    Erzeugen Sie dazu mögliche Fehlerfälle, die das System standardmäßig automatisch unterdrückt.

    1. Um diese möglichen Fehlerfälle zu erzeugen, deaktivieren Sie vorübergehend unter Grundkonfiguration die folgenden Kontrollkästchen:

      • Für Rechnungsland nicht unterstützte Zahlarten entfernen

      • Für Währung nicht unterstützte Zahlarten entfernen

    2. Prüfen Sie mit Testzahlungen, ob Fehler auftreten, und passen Sie Ihre Konfiguration bei Bedarf an.

    3. Empfohlen: Stellen Sie nach Ihren Tests sicher, dass die Kontrollkästchen wieder aktiviert sind.

  8. Optional: Deaktivieren Sie das Aufzeichnen von Transaktionslogs, wenn Ihnen das beispielsweise aus Gründen der Sicherheit oder der Datensparsamkeit nötig erscheinen sollte.
    Dazu deaktivieren Sie das Kontrollkästchen Ergebnisse von Transaktions-Verarbeitung loggen.

Länderzuordnung von Stripe-Zahlungsmethoden konfigurieren

Stellen Sie sicher, dass bestimmte Stripe Payment für OXID-Zahlungsmethoden ausschließlich in den von Ihnen gewünschten Ländern zur Verfügung stehen.

Hintergrund

Die meisten Stripe-Zahlungsmethoden decken mehrere Länder ab. Die Zahlungsmethode Kreditkarte beispielsweise ist Kunden weltweit zugänglich, die Zahlungsmethode iDeal steht Ihren Kunden beispielsweise in den Niederlanden zur Verfügung.

Weitere Informationen über die Länderabdeckung der einzelnen Stripe-Zahlungsmethoden finden Sie unter Marktabdeckung nach Zahlungsmethoden.

Grundsätzlich gilt dabei: Die Rechnungsadresse und nicht die Lieferadresse eines Kunden bestimmt, ob eine Stripe-Zahlungsmethode dem Kunden zur Auswahl steht.
Beispiel: Nur Kunden mit einer Rechnungsadresse in Polen erhalten die Zahlungsmethode Stripe Przelewy24 angeboten.

Vorgehen

Um die Zugänglichkeit einer Stripe-Zahlungsmethode auf bestimmte Länder einzuschränken, wählen Sie Shopeinstellungen ‣ Zahlungsarten ‣ <Zahlungsart> ‣ Länder ‣ Länder zuordnen.