VibeFox eWAY for PrestaShop — Hilfe
Voraussetzungen
PrestaShop: 8.0 bis 9.x.
PHP: 8.0 oder neuer. Das Modul verweigert die Installation auf älteren PHP-Versionen.
Shopwährung: AUD, NZD, SGD, HKD oder MYR. Bei anderen Warenkorbwährungen wird die Zahlungsart an der Kasse ausgeblendet. Die Zahlung wird in der Warenkorbwährung eingezogen.
eWAY-Konto: Sie benötigen ein eWAY-Händlerkonto mit Zugang zur Rapid API sowie dessen Rapid-API-Schlüssel und Passwort, die Sie in MyeWAY unter Settings, API Key finden. Zum Testen benötigen Sie ein eWAY-Sandbox-Konto mit eigenem Schlüssel und Passwort. Sandbox- und Live-Schlüssel sind verschieden. In eWAY muss nichts eingerichtet werden: Die Rückkehr-URL wird mit jeder Zahlung übermittelt.
VibeFox-Lizenzschlüssel: wird auf vibefox.net gekauft. Ein Schlüssel funktioniert 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 später VibeFox eWAY Payment Gateway in der Modulliste und klicken Sie auf Configure.
3. Fügen Sie Ihren VibeFox-Lizenzschlüssel in License key im Lizenzblock oben auf der Seite Configure ein und klicken Sie auf Activate (siehe Lizenzschlüssel).
4. Geben Sie Ihren Sandbox-API-Schlüssel und das Passwort ein, lassen Sie Sandbox Mode eingeschaltet, schalten Sie Enable/Disable ein, klicken Sie auf Save und legen Sie eine Testbestellung an.
5. Geben Sie Ihren Live-API-Schlüssel und das Passwort ein, schalten Sie Sandbox Mode aus und klicken Sie auf Save.
6. Optional können Sie die auf der Seite Configure angezeigte Cron-URL zu den Cron-Jobs Ihres Servers hinzufügen (siehe Konfiguration).
Bei der Installation legt das Modul den Bestellstatus eWAY 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 eWAY Payment Gateway > Configure. Jeder Abschnitt hat eine eigene Schaltfläche Save, die die ganze Seite speichert. Oberhalb der Felder zeigt ein Hinweis den Modus an: SANDBOX — payments go to the eWAY sandbox, no real money is charged. oder LIVE — real payments are taken with the live API key. Die Seite warnt Sie, wenn API-Schlüssel und Passwort des aktuellen Modus fehlen (die Zahlungsart wird dann an der Kasse nicht angezeigt), und wenn die Standardwährung des Shops von eWAY nicht unterstützt wird.
eWAY
Enable/Disable: Enable eWAY Payment Gateway schaltet die Zahlungsart ein oder aus. Standard: aus.
Title: der Name der Zahlungsart, den Kunden an der Kasse sehen. Er wird auch als Name der Zahlungsart in der Bestellung gespeichert. Standard: Credit Card (eWAY). Pflichtfeld.
Description: der Text, der an der Kasse unter der Zahlungsart angezeigt wird. Standard: Pay securely using your credit card via eWAY. You will be redirected to the eWAY secure payment page.
API-Zugangsdaten
Rapid-API-Schlüssel und Passwort finden Sie in MyeWAY unter Settings, API Key. eWAY stellt Anleitungen für Live- und Sandbox-Schlüssel bereit, die in diesem Abschnitt verlinkt sind. Sandbox und Live verwenden unterschiedliche Schlüssel.
Sandbox Mode: Zahlungen gehen an die eWAY-Sandbox mit dem Sandbox-Schlüssel und -Passwort. Es wird kein echtes Geld eingezogen. Standard: ein. Schalten Sie es aus, um Live-Zahlungen mit dem Live-Schlüssel anzunehmen. Solange es eingeschaltet ist, sehen Kunden Test mode: no real payment is taken. unter der Zahlungsart.
Live API Key: der Rapid-API-Schlüssel Ihres eWAY-Live-Kontos.
Live API Password: das Rapid-API-Passwort Ihres eWAY-Live-Kontos.
Sandbox API Key: der Rapid-API-Schlüssel Ihres eWAY-Sandbox-Kontos (Partner-/Entwicklerkonto).
Sandbox API Password: das Rapid-API-Passwort Ihres eWAY-Sandbox-Kontos.
Gespeicherte Schlüssel und Passwörter werden nie wieder angezeigt. Das Feld bleibt leer und zeigt Saved — leave empty to keep it. Geben Sie nur dann einen neuen Wert ein, wenn Sie ihn ändern möchten.
Clear saved credentials: Markieren Sie einen Schlüssel oder ein Passwort und klicken Sie auf Save, um es zu entfernen. Ein leeres Feld behält den gespeicherten Wert.
Return URL / re-checks: In eWAY muss kein Webhook und keine Rückkehr-URL konfiguriert werden, da die Rückkehr-URL mit jeder Zahlung übermittelt wird. Dieses Feld zeigt eine optionale Cron-URL. Rufen Sie sie über einen Cron-Job auf Ihrem Server auf, zum Beispiel alle 15 Minuten. Wenn ein Kunde zahlt und den Browser schließt, bevor er zum Shop zurückkehrt, wird die Zahlung etwa eine Stunde später bei eWAY abgefragt und die Bestellung angelegt. Ist eWAY nicht erreichbar, wird die Prüfung bis zu dreimal wiederholt. Halten Sie diese URL geheim: Sie enthält einen Token, und ein Aufruf mit falschem Token wird mit Forbidden beantwortet.
Bestellungen
Order Status on Success: der Bestellstatus, sobald eWAY die Zahlung bestätigt.
Ein genehmigter Betrag oder eine genehmigte Währung, die nicht zur Bestellung passt, wird immer auf eWAY payment on hold gesetzt.
Erweitert
Debug log: schreibt API-Aufrufe und Zahlungsergebnisse in logs/eway_p_debug.log.php im Modulordner. Die Datei kann nicht über das Web geöffnet werden. Kartendaten, Schlüssel, Passwörter, Kunden-E-Mails und Zugriffscodes werden nicht protokolliert. Fehler werden immer protokolliert. Standard: aus.
Log: zeigt die Größe und die neuesten Einträge des Protokolls. Klicken Sie auf Clear log, um es zu leeren.
Delete all plugin data on uninstall: ist dies eingeschaltet, entfernt die Deinstallation des Moduls die Gateway-Einstellungen und das Protokoll. Die eWAY-Zahlungsdaten der Bestellungen und der Bestellstatus eWAY payment on hold bleiben immer erhalten. Standard: aus.
Kasse
Im Zahlungsschritt wählt der Kunde die Zahlungsart (standardmäßig Credit Card (eWAY)) und bestätigt. Das Modul fragt bei eWAY eine Zahlungsseite für den Gesamtbetrag des Warenkorbs in der Warenkorbwährung an, mit PS- und der Warenkorb-Nummer als Rechnungsreferenz sowie der Rechnungsadresse und der E-Mail-Adresse des Kunden, und leitet den Kunden zur eWAY Responsive Shared Page weiter. Dort zahlt der Kunde mit Karte. Der Betrag wird sofort eingezogen. Zu diesem Zeitpunkt existiert noch keine Bestellung.
Nach der Zahlung kehrt der Kunde zu Ihrem Shop zurück. Das Modul vertraut dem Browser nicht: Es fragt bei eWAY serverseitig das Ergebnis der Zahlungsseite ab, die dieser Warenkorb erstellt hat. Die Bestellung wird erst als bezahlt markiert, wenn eWAY es bestätigt und der genehmigte Betrag sowie die Währung mit dem Warenkorb übereinstimmen. Danach wird die Bestellung angelegt, und der Kunde sieht die Standard-Bestätigungsseite mit Your payment with eWAY has been received. Bei einer Bestellung in Prüfung zeigt die Seite Your payment was received and is being reviewed by the store. We will contact you if anything is needed.
Kann eWAY in diesem Moment nicht abgefragt werden, zeigt eine Seite Payment confirmation die Meldung We have not received the confirmation of your payment from eWAY yet. If you completed the payment, this order will be updated shortly — please do not pay again., mit einer Schaltfläche Check again und einer Schaltfläche Back to checkout. Die Bestellung wird angelegt, wenn der Kunde erneut prüft oder wenn die Cron-URL ausgeführt wird.
Wird die Zahlung abgelehnt, kehrt der Kunde mit dem Grund zur Kasse zurück, zum Beispiel Your payment was declined: D4451 Insufficient funds. Please try again or use a different payment method. Klickt der Kunde auf der eWAY-Seite auf Abbrechen, prüft das Modul zuerst bei eWAY, dass nichts bezahlt wurde (etwa in einem anderen Tab). Der Kunde sieht dann You cancelled the payment on the eWAY page. Your order has not been paid — you can try again. Wurde die Zahlung nicht abgeschlossen, lautet die Meldung The payment was not completed. Please try again. Der Warenkorb bleibt in allen Fällen erhalten.
Der Kunde kann es erneut versuchen. Bevor eine neue Zahlungsseite erstellt wird, wird die vorherige Seite des Warenkorbs bei eWAY geprüft. Ist sie bereits bezahlt, wird die Bestellung angelegt, statt eine zweite Zahlung zu verarbeiten. Kann eWAY die Zahlungsseite nicht erstellen, bleibt der Kunde an der Kasse mit einer kurzen Meldung, zum Beispiel Payment error: Unable to connect to eWAY. Please try again. oder eWAY could not start the payment mit den eWAY-Fehlercodes.
eWAY sendet für die Shared Page keine serverseitigen Benachrichtigungen: Das Ergebnis wird bei der Rückkehr des Kunden und über die Cron-URL abgerufen. Das Modul hat keine Kartenfelder auf Ihrer Website, keine gespeicherten Karten oder Abonnements, keine reine Autorisierung und Erfassung und bewertet keine Beagle-Fraud-Scores (Transaktionen, die durch die Betrugsregeln von eWAY blockiert werden, lehnt eWAY selbst ab).
Bestellungen und Erstattungen
Bestellstatus
No order yet: der Kunde wurde zu eWAY weitergeleitet und hat nicht bezahlt, abgebrochen, die Zahlung wurde abgelehnt oder das Ergebnis konnte noch nicht abgerufen werden. Es existiert nur der Warenkorb.
Payment accepted or Delivered: die Zahlung wurde genehmigt. Der Status folgt Order Status on Success. Die Zahlung wird mit der Transaktions-ID von eWAY erfasst, und eine Notiz zeigt die Transaktions-ID, den Autorisierungscode, die Antwort und den Modus (Sandbox oder Live).
eWAY payment on hold: eWAY hat einen anderen Betrag oder eine andere Währung als der Warenkorb genehmigt (zum Beispiel Approved for partial amount, oder der Warenkorb wurde geändert, nachdem der Kunde die Zahlungsseite geöffnet hatte), die Zahlung wurde genehmigt, nachdem der Kunde sie auf der eWAY-Seite abgebrochen hatte, oder sie wurde genehmigt, nachdem die Bestellung storniert worden war. Die Zahlung wird mit dem von eWAY eingezogenen Betrag erfasst, und die Notiz erklärt dies. Prüfen Sie die Bestellung und bearbeiten Sie sie oder erstatten Sie die Zahlung.
Refunded: die Zahlung wurde über das Modul vollständig erstattet.
Wird eine zweite Zahlung für einen bereits bezahlten Warenkorb genehmigt, bleibt die Bestellung unverändert. Eine Notiz fordert Sie auf, das Duplikat in MyeWAY zu erstatten. Eine genehmigte Zahlung für eine andere Rechnungsreferenz wird nie der Bestellung zugeordnet.
eWAY-Zahlungsblock
Die Bestellseite zeigt einen Block eWAY payment mit Transaktions-ID, Autorisierungscode, eWAY-Antwort, Status, Modus und Rechnungsreferenz, dem bezahlten und erstatteten Betrag, einem Badge Sandbox für Sandbox-Zahlungen, dem Erstattungsverlauf und den eWAY notes der Bestellung.
Erstattungen
Geben Sie im Block eWAY payment den Betrag ein (der noch nicht erstattete Betrag ist vorausgefüllt), optional einen Grund, und klicken Sie auf Refund via eWAY. Bestätigen Sie die Frage Refund this amount through eWAY? This cannot be undone. Vollständige und teilweise Erstattungen werden unterstützt. Sie benötigen das Recht, Bestellungen zu bearbeiten; der Zugriff auf die Modulseiten ist nicht nötig. Erstattungen erfolgen in dem Betrag und in der Währung, die eWAY eingezogen hat. Nach einer Genehmigung über einen Teilbetrag können Sie daher bis zu dem Betrag erstatten, den der Kunde tatsächlich bezahlt hat, und nicht bis zur Bestellsumme. Die Erstattung wird in der Umgebung gesendet, in der die Zahlung erfolgte (Sandbox oder Live), daher müssen API-Schlüssel und Passwort dieser Umgebung gesetzt sein. Lehnt eWAY die Erstattung ab, zeigt der Block eWAY refund failed: mit den eWAY-Codes, und es wird keine Erstattung erfasst. Eine erfolgreiche Erstattung wird dem Erstattungsverlauf und den Notizen mit der Transaktions-ID der eWAY-Erstattung hinzugefügt. Eine vollständige Erstattung setzt die Bestellung auf Refunded. Eine teilweise Erstattung ändert den Status nicht. Erstattungen sind verfügbar, sobald eWAY die Zahlung genehmigt hat.
Das Modul erstellt keine Gutschriften (credit slips). Die Standard-Erstattungsbuttons von PrestaShop auf der Bestellseite senden kein Geld über eWAY zurück. In MyeWAY vorgenommene Erstattungen werden nicht mit PrestaShop synchronisiert. Aktualisieren Sie die Bestellung bei Bedarf manuell.
Lizenzschlüssel
Das Modul arbeitet mit einem VibeFox-Lizenzschlüssel von vibefox.net. Der Lizenzblock License — VibeFox eWAY Payment Gateway ist der erste Block auf Modules > Module Manager > VibeFox eWAY Payment Gateway > 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-eway 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 eWAY 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 Erstattungen funktionieren.
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
eWAY does not appear at checkout: prüfen Sie, ob die Lizenz aktiv ist, Enable/Disable eingeschaltet ist, API-Schlüssel und Passwort des aktuellen Modus gesetzt sind (Sandbox-Felder im Sandbox-Modus, Live-Felder im Live-Modus) und die Warenkorbwährung AUD, NZD, SGD, HKD oder MYR ist. Die Einstellungsseite zeigt eine Warnung, wenn Zugangsdaten fehlen. Prüfen Sie unter Payment > Preferences, ob das Modul für die Warenkorbwährung, das Land des Kunden und die Kundengruppe erlaubt ist.
The payment went through, but no order was created: der Kunde ist nicht von eWAY zurückgekehrt oder eWAY konnte in diesem Moment nicht abgefragt werden. eWAY sendet keine Benachrichtigungen für die Shared Page. Richten Sie die Cron-URL aus Return URL / re-checks ein: Sie übernimmt die Zahlung etwa eine Stunde später. Prüfen Sie die Transaktion in MyeWAY und sehen Sie sich das Feld Log auf der Modulseite an.
The customer sees This payment method is temporarily unavailable: API-Schlüssel oder Passwort des aktuellen Modus fehlen, oder eWAY hat sie abgelehnt. Prüfen Sie die Zugangsdaten des aktuellen Modus.
The customer sees eWAY could not start the payment: eWAY hat Fehlercodes zurückgegeben, die in der Meldung angezeigt werden. Oft sind die Rechnungsdaten ungültig.
The customer sees We could not match this payment to an order: der Rückkehr-Link gehört zu keinem Warenkorb dieses Shops, oder eWAY hat eine Zahlung für eine andere Rechnungsreferenz genehmigt. Wurde der Kunde belastet, suchen Sie die Zahlung in MyeWAY.
The customer sees We could not check the status of your previous payment attempt: eine andere Anfrage verarbeitete denselben Warenkorb. Der Kunde kann es in einem Moment erneut versuchen.
Order is eWAY payment on hold after payment: lesen Sie die eWAY notes im Block eWAY payment (siehe Bestellstatus) und bearbeiten Sie dann die Bestellung oder erstatten Sie die Zahlung.
Refund fails with a message about the sandbox or live mode: die Bestellung wurde in dieser Umgebung bezahlt, und ihr API-Schlüssel und Passwort sind nicht gesetzt. Geben Sie sie ein und versuchen Sie es erneut.
Refund fails with at most … can be refunded: der Betrag ist höher als der von eWAY eingezogene Betrag abzüglich der bereits erfolgten Erstattungen.
Für Entwickler: Die README des Moduls nennt den Hook actionWcpEwaySupportedCurrencies, falls Ihr eWAY-Konto für weitere Währungen freigeschaltet ist.
Deinstallation
Gehen Sie zu Modules > Module Manager, öffnen Sie das Menü neben VibeFox eWAY Payment Gateway und wählen Sie Uninstall. Der Lizenzschlüssel und der Lizenzstatus dieses Moduls werden immer entfernt. Ist Delete all plugin data on uninstall eingeschaltet, werden die Gateway-Einstellungen und das Protokoll entfernt. Ist es ausgeschaltet, bleiben alle Einstellungen für eine spätere Neuinstallation erhalten. Die eWAY-Zahlungsdaten der Bestellungen und der Bestellstatus eWAY payment on hold bleiben immer erhalten, sodass zuvor bezahlte Bestellungen auch nach einer Neuinstallation erstattet werden können. Bestehende Bestellungen behalten ihre Zahlungsnotizen und Transaktions-IDs.
eWAY ist eine Marke ihres jeweiligen Inhabers. Dieses Modul ist nicht mit eWAY verbunden und wird nicht von eWAY unterstützt.