OXID
Integrationshandbuch
Sofort
1. Einführung zu SOFORT Überweisung Paycode
Mit der Funktion SOFORT Überweisung Paycode erhalten Sie die Möglichkeit, einen 10-stelligen Code zu generieren, mit dem Ihre Kunden eine Zahlung via SOFORT Überweisung zu einem beliebigen späteren Zeitpunkt innerhalb des Gültigkeitszeitraums aufnehmen können.
Der Ablauf für eine SOFORT Überweisung mit Paycode stellt sich wie folgt dar:
- Generieren Sie einen Paycode. Sie können einen Paycode entweder in Ihrem Anbietermenü bei SOFORT oder über die HTTP-XML-Schnittstelle generieren. (Siehe Kapitel 2: Menüpunkt Paycode im Anbietermenü bei SOFORT oder Kapitel 3: Generierung eines Paycode über eine HTTP-XML Schnittstelle)
- Teilen Sie den Paycode Ihrem Kunden mit.
- Der Kunde kann den Paycode auf der Seite https://www.sofort.com/paycode/ eingeben und die Bezahlung durchführen.
- Sie erhalten je nach Projektkonfiguration entweder eine Mitteilung oder können im Anbietermenü einsehen, dass die Überweisung von Ihrem Kunden in seinem Online-Banking eingestellt wurde.
2. Integrationsschritte
Um SOFORT Überweisung Paycode in OXID zu integrieren, sind die folgenden Schritte notwendig:
- Registrieren Sie sich als Anbieter auf unserer Seite https://www.sofort.com/register
- Neues SOFORT Projekt erstellen und konfigurieren
- Installieren des SOFORT Moduls im Shop
- SOFORT Modul im Administrations-Backend Ihres Shops einrichten
3. Einrichten eines Projektes für OXID
3.1. Registrierung bei Sofort
Um SOFORT Überweisung in Ihrem Shop anbieten zu können, benötigen Sie einen Kundenaccount bei Sofort.
Falls Sie diesen noch nicht besitzen, können Sie sich unter https://www.sofort.com/register registrieren.
Nach der Registrierung müssen Sie im Anbietermenü eingeloggt sein und können im nächsten Schritt ein Projekt für Ihr System / Ihren Online Shop erstellen. Falls Sie nicht Sofort verwenden, müssen Sie noch das gewünschte Produkt aktivieren. Die Produktaktivierung findet sich in der linken Navigation unter "Mein Konto > Produkt-Aktivierung".
3.2. Neues SOFORT Projekt erstellen
Um ein Projekt anzulegen, klicken Sie bitte "Neues Projekt" in der linken Spalte und legen ein SOFORT Gateway-Projekt an. Wenn Sie schon eine andere SOFORT-Zahlart in Ihrem Shop nutzen, können Sie SOFORT Überweisung Paycode in dem bereits bestehenden Projekt aktivieren.
ACHTUNG: Bitte wählen Sie als Projekttyp "SOFORT Gateway" aus.
Funktionen wie automatische Rückbuchungen und Käuferschutz stehen nur zur Verfügung wenn Sie ein Konto der Deutche Handelsbank hinterlegen. Sie haben die Möglichkeit während der Projektanlage eine Deutche Handelsbank-Konto zu beantragen.
Vervollständigen Sie nun Ihre Projektdaten. Die wichtigsten Einstellungen im Überblick:
Allgemeine Einstellungen
- Projektname: Geben Sie hier den Namen Ihres Shops an.
- Shopsystem: Wählen Sie Ihr Shop-System.
- Branche: Wählen Sie Ihre Branche.
- Webseite: Geben Sie die URL zu Ihrem Online-Shop an.
Adresse
Die hier eingetragene Adresse wird Ihrem Kunden auf unserem Zahlformular angezeigt.
Bankverbindung
Tragen Sie hier Ihre Bankverbindung ein, auf der die Zahlungen eingehen sollen. Beachten Sie, dass Sie für Auslandstransaktionen in anderen Währungen ein entsprechendes Währungskonto benötigen. Sie können nach Projektanlage in den "Erweiterten Einstellungen" des Projektes weitere Bankverbindung für Fremdwährungen hinterlegen (z.B.: für Transaktionen aus Polen ein Złoty Währungskonto).
Einstellungen für alle Zahlmethoden
Die folgenden Einstellungen sollten normalerweise nicht geändert werden müssen, da die notwendigen Daten direkt über die Schnittstelle aus Ihrem System/Shop übertragen werden.
- Erfolgslink: Über den Erfolgslink gelangt Ihr Kunde nach erfolgreichem Abschluss der Transaktion zurück in Ihr System/Shop.
- Automatische Weiterleitung: Sofern aktiviert erhält Ihr Kunde keine Zusammenfassungsseite nach erfolgreicher Transaktion sondern wird direkt auf den Erfolgslink geleitet.
- Abbruch-Link: Bricht Ihr Kunde die Transaktion ab, so kommt er über den Abbruch-Link zurück auf Ihre Internetseite.
- HTTP-Benachrichtigung: Tragen Sie hier die serverseitige URL ein die bei einer Statusänderung einer Transaktion über einen HTTP Aufruf informiert wird.
- E-Mail-Benachrichtigung: Tragen Sie hier eine E-Mail-Adresse ein die bei einer Statusänderung einer Transaktion per E-Mail informiert wird.
- Timeout in Sekunden: Geben Sie die Zeit an, bevor die Sitzung auf dem Zahlformular abgebrochen wird.
- Timeout-Link: Verstreicht der Sitzungs-Timeout auf dem Zahlformular, wird Ihr Kunde auf die angegebene Seite in Ihrem System/Shop geleitet.
- Automatische Weiterleitung: Sofern aktiviert wird Ihr Kunde automatisch beim Timout auf den Timeout-Link weitergeleitet.
Käuferschutz
Wenn Sie ein Deutche Handelsbank-Konto haben, können Sie den Käuferschutz aktivieren. Ihr Account muss dafür freigeschaltet sein, wenden Sie sich dazu bitte an die Deutche Handelsbank. Mehr Informationen zu der Deutche Handelsbank und Käuferschutz erhalten Sie unter https://www.sofort-bank.com/
Zahlarten
Aktivieren Sie hier SOFORT Überweisung Paycode indem Sie die Checkbox aktivieren.
- Gültigkeit: Legen Sie hier fest, wie lange ein Paycode von seinem Gültigkeitsstart (normalerweise Erstellungszeitpunkt) ab gültig ist.
- Absender-Land gesperrt: Lassen Sie diese Option deaktiviert.
- Testmodus: Mit Aktivierung dieser Option, können Sie SOFORT Überweisung Paycode testen. Mehr Informationen dazu im Kapitel "Testen". Echte und Test-Transaktionen sind parallel möglich. Wir empfehlen dennoch den Testmodus im Produktivbetrieb zu deaktivieren.
Konfigurationsschlüssel
Nach Projektanlage können Sie in Ihrem Projekt Ihren Konfigurationsschlüssel einsehen. Bitte hinterlegen Sie diesen Schlüssel in Ihrem System/Shop.
Projektlogo
Nach Projektanlage können Sie in den erweiterten Einstellungen ein Logo Ihres Shops oder Firma hochladen. Dieses Logo wird anstatt der eingetragenen Adresse auf unserem Zahlformular angezeigt.
4. Installieren der Schnittstelle
Vor Veränderungen an Ihrem Shopsystem empfiehlt es sich immer eine Sicherung des Shops und der Datenbank anzulegen.
- Um OXID in Ihrem Shopsystem nutzen zu können, müssen Sie sich zunächst das SOFORT Modul für OXID herunterladen:
https://www.sofort.com/integrationCenter-ger-DE/. - Entpacken Sie anschließend die Datei auf ihrer lokalen Festplatte (z.B. mittels 7-Zip oder WinRAR).
-
Kopieren Sie den Inhalt des Ordners "copy_this" mit einem FTP Programm (z.B. mittels FileZilla oder WinSCP) in das Wurzelverzeichnis Ihres OXID -Shopsystems.
HINWEIS: achten Sie bitte darauf, die Dateien im Übertrangungstyp "binär" bzw. "binary mode" zu übertragen. - Navigieren Sie in den Ordner "invoicePDF" und öffnen die Datei "functions.txt". Markieren Sie den kompletten Inhalt und kopieren Sie diesen. Öffnen Sie nun die Datei “invoicepdfoxorder.php” (bzw. "myorder.php" unter Oxid 4.8). Sie finden diese im Verzeichnis /modules/invoicepdf oder /modules/oe/invoicepdf/models/invoicepdfoxorder.php. Fügen Sie den kopierten Text vor die letzte geschweifte Klammer (}) ein.
- Öffnen Sie nun die Datei "snippet.txt" und kopieren deren Inhalt. Suchen sie dann in der Datei “invoicepdfoxorder.php” (bzw. "myorder.php" unter Oxid 4.8) nach der Funktion pdfFooter() ( public function pdfFooter($oPdf) ) und fügen den kopierten Inhalt nach der ersten geschweiften Klammer ein.
- Speichern Sie die Datei und ersetzen die Datei auf Ihrem Server durch die bearbeitete Datei.
5. Konfiguration der Schnittstelle
- Wählen Sie zur Aktivierung der Schnittstelle im Administrationsbereich Ihres OXID -Shops "Erweiterungen > Module > tronet SOFORT Überweisung Paycode".
- Klicken Sie auf dem Reiter "Stamm" auf "Aktivieren".
-
Wechseln Sie auf den Reiter "Einstell.", tragen Sie den Konfigurationsschlüssel aus den Projekteinstellungen im SOFORT Anbietermenü ein. An dieser Stelle ist es auch möglich den Verwendungszweck als auch den Text vor und nach dem Paycode-Snippet anzupassen. Klicken Sie anschließend auf "Speichern".
Der SOFORT Überweisung Paycode ist nun eingerichtet und wird bei Zahlungen auf Vorkasse/Rechnung in der Bestellbestätigung als auch auf der PDF Rechnung angezeigt.
Die Statushistorie der SOFORT Überweisung finden sich im Reiter "Paycode" bei Bestellungen bei denen Vorkasse/Rechnung als Zahlart ausgewählt worden ist.
6. Testen
Um die Funktionalität der Integration von SOFORT Überweisung Paycode zu testen führen Sie bitte die Erstellung des Paycodes direkt über Ihr System/Shop aus. Dies sind die einzelnen Schritte:
- Aktivieren des Testmodus in Ihrem Projekt.
- Erstellen Sie einen Paycode über Ihr System/Shop
- Klicken Sie auf den Paycode-Link bzw. öffnen Sie die Webseite https://www.sofort.com/paycode und geben Sie dort den zuvor generierten Test-Paycode ein.
- Prüfen Sie die korrekte Übergabe der Daten auf dem angezeigten Zahlformular
- Für deutsche Absenderkonten auf dem Zahlformular "88888888" (8x "8") als BLZ verwenden, für Belgien "Andere" wählen und "999" (3x "9") sowie für alle anderen Länder "00000" (5x "0") bzw. "Demo Bank" auswählen. Alle folgenden Daten können Sie beliebig wählen.
(In Kürze können Sie anstatt der Test-BLZ auch eine länderspezifische Test-BIC übergeben: "SFRT{ISO-Länderkürzel}20XXX", z.B. für Deutschland "SFRTDE20XXX") - Prüfen Sie die korrekte Rückleitung
- Wird nach der Transaktion auf die Erfolgsseite geleitet?
- Kommen alle Benachrichtigungen richtig an?
- Wird der Zahlstatus des Paycodes richtig gesetzt?
Hinweis:
Deaktivieren Sie am Ende des Tests den Testmodus in Ihren Projekteinstellungen (Solange Ihr SOFORT Überweisung Paycode Projekt noch nicht produktiv ist, lässt sich der Testmodus nicht deaktivieren).
7. Support & Kontakt
Das Team von Sofort steht Ihnen zur Verfügung, sollten Sie Hilfe benötigen.
Sie können uns eine E-Mail an service@sofort.com schreiben.
Auch bei technischen Fragen helfen wir Ihnen gerne weiter:
Technische Beratung:
Telefon: +49 (0)89 24 88 37 691
E-Mail: integration@sofort.com
Geschäftszeiten:
Montag-Donnerstag: 08:30-18:00 Uhr
Freitag: 08:30-17:00 Uhr
8. Impressum
SOFORT GmbH
Theresienhöhe 12
80339 München
Deutschland
Informationen für Käufer und Online-Shopper:
Telefon: +49 (0)89 24 88 37 690
Informationen für Verkäufer und Händler:
Telefon: +49 (0)89 24 88 37 692
info@sofort.com
www.sofort.com
Geschäftsführung
Felix Würtenberger
Wilhelmus Geerling Klaassen
Externer Datenschutzbeauftragter
Hr. Michael Schramm
Für Fragen zum Datenschutz wenden Sie sich bitte an: datenschutz@sofort.com
Eingetragen beim Amtsgericht München
HRB 218675
USt-ID: DE248376956
Zuständige Aufsichtsbehörde:
Bundesanstalt für Finanzdienstleistungsaufsicht (BaFin),
Graurheindorfer Straße 108, 53117 Bonn und
Marie-Curie-Straße 24-28, 60439 Frankfurt am Main
© SOFORT GmbH. Alle Rechte, einschließlich der Übersetzung, vorbehalten.
Die Dokumentation einschließlich aller veröffentlichten Inhalte ist urheberrechtlich geschützt. Nachdruck oder Reproduktion jeglicher Art sowie die Verarbeitung, Vervielfältigung und Verbreitung unter Verwendung elektronischer Systeme in irgendeiner Form bedarf der vorherigen schriftlichen Genehmigung der SOFORT GmbH.
Die Verwendung dieser Dokumentation und die Umsetzung der darin enthaltenen Angaben erfolgt ausdrücklich auf eigenes Risiko. Die SOFORT GmbH übernimmt keine Gewähr für die Funktion einzelner Programme oder von Teilen derselben. Insbesondere übernimmt die SOFORT GmbH keine Haftung für etwaige, aus dem Gebrauch resultierende Folgeschäden.
OXID
OXID