VibeFox EveryPay for PrestaShop — Hilfe

Anforderungen

PrestaShop: 8.0 bis 9.x.

PHP: 8.0 oder neuer. Das Modul lässt sich auf älteren PHP-Versionen nicht installieren.

EveryPay-Konto: Sie benötigen den API-Benutzernamen, das API-Secret und den Namen des Verarbeitungskontos Ihres Shops. Sie finden sie im EveryPay Merchant Portal in den Einstellungen Ihres Shops: im Demo-Portal für den Testmodus und im Live-Portal für echte Zahlungen. Test- und Live-Umgebung haben getrennte Zugangsdaten. Außerdem tragen Sie die Callback-URL Ihres Shops in beiden Portalen ein (siehe Konfiguration).

Shopwährung: Das Verarbeitungskonto legt die belastete Währung fest, zum Beispiel belastet EUR3D1 in EUR. Die Zahlungsart wird nur für Warenkörbe in dieser Währung angeboten.

VibeFox-Lizenzschlüssel: Erhältlich auf vibefox.net. Ein Schlüssel funktioniert nur auf einer Domain.

Installation

1. Gehen Sie im Back Office zu Modules > Module Manager und klicken Sie auf Upload a module. Wählen Sie die ZIP-Datei des Moduls.

2. Wenn der Upload abgeschlossen ist, klicken Sie auf Configure, oder suchen Sie VibeFox EveryPay Payment später in der Modulliste und klicken Sie dort auf Configure.

3. Fügen Sie Ihren VibeFox-Lizenzschlüssel in License key im Lizenzblock oben auf der Konfigurationsseite ein und klicken Sie auf Activate (siehe Lizenzschlüssel).

4. Geben Sie den Test-API-Benutzernamen, das Test-API-Secret und den Namen des Verarbeitungskontos aus dem Demo-Merchant-Portal ein. Lassen Sie Test Mode eingeschaltet.

5. Kopieren Sie die auf der Einstellungsseite angezeigte Callback-URL in die Callback notification URL Ihres Shops im Merchant Portal.

6. Schalten Sie Enable/Disable ein, klicken Sie auf Save und führen Sie eine Testbestellung durch. Wenn alles funktioniert, geben Sie die Live-Zugangsdaten ein, tragen die Callback-URL auch im Live-Portal ein und schalten Test Mode aus.

Bei der Installation legt das Modul den Bestellstatus EveryPay payment on hold an. PrestaShop bietet ein neues Zahlungsmodul für alle Währungen, Länder und Kundengruppen an. Sie können dies unter Payment > Preferences einschränken.

Konfiguration

Alle Einstellungen befinden sich auf der Modulseite: Modules > Module Manager > VibeFox EveryPay Payment > Configure. Jeder Abschnitt hat eine eigene Schaltfläche Save, die die gesamte Seite speichert. Über den Feldern zeigt die Seite Testmodus ist aktiv: Zahlungen gehen an die EveryPay-Demoumgebung, es wird kein echtes Geld belastet. an, solange der Testmodus aktiv ist. Sie wird gewarnt, wenn die Zahlungsart aktiviert ist, aber API-Benutzername, API-Secret oder Verarbeitungskonto des aktuellen Modus fehlen (die Zahlungsart wird dann an der Kasse ausgeblendet), und wenn das Verarbeitungskonto in einer anderen Währung als der Standardwährung des Shops belastet. Leerzeichen und Zeilenumbrüche, die zusammen mit den Zugangsdaten eingefügt wurden, werden beim Speichern entfernt.

EveryPay

Enable/Disable: Enable EveryPay payment gateway schaltet die Zahlungsart ein oder aus. Standard: off.

Title: der Name der Zahlungsart, den Kunden an der Kasse sehen. Er wird auch als Name der Zahlungsart in der Bestellung gespeichert. Standard: EveryPay.

Description: der Text, der unter der Zahlungsart an der Kasse angezeigt wird. Standard: Pay securely by card or bank link on the EveryPay payment page.

EveryPay-Konto

Der API-Benutzername, das API-Secret und der Name des Verarbeitungskontos werden im EveryPay Merchant Portal (Einstellungen des Shops) angezeigt: im Demo-Portal für den Testmodus und im Live-Portal für echte Zahlungen. Der Abschnitt enthält Links zu beiden Portalen.

