Riverty Payments: Konfiguration
Riverty Payments für Sylius - Einstellungen pro Channel, API-Keys pro Land, Zahlarten anlegen, Vertrag prüfen, API-Log mit Aufbewahrung und Praxis-Beispiele
Riverty Payments: Konfiguration
Diese Dokumentation bezieht sich immer auf die aktuellste veröffentlichte Version.
Die Einstellungen findest du im Admin unter MMKreativ Plugins → Riverty Payments. Es gibt eine Einstellung pro Channel, nicht global. Die Liste zeigt je Channel die aktiven Länder, also die Länder, für die ein API-Key hinterlegt ist.
Einstellungen eines Channels
Die Seite besteht aus zwei Karten: der Karte Einstellungen und der Karte Länder und API-Keys.
Karte Einstellungen
| Einstellung | Standard | Beschreibung |
|---|---|---|
| Ausgabekanal | – | Der Channel, für den die Einstellung gilt. Nach dem Anlegen nicht mehr änderbar, weil die Transaktionen auf den Channel verweisen. Pro Channel gibt es genau eine Einstellung |
| Ratenkauf-Beispiel im Checkout anzeigen | aus | Zeigt unter der Ratenzahlung "ab X/Monat" und das Repräsentativbeispiel, siehe Storefront |
| Beim Versand automatisch erfassen (Capture) | aus | Erfasst offene Beträge bei Riverty, sobald die letzte Lieferung der Bestellung versendet ist, siehe Bestellverwaltung |
| Warnung vor Ablauf einer Autorisierung (Tage) | 5 | Vorlauf der Warnung vor dem Ende der Reservierung, 1 bis 25 Tage, siehe Abgleich und Ablauf |
| Bestellhistorie an Riverty senden | Nichts | Welche Angaben über frühere Bestellungen des Kunden an Riverty gehen, siehe Abschnitt Bestellhistorie an Riverty weiter unten |
Capture beim Versand ist standardmäßig aus, weil ein Capture Geld bewegt. Schalte die Option erst ein, wenn du den Ablauf in der Sandbox getestet hast.
Karte Länder und API-Keys
Für jedes unterstützte Land gibt es eine Zeile: Deutschland, Österreich, Schweiz, Niederlande, Belgien, Norwegen, Schweden, Dänemark und Finnland. Ein Land ohne Key bleibt inaktiv.
| Feld | Beschreibung |
|---|---|
| Sandbox-Modus | Schaltet das Land zwischen Test und Live um. Ist die Sandbox an, zählt der Test-Key, sonst der Live-Key |
| Test-API-Key | Key der Riverty-Sandbox |
| Live-API-Key | Key der Riverty-Produktion |
- Die Key-Felder sind nur schreibbar: Ein gespeicherter Key wird nie wieder angezeigt, das Feld zeigt nur Punkte als Hinweis, dass ein Key vorhanden ist. Lässt du das Feld leer, bleibt der gespeicherte Key unverändert.
- Ein Land ist aktiv, sobald der Key für seinen aktuellen Modus (Sandbox oder Live) gesetzt ist.
- Die Keys liegen verschlüsselt in der Datenbank. Der Schlüssel stammt aus
APP_SECRET, siehe die Warnung auf der Seite Installation.
Länder und Währungen
Riverty wird nur für Rechnungsländer angeboten, für die der Channel einen Key hat, und nur in der Währung, die Riverty dort akzeptiert.
| Land | Währung |
|---|---|
| Deutschland (DE), Österreich (AT), Niederlande (NL), Belgien (BE), Finnland (FI) | EUR |
| Schweiz (CH) | CHF |
| Norwegen (NO) | NOK |
| Schweden (SE) | SEK |
| Dänemark (DK) | DKK |
Pay in X gibt es nur in den Niederlanden.
Bestellhistorie an Riverty
Riverty bewertet eine Bestellung besser, wenn bekannt ist, dass der Kunde schon bei dir gekauft hat. Das kann die Quote angenommener Bestellungen erhöhen. Die Option Bestellhistorie an Riverty senden hat drei Stufen:
| Stufe | Was an Riverty geht |
|---|---|
| Nichts (Standard) | Keine Angaben zur Historie. Die IP-Adresse geht immer mit |
| Kunde ja oder nein | Ob der Kunde eine frühere erfolgreiche Bestellung hat |
| Volle Historie | Zusätzlich das Datum der ersten Bestellung, die Anzahl der Bestellungen und der Bestellwert der letzten zwölf Monate |
Die Bestellhistorie sind personenbezogene Daten. Kläre die Rechtsgrundlage und den Auftragsverarbeitungsvertrag, bevor du die Option einschaltest.
Als erfolgreiche Bestellung zählt eine Bestellung desselben Kunden im selben Channel, die abgeschlossen und nicht storniert ist und deren Zahlung durchgegangen ist (autorisiert, bezahlt oder danach teilweise oder ganz erstattet). Die aktuelle Bestellung zählt nicht mit. Bestellungen, die noch auf ihre Zahlung warten, etwa eine unbezahlte Überweisung oder ein abgebrochener Riverty-Versuch, zählen ebenfalls nicht, damit ein Fremder nicht wie ein Stammkunde aussieht. Bei einem Gast ordnet Sylius die früheren Bestellungen über die E-Mail-Adresse zu.
- Die Anzahl umfasst alle erfolgreichen Bestellungen, auch ältere als zwölf Monate.
- Der Bestellwert der letzten zwölf Monate summiert nur Bestellungen in der Währung der aktuellen Bestellung.
- Lässt sich die Historie nicht lesen, geht nichts an Riverty und die Bestellung wird nicht beeinträchtigt. Das Plugin schreibt dann eine Warnung ins Log, ohne Kundendaten.
Hinweise im Admin
Der Checkout blendet eine Zahlart lautlos aus, wenn eine Voraussetzung fehlt. Damit du den Grund nicht raten musst, zeigt der Admin über der Liste der Einstellungen und über dem Formular Hinweise: was Riverty aus dem Checkout fernhält und was als Nächstes zu tun ist. Fehlt beim Channel die Kontakt-E-Mail, warnt die Einstellungsseite, weil die Digest-Mail sie braucht.
Zahlarten und Vertrag
Oben auf der Bearbeitungsseite eines Channels stehen zwei Buttons.
Zahlarten anlegen
Legt die Riverty-Zahlarten für den Channel an: Rechnung, Lastschrift, Ratenzahlung und, wenn die Niederlande einen Key haben, Pay in X.
| Code | Zahlart |
|---|---|
RIVERTY_INVOICE |
Rechnung |
RIVERTY_DIRECT_DEBIT |
Lastschrift |
RIVERTY_INSTALLMENT |
Ratenzahlung (Fixed Instalments) |
RIVERTY_PAY_IN_X |
Pay in X, nur mit Key für die Niederlande |
Der Button ergänzt nur: Eine vorhandene Zahlart behält Namen, Aktiv-Schalter und ihre übrigen Channels und bekommt nur den Channel dazu, falls er fehlte. Ein erneuter Klick ändert nichts. Das Ergebnis erscheint als Meldungen: angelegt, schon vorhanden, Channel ergänzt, nicht anwendbar oder repariert.
Lege Riverty-Zahlarten nicht von Hand an. Sylius stellt neue Zahlarten auf das Payum-Modell, für Riverty gibt es aber keine Payum-Factory. Der Button schaltet das richtig und repariert eine Zahlart, bei der es von Hand falsch stand.
Eine von Hand angelegte oder bearbeitete Zahlart hat im Gateway-Formular genau ein Feld, die Riverty-Zahlungsart (Rechnungskauf, Lastschrift, Ratenkauf, Teilzahlung).
Riverty-Vertrag prüfen
Fragt bei Riverty ab, was dein Vertrag pro Land anbietet, und zeigt die Antwort als Meldungen. Der Button ist rein diagnostisch und ändert nichts. Die Antwort hängt vom Betrag ab (besonders bei Raten), deshalb ist es eine Stichprobe mit 100,00 in der Währung des jeweiligen Marktes. Fehlt eine erwartete Zahlart in der Antwort, wird sie genannt.
API-Log
Jeder Aufruf an Riverty wird protokolliert. Der Button Riverty API-Log auf der Seite Riverty Payments öffnet die Liste, neueste zuerst. Sie lässt sich eingrenzen:
| Filter | Werte |
|---|---|
| Zeitpunkt | Datum |
| Art | authorize, capture, void, refund, lookup, payment-methods, validate |
| Land | DE, AT, CH, NL, BE, NO, SE, DK, FI |
| Erfolgreich | ja oder nein |
| Bestellreferenz | Text |
Die Liste zeigt Zeitpunkt, Art, Land, Bestellreferenz, Antwort und Dauer, 25, 50 oder 100 Einträge pro Seite. Ein Klick zeigt Anfrage und Antwort vollständig, und die Riverty-Karte auf der Bestellseite verlinkt auf die Aufrufe dieser Bestellung. Nutze den Log, wenn Riverty eine Bestellung ablehnt und du genau sehen willst, was gesendet und geantwortet wurde.
- Personenbezogene Daten in den Inhalten (Name, Adresse, E-Mail, Telefon, Identifikationsnummer, Geburtsdatum) werden maskiert wie im Debug-Log. Der API-Key wird nie gespeichert. Inhalte über 64 KB werden abgeschnitten.
- Der Log wird über eine eigene Datenbankverbindung geschrieben: Ein Aufruf, der bei Riverty stattgefunden hat, bleibt im Log, auch wenn die Transaktion des Shops zurückgerollt wird. Ein Log, der nicht geschrieben werden kann, stoppt nie eine Zahlung.
- Die Seiten sind schreibgeschützt: Der Log lässt sich im Admin weder bearbeiten noch löschen.
Aufbewahrung
Einträge werden 30 Tage aufbewahrt. mmd:riverty:reconcile (der Cronjob) entfernt ältere. Die Zeit stellst du in einem Parameter deiner Anwendung ein, zum Beispiel in config/services.yaml:
parameters:
mmd_sylius_riverty_payments.api_log_retention_days: 14
mmd:riverty:reconcile --api-log-days=7 überschreibt den Wert für einen Lauf, --dry-run meldet nur, wie viele Einträge entfallen würden.
Praxis-Beispiele
Shop nur für Deutschland, erst in der Sandbox
- Einstellung für deinen Channel anlegen, bei Deutschland den Sandbox-Modus an lassen und den Test-Key eintragen.
- Zahlarten anlegen klicken: Rechnung, Lastschrift und Ratenzahlung entstehen.
- Riverty-Vertrag prüfen klicken und prüfen, ob alle drei Zahlarten für Deutschland gemeldet werden.
- Testbestellung im Storefront in EUR aufgeben.
- Zum Livegang den Live-Key eintragen und den Sandbox-Schalter ausschalten.
Deutschland und Niederlande
Trage Keys für Deutschland und die Niederlande ein und klicke Zahlarten anlegen: Zusätzlich zu den drei Zahlarten entsteht Pay in X. Pay in X erscheint nur bei Rechnungsadresse in den Niederlanden.
Automatische Erfassung beim Versand
Schalte Beim Versand automatisch erfassen (Capture) ein und trage in den Sylius-Channel-Einstellungen eine Kontakt-E-Mail ein. Versendest du die letzte Lieferung einer Bestellung, erfasst das Plugin alles, was bei Riverty noch offen ist. Schlägt das fehl, bleibt der Versand bestehen und der Grund steht auf der Riverty-Karte der Bestellung.