Test Mode: Ist er eingeschaltet, gehen Zahlungen mit den Testzugangsdaten an die EveryPay-Demoumgebung. Es wird kein echtes Geld belastet. Standard: on. Solange er eingeschaltet ist, sehen Kunden unter der Zahlungsart TESTMODUS: EveryPay-Demoumgebung, es wird kein echtes Geld belastet.

Test API Username: der API-Benutzername der Demoumgebung.

Test API Secret: das API-Secret der Demoumgebung.

Live API Username: der API-Benutzername der Live-Umgebung.

Live API Secret: das API-Secret der Live-Umgebung.

Gespeicherte Secrets werden nie wieder angezeigt. Das Feld bleibt leer und zeigt Gespeichert — leer lassen, um es zu behalten. Geben Sie nur dann einen neuen Wert ein, wenn Sie ihn ändern möchten.

Clear saved API secrets: Aktivieren Sie ein Secret und klicken Sie auf Save, um es zu entfernen. Ein leeres Feld behält den gespeicherten Wert.

Processing Account Name: das EveryPay-Verarbeitungskonto, zum Beispiel EUR3D1. Das Konto legt die belastete Währung fest: Die Zahlungsart wird nur für Warenkörbe in dieser Währung angeboten. Derselbe Kontoname wird in beiden Modi verwendet.

Zahlungsbenachrichtigungen (Callback)

Der Callback teilt Ihrem Shop mit, dass eine Zahlung abgeschlossen ist, sodass Bestellungen auch dann angelegt werden, wenn der Kunde den Browser schließt. Kopieren Sie die URL, die unter Callback notification URL angezeigt wird, in die Callback notification URL Ihres Shops im EveryPay Merchant Portal, sowohl für die Demo- als auch für die Live-Umgebung. Mit sprechenden URLs sieht sie so aus: https://your-shop/module/wcp_everypay_payment/callback. Kopieren Sie die URL genau so, wie die Einstellungen sie anzeigen. Die Zahlungsanfrage enthält keine Callback-URL, daher muss sie im Portal eingetragen werden.

Der Callback enthält nur Zahlungsreferenzen. Wenn er eintrifft, fragt das Modul die EveryPay-API mit den Zugangsdaten der Umgebung, in der die Zahlung erstellt wurde, nach dem Zahlungsstatus und prüft, ob die Antwort zu diesem Warenkorb gehört. Callbacks für eine Zahlung, die Ihr Shop nicht erstellt hat, werden ohne Anfrage an EveryPay abgelehnt. Ohne Callback wird die Bestellung angelegt, wenn der Kunde nach der Zahlung zum Shop zurückkehrt, oder wenn EveryPay den Callback erneut sendet.

Erweitert

Debug log: protokolliert Zahlungsereignisse in logs/wc_evp_debug.log.php im Modulordner. Die Datei kann nicht über das Web geöffnet werden. Fehler und Warnungen werden immer protokolliert, auch wenn die Option ausgeschaltet ist. API-Secrets, Kartendaten und E-Mail-Adressen der Kunden werden nie protokolliert. Standard: off.

Log: zeigt die Größe und die neuesten Einträge des Protokolls. Klicken Sie auf Clear log, um es zu leeren.

Uninstall: löscht die Gateway-Einstellungen und Protokolle, wenn das Modul deinstalliert wird. Zahlungsdaten von EveryPay zu Bestellungen bleiben immer erhalten. Standard: off.

Kasse

Im Zahlungsschritt wählt der Kunde die Zahlungsart (standardmäßig EveryPay) und bestätigt. Das Modul erstellt eine einmalige EveryPay-Zahlung für den Warenkorbbetrag in der Warenkorbwährung mit der E-Mail-Adresse und der Rechnungsadresse des Kunden und leitet den Kunden zur EveryPay-Zahlungsseite weiter. Die Sprache der Seite richtet sich nach der Sprache des Shops (Englisch, Estnisch, Russisch, Lettisch, Litauisch, Finnisch oder Deutsch; sonst Englisch). Dort zahlt der Kunde mit einer der für Ihr EveryPay-Konto aktivierten Methoden. Zu diesem Zeitpunkt existiert noch keine Bestellung.

Nach der Zahlung kehrt der Kunde zu Ihrem Shop zurück. Die Bestellung wird erst als bezahlt markiert, wenn EveryPay die Zahlung bestätigt: Das Modul fragt bei der Rückkehr und beim Callback die EveryPay-API nach dem Status der Zahlung. Danach wird die Bestellung angelegt, und der Kunde sieht die übliche Bestellbestätigungsseite. Wenn EveryPay die Zahlung noch verarbeitet oder die API in diesem Moment nicht erreichbar ist, zeigt eine Seite Payment confirmation die Meldung Ihre Zahlung wird von EveryPay bestätigt. Sie erhalten eine E-Mail, sobald die Bestellung bestätigt ist. und eine Schaltfläche Check again; der Callback legt die Bestellung an, sobald EveryPay die Zahlung bestätigt.

Ist die Zahlung fehlgeschlagen, kehrt der Kunde zur Kasse zurück und sieht Ihre EveryPay-Zahlung war nicht erfolgreich. Bitte versuchen Sie es erneut oder wählen Sie eine andere Zahlungsart. Hat der Kunde die Zahlungsseite ohne Zahlung verlassen, lautet die Meldung Die EveryPay-Zahlung wurde nicht abgeschlossen. Sie können es erneut versuchen oder eine andere Zahlungsart wählen. Der Warenkorb bleibt erhalten. Jeder neue Versuch erstellt eine neue EveryPay-Zahlung; ältere Versuche werden berücksichtigt, sodass eine Zahlung über einen älteren Link trotzdem erkannt wird.

Kann EveryPay die Zahlung nicht starten, bleibt der Kunde an der Kasse mit einer kurzen Meldung, zum Beispiel EveryPay ist vorübergehend nicht verfügbar. Bitte versuchen Sie es in Kürze erneut oder wählen Sie eine andere Zahlungsart. Die Details stehen im Protokoll.

Der Callback funktioniert auch, wenn der Shop im Wartungsmodus ist, und wird nicht durch die Ländereinschränkung Ihres Shops blockiert.

Das Modul unterstützt nur einmalige Zahlungen. Es bietet keine Erstattungen oder Erfassungen aus PrestaShop, keine gespeicherten Karten oder Ein-Klick-Zahlungen, keine Abonnements oder wiederkehrenden Zahlungen, keine eingebetteten Kartenfelder und keine Mehrwährungsunterstützung.

Bestellungen

Bestellstatus

No order yet: Der Kunde wurde zu EveryPay weitergeleitet und hat nicht bezahlt, die Zahlung ist fehlgeschlagen oder wurde abgebrochen, oder EveryPay hat die Zahlung noch nicht bestätigt. Es existiert nur der Warenkorb.

Payment accepted: EveryPay hat die Zahlung als abgerechnet oder autorisiert gemeldet. Die Zahlung wird mit der EveryPay-Zahlungsreferenz als Transaktions-ID erfasst, und eine Notiz zeigt Betrag, Währung und Referenz. Bei einer autorisierten Zahlung weist die Notiz darauf hin, dass die Mittel reserviert sind: Wenn Ihr Konto nicht automatisch erfasst, erfassen Sie die Zahlung im EveryPay Merchant Portal. Wird sie später abgerechnet, weist eine weitere Notiz darauf hin.

EveryPay payment on hold: Die Zahlung muss manuell geprüft werden. Der gezahlte Betrag oder die Währung weicht vom Warenkorb ab (zum Beispiel wurde der Warenkorb nach Beginn der Zahlung geändert), die Bestellung war vor Eingang der Zahlung storniert worden, oder die Bestellung verwendet jetzt eine andere Zahlungsart. Die Notiz erklärt dies und besagt, dass die Bestellung nicht als bezahlt markiert wurde. Prüfen Sie die Zahlung im Merchant Portal und liefern Sie aus oder erstatten Sie manuell. Spätere Callbacks für diese Zahlung schließen die Bestellung nicht automatisch ab.

Wird eine zweite Zahlung für eine bereits bezahlte Bestellung abgeschlossen, bleibt die Bestellung unverändert. Eine Notiz bittet Sie, die doppelte Zahlung im EveryPay Merchant Portal zu erstatten.

EveryPay-Zahlungsblock

Die Bestellseite zeigt einen Block EveryPay payment mit allen EveryPay-Zahlungsversuchen der Bestellung: Datum, Zahlungsreferenz (mit einem Abzeichen Test mode für Testzahlungen), Bestellreferenz, Betrag, EveryPay-Status und Ergebnis. Darunter stehen die EveryPay notes der Bestellung, neueste zuerst.

Check EveryPay payment status: Die Schaltfläche im Block prüft jede EveryPay-Zahlung der Bestellung über die API, neueste zuerst, wendet das Ergebnis wie oben beschrieben an und fügt eine Notiz mit dem Status jeder Zahlung hinzu. Das Ergebnis wird im Block angezeigt. Sie benötigen das Recht, Bestellungen zu bearbeiten; der Zugriff auf die Modulseiten ist nicht nötig. Verwenden Sie die Schaltfläche, wenn ein Callback nie eingegangen ist, zum Beispiel um eine spätere Erfassung oder Erstattung zu sehen.

Erstattungen

Erstattungen aus PrestaShop werden nicht unterstützt. Erstatten Sie im EveryPay Merchant Portal und aktualisieren Sie danach den Bestellstatus in PrestaShop. Meldet EveryPay eine Zahlung als erstattet oder zurückgebucht, fügt das Modul nur eine Notiz zur Bestellung hinzu; der Bestellstatus wird nicht geändert. Die Standard-Erstattungsschaltflächen von PrestaShop auf der Bestellseite senden kein Geld über EveryPay zurück.

Lizenzschlüssel

Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox EveryPay Payment ist der erste Block auf Modules > Module Manager > VibeFox EveryPay Payment > Configure, oberhalb der Einstellungen. Fügen Sie den Schlüssel in License key ein und klicken Sie auf Activate. Danach zeigt der Block den maskierten Schlüssel, den Status (zum Beispiel das Datum, bis zu dem die Lizenz gültig ist, und Ihre Domain) sowie die Schaltflächen Check now, um den Status erneut zu prüfen, Change key, um einen anderen Schlüssel einzugeben, und Remove key, um den Schlüssel aus diesem Shop zu entfernen. Darunter stehen die Zeile Product: presta-payment-everypay und der Link Manage licenses and domains in your account, der Ihr vibefox.net-Konto öffnet. Nur Mitarbeiter mit der Berechtigung Configure für das Modul können den Schlüssel ändern. Die Texte des Blocks folgen der Sprache des Back Office (Englisch und Russisch sind enthalten).

Ist der Schlüssel nicht gültig, zeigt der Block den Grund an, zum Beispiel Key not found, This key belongs to another product, Domain limit reached oder License expired on mit einem Datum. Nach einer Änderung der Shop-Adresse oder nachdem Sie einen Domain-Platz in Ihrem vibefox.net-Konto freigegeben haben, klicken Sie auf Check now. Ist der Lizenzserver nicht erreichbar, arbeitet das Modul mit dem zuletzt bekannten Status weiter.

Ein Schlüssel funktioniert auf einer Domain: der Domain des Hauptshops, auch bei einem Multistore-Setup. Das Entfernen des Schlüssels aus dem Shop gibt seinen Domain-Platz nicht frei. Geben Sie den Platz in Ihrem vibefox.net-Konto frei.

Ohne aktiven Schlüssel wird EveryPay Kunden an der Kasse nicht angezeigt. Versucht ein Kunde trotzdem eine Zahlung, sieht er Diese Zahlungsart ist nicht verfügbar. Bitte wählen Sie eine andere. Der PrestaShop-Storefront weiß nicht, dass Sie im Back Office angemeldet sind, daher ist die Zahlungsart auch für Sie ausgeblendet: Sie können das Modul vor dem Kauf eines Schlüssels einrichten, aber nicht an der Kasse testen. Eine Erinnerung erscheint unter Modules > Module Manager auf dem Reiter Alerts. Bestehende Bestellungen sind nicht betroffen: Bereits gestartete Zahlungen werden weiterhin bestätigt, und die Statusprüfung funktioniert.

Läuft eine Lizenz ab, arbeitet das Modul weiter, aber Updates und Support erfordern eine Verlängerung. Der Status wird bei der Arbeit im Back Office automatisch erneut geprüft: einmal täglich in den ersten 14 Tagen nach der Eingabe des Schlüssels, danach einmal pro Woche. Ein Cron-Job ist nicht nötig. Das Deinstallieren oder Zurücksetzen des Moduls entfernt immer den Lizenzschlüssel und den Lizenzstatus.

Fehlerbehebung

EveryPay erscheint nicht an der Kasse: Prüfen Sie, ob die Lizenz aktiv ist, Enable/Disable eingeschaltet ist, API-Benutzername, API-Secret und Processing Account Name des aktuellen Modus gesetzt sind und die Warenkorbwährung die Währung des Verarbeitungskontos ist. In diesen Fällen zeigt die Einstellungsseite eine Warnung. Prüfen Sie unter Payment > Preferences, ob das Modul für die Warenkorbwährung, das Land des Kunden und die Kundengruppe erlaubt ist.

Die Zahlung war erfolgreich, aber es wurde keine Bestellung angelegt: Der Callback funktioniert nicht. Prüfen Sie, ob die Callback-URL aus den Einstellungen als Callback notification URL im Merchant Portal des verwendeten Modus (Demo oder Live) eingetragen ist. Die Bestellung wird auch angelegt, wenn der Kunde nach der Zahlung zum Shop zurückkehrt. Sehen Sie im Feld Log auf der Modulseite nach: Fehler werden immer protokolliert.

Der Callback antwortet Unknown payment, Unknown payment reference oder Payment does not belong to this order: Die Zahlung wurde nicht von diesem Shop oder diesem Warenkorb erstellt, oder die Antwort von EveryPay passt nicht dazu. Es wird nichts geändert.

Der Callback antwortet Not configured: Die Zugangsdaten der Umgebung, in der die Zahlung erstellt wurde, fehlen, zum Beispiel bei einer Testzahlung, nachdem die Testzugangsdaten entfernt wurden. Geben Sie sie erneut ein; EveryPay wiederholt den Callback.

Der Callback antwortet Payment status unavailable, Busy, please retry oder Order could not be created: Die EveryPay-API war nicht erreichbar, eine andere Anfrage hat die Bestellung im selben Moment angelegt, oder die Bestellung konnte nicht angelegt werden (zum Beispiel weil das Modul deaktiviert ist). EveryPay wiederholt den Callback. Der Grund steht im Protokoll.

Der Kunde sieht „EveryPay ist vorübergehend nicht verfügbar“: EveryPay hat die Zugangsdaten abgelehnt oder war nicht erreichbar. Prüfen Sie API-Benutzername und API-Secret des aktuellen Modus.

Der Kunde sieht „Diese Zahlungsart unterstützt die Bestellwährung nicht“: Die Warenkorbwährung unterscheidet sich von der Währung des Verarbeitungskontos.

Der Kunde bleibt auf der Seite Payment confirmation: EveryPay hat die Zahlung noch nicht abgeschlossen. Die Bestellung wird durch den Callback angelegt oder wenn der Kunde auf Check again klickt, nachdem EveryPay die Zahlung bestätigt hat.

Bestellung ist EveryPay payment on hold: Lesen Sie die EveryPay notes im Bestellblock. Betrag oder Währung wichen ab, oder die Bestellung war vor Eingang der Zahlung storniert worden. Prüfen Sie die Zahlung im Merchant Portal und liefern Sie aus oder erstatten Sie manuell.

Für Entwickler listet die README des Moduls die Hooks actionWcpEverypayOneoffRequest (Zahlungsanfrage ändern) und actionWcpEverypayLocale (Sprache der Zahlungsseite ändern) auf.

Deinstallation

Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox EveryPay Payment und wählen Sie Uninstall. Der Lizenzschlüssel und der Lizenzstatus dieses Moduls werden immer entfernt. Ist Uninstall (Gateway-Einstellungen und Protokolle löschen) in den Einstellungen aktiv, werden die Gateway-Einstellungen und das Protokoll entfernt. Ist die Option aus, bleiben alle Einstellungen für eine spätere Neuinstallation erhalten. Die EveryPay-Zahlungsdaten der Bestellungen und der Bestellstatus EveryPay payment on hold bleiben immer erhalten. Bestehende Bestellungen behalten ihre Zahlungsnotizen und Transaktions-IDs.

EveryPay ist eine Marke ihres jeweiligen Inhabers. Dieses Modul ist nicht mit EveryPay verbunden und wird nicht von EveryPay unterstützt.