
| Modul-Version | 1.0.4 – Stand 03.02.2026 |
| Modulname | Kustom Checkout für den OXID eShop 7 |
| Modulkategorie | Bezahlmethoden / Payments Dieses Modul fügt dem OXID eShop zusätzliche Zahlungsarten hinzu. |
| Modulanbieter | Kustom AB - Brahegatan 10 - 114 37 Stockholm, Swedenwww.kustom.co |
| Entwicklung des Moduls | Fatchip GmbH www.fatchip.de Mail: support@fatchip.de |
| Kustom Merchant Support: | support@kustom.co |
For english-version click HERE
Dieses Modul ermöglicht Ihnen die Erweiterung Ihres OXID eShops um die von Kustom bereitgestellten Zahlungsarten. Der „Kustom Checkout“ integriert die Zahlungsarten „Klarna Kauf auf Rechnung“, „Klarna Ratenkauf“, Lastschrift und Kreditkartenzahlungen per Visa oder MasterCard in einer revolutionär einfachen Checkout-Lösung. Ihre Kunden müssen nur noch Daten angeben, die sie ohnehin immer im Kopf haben. Dies vereinfacht das Einkaufen enorm und lässt Ihre Konversionsrate förmlich explodieren – vor allem auf Smartphones und Tablets. Nach der Installation dieses Moduls und anschließenden Aktivierung des Kustom Checkouts bekommen Ihre Kunden die Möglichkeit, direkt von der Produkt-Detailseite oder aus dem Mini-Basket heraus zum Kustom Checkout zu wechseln. Hier können Kunden dann einfach durch Eingabe von E-Mail-Adresse und Postleitzahl den Einkauf abschließen.
Für die Verwendung des OXID 7 Kustom Checkout Moduls sind folgende Systemvorrausetzungen notwendig:
Kustom sendet zur Validierung von Transaktionen Requests an Ihren OXID eShop.
Damit solche Callback Aufrufe von Kustom an Ihren Shop erfolgen können, muss Ihr Shop frei von draußen über das Internet erreichbar sein. Das heißt, es darf weder einen Passwortschutz, noch eine IP-Sperre oder einen Firewallschutz in Ihrem Shop aktiv sein, der Kustom daran hindert, die entsprechenden Informationen an den Shop zu senden.
Denken Sie insbesondere daran, wenn Sie in Ihrer Entwicklungs- oder Stage-Umgebung testen wollen: HTTPS-Aufrufe von den externen Kustom Servern auf Port 443 Ihres Servers müssen erlaubt sein.
Für die Installation des OXID 7 Kustom Checkout Moduls führen Sie die nachfolgenden Schritte aus:
composer require fatchip-gmbh/kustom-checkout-oxid7
Die aktuelle Versionsnummer des OXID 7 Kustom Checkout Moduls erhalten Sie unter https://github.com/FATCHIP-GmbH/kustom-checkout-oxid7/releases
Für Plugin-Updates können Sie auch unseren LinkedIn-Account: https://de.linkedin.com/company/fatchip folgen.
Um das Kustom Checkout Modul für OXID 7 zu aktualisieren, müssen Sie die nachfolgenden Schritte ausführen:

composer update
Im eShop Admin Haupt-Menü taucht die neue Rubrik „Kustom“ links mit mehreren Unter-Menüeinträgen auf:

Für eine detaillierte Beschreibung der verschiedenen Einstellungen beachten Sie bitte die Tooltips [?]
| Mode | Wählen Sie zwischen Playground (Test-Betrieb) und Live (Produktiv-Betrieb). Schalten Sie den Produktiv-Betrieb nur nach erfolgreicher Durchführung von Integrations-Tests und nach Rücksprache mit Ihrem Kustom Integration Manager aktiv. | |
| Merchant ID/API-Benutzernamen: | Hinterlegen Sie hier bitte Ihre Kustom Merchant ID. Diese haben Sie in der Willkommens E-Mail von Kustom erhalten. Diese Merchant ID samt Passwort gilt global für alle Länder. Nur falls Sie verschiedene Merchant IDs für unterschiedliche Länder erhalten haben, können Sie weiter unten länderspezifische Zugangsdaten je Land hinzufügen. | |
| Passwort/API-Passwort: | Geben Sie hier Ihr Passwort passend zur verwendeten Merchant ID ein. Dieses Passwort haben Sie in der Willkommens E-Mail von Kustom erhalten. | |
| Länderspezifische Zugangsdaten hinzufügen | optional, falls Sie für einzelne Länder separate Zugangsdaten von Kustom erhalten haben: | |
|---|---|---|
| Land | Wählen Sie aus der Auswahl links das Land aus, für das Sie länderspezifische Zugangsdaten von Kustom erhalten haben. | |
| Merchant ID/API-Benutzernamen: | Bitte geben Sie hier die zugehörige Merchant ID für dieses Land ein. | |
| Passwort/API-Passwort: | Bitte geben Sie hier das zugehörige Passwort für dieses Land ein. | |
| Logging aktiv | Aktiviert die Protokollfunktion, damit sämtliche API-Kommunikation mit Kustom in der mysql-Tabelle tcKustom_logs aufgezeichnet wird. Dies kann bei der Analyse oder Fehlersuche nützlich sein. Im Produktiv-Betrieb sollte die Funktion abgeschaltet sein, da sich sonst ggf. große Log-Mengen anhäufen und sensitive Daten gespeichert werden. | |
| Erweiterte Produktdaten an Kustom senden? | ||
| Produkt URLs | Senden Sie die URLs der Artikel-Detailseiten der Produkte, die sich im Warenkorb Ihrer Kunden befinden an Kustom, damit Kustom später aus dem Kustom Portal auf Ihre Artikel verlinken kann. | |
| Bild URLs | Senden Sie die URLs der Artikel-Bilder der Produkte, die sich im Warenkorb Ihrer Kunden befinden an Kustom, damit Kustom diese im Kustom Portal anzeigen kann. | |
| Anonymisieren | Aktivieren Sie die Anonymisierung, um die Artikelbezeichnungen der Produkte, die sich im Warenkorb Ihrer Kunden befinden, vor Kustom zu verbergen. Dies wird z.B. für Online-Apotheken empfohlen, sollte aber nur nach Rücksprache mit dem Kustom Integration Manager geschehen. | |
| In Sprache | Mit dieser Auswahl können Sie für jede Sprache einen passenden anonymisierten Produkttitel hinterlegen. | |
| Anonymisierter Produkttitel | Geben Sie hier die Zeichenfolge ein, die anstatt des tatsächlichen Produkttitels an Kustom gesendet werden soll. Es werden übrigens auch die Artikelnummern anonymisiert, so dass anhand dieser Daten ebenfalls kein Rückschluss auf die gekauften Artikel möglich ist. | |
| Unterstützte Kundenarten | Hier können Sie einstellen, ob der Shop ausschließlich B2C Transaktionen (Standard-Einstellung), nur B2B Transaktionen oder sowohl B2C als auch B2B Transaktionen akzeptieren soll und welche Kundenart vorrangig bedient wird. Dies bewirkt in manchen Ziel-Ländern, dass bei Aufruf des Kustom Checkout Iframes direkt ein optimiertes Formular für Firmen bzw. Personen angezeigt wird. Bitte beachten Sie, dass B2B Funktionen nur auf Anfrage für einzelne Länder freigeschaltet werden. Kontaktieren Sie daher unbedingt Ihren Kustom Account Manager, wenn Sie B2B Verkäufe anbieten möchten, damit dies für Sie aktiviert werden kann. | |
| Kustom Checkout Versand | Auswahl der Versandart, die für Kustom Express Checkout verwendet werden soll | |
| URL zu Ihren AGB - Pflichtfeld | Geben Sie hier die URL zu Ihren ABG ein | |
| URL zum Widerrufsrecht - Pflichtfeld | Geben Sie hier die URL zu Ihrer Webseite mit Erklärung zum Widerrufsrecht ein | |
| URL zu Versanddetails - Pflichtfeld | Geben Sie hier die URL zu Ihren Versanddetails ein | |
Auf dieser Seite können Sie die Kustom Checkout spezifischen Einstellungen konfigurieren.
Für eine detaillierte Beschreibung der verschiedenen Einstellungen beachten Sie bitte die Tooltips. [?]
| Standard Land des Shops | Bitte wählen Sie aus der Liste aus, für welches Land der Kustom Checkout standardmäßig geladen werden sollen, solange der Kunde sein Land noch nicht angegeben hat. |
| Lieferanschrift darf von Rechnungsanschrift abweichen | Falls die Lieferung an eine abweichende Lieferanschrift ermöglicht werden soll, aktivieren Sie diesen Schalter. |
| Telefonnummer ist Pflichtfeld | Falls Sie die Angabe einer Telefonnummer zwingend erfordern wollen, aktivieren Sie diesen Schalter. Normalerweise ist für Kustom die Telefonnummer kein Pflichtfeld. Stellen Sie sicher, dass diese Option eingeschaltet ist, falls Sie die Telefonnummer unter Admin > Stammdaten > Grundeinstellungen > Einstell. > Weitere Einstellungen > “Muss”-Felder für die Registrierung des Kunden zum Pflichtfeld gemacht haben. |
| Geburtsdatum ist Pflichtfeld | Falls Sie die Angabe eines Geburtsdatums zwingend erfordern wollen, aktivieren Sie diesen Schalter. Normalerweise ist für Kustom das Geburtsdatum kein Pflichtfeld. Allerdings ist die Angabe notwendig, um den Kauf auf Rechnung oder eine Ratenzahlung zu ermöglichen. Stellen Sie sicher, dass diese Option eingeschaltet ist, falls Sie das Geburtsdatum unter Admin > Stammdaten > Grundeinstellungen > Einstell. > Weitere Einstellungen > “Muss”-Felder für die Registrierung des Kunden zum Pflichtfeld gemacht haben. |
| Autofocus für Kustom Checkout Iframe aktivieren | Mit Hilfe dieses Schalters aktivieren Sie, dass beim Laden der Seite mit dem Kustom Checkout das Kustom Iframe automatisch fokussiert wird. |
| Individuelle Checkbox im Kustom Checkout Iframe hinzufügen | |
|---|---|
| Keine Checkbox anzeigen | Es besteht die Möglichkeit, dass Sie innerhalb des Kustom Checkout Iframes eine zusätzliche Checkbox aktivieren, um dem Kunden anzubieten, ein Kundenkonto zu eröffnen oder sich für Ihren Newsletter anzumelden, oder beides. Sollte bei angeschalteter Checkbox der Kunde schon ein Kundenkonto haben bzw. schon für den Newsletter angemeldet sein wird der Text der Checkbox automatisch angepasst oder die Checkbox ggf. komplett ausgeblendet. |
| Kundenkonto im OXID eShop anlegen | |
| Newsletter-Anmeldung | |
| Kundenkonto anlegen UND Newsletter-Abmeldung | |
| Bestell-Validierung | |
| Keine Validierung | Hiermit können Sie eine zusätzliche Überprüfung des Warenkorbs aktivieren, die beim Absenden der Kustom Checkout Bestellung noch einmal die Verfügbarkeit der gewünschten Artikel überprüft, um Fehler durch Überverkäufe zu vermeiden. Es wird der Modus „Erfolgreiche Validierung erforderlich“ empfohlen. |
| Validierung durchführen, aber Timeouts ignorieren | |
| Erfolgreiche Validierung erforderlich | |
| Pre-filling aktivieren | Aktivieren Sie das automatische Ausfüllen des Kustom Checkout Iframes durch die Daten des im OXID eShop eingeloggten Kunden. |
| Pre-filling Hinweis aktivieren | Wenn das automatische Ausfüllen des Kustom Checkout Iframes aktiv ist, muss für manche Länder ein entsprechender Datenschutz-Hinweis eingeblendet werden. Dieser Hinweis wird durch diesen Schalter aktiviert. |
| Sprachabhängige Einstellungen: | Hinterlegen Sie für jede Shop-Sprache entsprechende URLs und Texte. Wählen Sie dazu im Drop-Down „In Sprache“ die jeweilige Sprache aus. |
| URL zu Ihren AGB | Geben Sie hier die URL zu Ihren Allgemeinen Geschäftsbedingungen an. Diese werden im Kustom Checkout Iframe verlinkt. Eine gültige URL, die mit https: beginnt, muss angegeben werden. | ^ URL Widerrufsrecht | Geben Sie hier die URL zu Ihrer Webseite mit der Erklärung zum Widerrufsrecht an. Die URL muss mit https: beginnen. |
| Versanddetails | Diese Versandhinweise werden dem Kunden auf der Danke-Seite nach Abschluss der Bestellung angezeigt. |
Hier können Sie die Design Einstellungen zur Verwendung mit dem Kustom Modul für den OXID eShop konfigurieren. Für eine detaillierte Beschreibung der verschiedenen Einstellungen beachten Sie bitte die Tooltips [?]
Wählen Sie hier, ob das Kustom Logo im Footer Ihres Shops eingebunden werden soll.
Mit diesen Einstellungen können Sie das Look'n'Feel des Kustom Checkout Iframes Ihrem Shop Layout anpassen. Lassen Sie die Felder einfach leer, um das Kustom Standard Farbschema zu verwenden.
| Button | Hintergrundfarbe des Bezahl-Buttons innerhalb des Kustom Checkout Iframes |
| Button Text | Farbe des Textes des Bezahl-Buttons im Kustom Checkout Iframe |
| Checkbox | Hintergrundfarbe der Checkboxen innerhalb des Kustom Checkout Iframes |
| Checkbox Haken | Farbe des Checkbox-Hakens innerhalb von Checkboxen im Rahmen des Kustom Checkout Iframes |
| Kopfzeile | Farbe der Überschriften / Titel innerhalb des Kustom Checkout Iframes |
| Link | Farbe der Links innerhalb des Kustom Checkout Iframes |
| Border Radius | Mit dieser Einstellung können Sie den Grad der Rundung des Rahmens des Kustom Checkout Iframes festlegen |
Tipp: Bei Klick in eines der Farb-Felder öffnet sich ein komfortabler Farbwähler, so dass der hexadezimale Farbcode automatisch ins Feld eingetragen wird. Die Radius Einstellung wirkt sich unmittelbar auf das Eingabefeld selbst aus, damit man direkt ein Bild davon hat, wie der gewählte Radius im Frontend aussieht.
Sie haben die Möglichkeit innerhalb des Kustom Checkout Iframes neben den herkömmlichen Kustom Zahlungsarten weitere externe Bezahlmethoden zu integrieren.
Das Kustom Checkout und Kustom Payments Modul für den OXID eShop enthält bereits die Implementierung zur Verwendung der folgenden externen Bezahlmethoden, die im Standard-Funktionsumfang des OXID eShop vorhanden sind:
Das bedeutet, wenn Sie z.B. „Nachnahme“ als externe Bezahlmethode aktivieren, dann können Ihre Kunden im Shop Frontend in den Kustom Checkout starten und dort dann als Zahlungsart „Nachnahme“ direkt innerhalb des Kustom Checkout Iframes auswählen.
Der Vorteil ist, dass auch im Falle solch einer Gast-Bestellung per Nachnahme automatisch die Adressdaten vorausgefüllt werden, wenn:
a) der Browser des Kunden von Kustom per Cookie wieder erkannt wurde, nachdem bereits zuvor mit diesem Browser ein Kustom Einkauf getätigt wurde - ODER -
b) der Kunde von Kustom nach Eingabe seiner E-Mail-Adresse und Postleitzahl wieder erkannt wird, nachdem der Kunde bereits zuvor einen Kustom Einkauf in demselben oder einem beliebigen anderen Shop mit diesen Daten getätigt hat
Weitere externe Bezahlmethoden können per Modul ergänzt werden. Siehe Kapitel „Module für externe Bezahlmethoden“.
Folgende Module können mit dem vorliegenden Kustom Checkout und Kustom Payments Modul für den OXID eShop zusammen verwendet werden:
Beide Module stellen Funktionalitäten bereit, die es ermöglichen, Amazon Pay bzw. PayPal jeweils als „Externe Bezahlmethode“ in Ihrem Online-Shop zu aktivieren.
Ferner besteht die Möglichkeit für Entwickler, die modul-seitig bereits vordefinierten Zahlungsarten um weitere externe Bezahlmethoden hinzuzufügen. Bitte beachten Sie, dass diese ggf. im Einklang mit den zwischen Ihnen und Kustom geschlossenen Verträgen stehen müssen. Die im Paket-Umfang des vorliegenden Kustom Checkout und Kustom Payments Modul für den OXID eShops enthaltenen Integrationen für Vorkasse, Nachnahme, Amazon Pay und PayPal können dabei als Vorlage verwendet werden. Erweitern Sie die Controllers/KustomOrderController.php und ergänzen Sie entsprechende Aktionen für Ihre neuen Bezahlmethoden in der Methode KustomExternalPayment(). Außerdem ergänzen Sie den Namen Ihrer neuen Zahlungsart durch Erweiterung der Core/KustomConsts.php in der Methode getKustomExternalPaymentNames(). Dabei dürfen nur von Kustom freigegebene Namen verwendet werden. Wenden Sie sich bei Interesse gern an Ihren Kustom Integration Manager.
Unter dem Menüpunkt „External Payment Methods“ werden Ihnen alle Zahlungsarten aufgelistet, die Sie im Bereich Shopeinstellungen → Zahlungsarten eingerichtet und aktiv geschaltet haben. Für jede Zahlungsart können Sie hier nun folgende Einstellungen vornehmen:
| Zahlungsart | Ordnen Sie diese externe Bezahlart einer der vordefinierten Zahlungsarten zu. Weitere Zahlungsarten können von Entwicklern in dieser Liste ergänzt werden, siehe Kapitel: „Eigene externe Bezahlmethoden ergänzen“ |
| External Payment Method | Mit diesem Schalter aktivieren Sie diese Zahlungsart als externe Bezahlart für den Kustom Checkout. Wenn aktiv, kann der Kunde diese Zahlungsart aus der Liste der Zahlungsarten im Kustom Checkout Iframe auswählen |
| Sprachabhängige Einstellungen: | Hinterlegen Sie für jede Shop-Sprache entsprechende Bild-URIs. Wählen Sie dazu im Drop-Down „In Sprache“ die jeweilige Sprache aus. |
|---|---|
| Bild URI für External Payment Method | Geben Sie hier die URL zu einem Bild an, das neben der Zahlungsart im Kustom Checkout Iframe eingeblendet werden soll. Verwenden Sie optimalerweise ein Bild von einer sicheren URL, die mit https beginnt. Bildgröße: 69×24 Pixel |
Hier werden die Bilder für External Payment Methods im Kustom Checkout Iframe dargestellt:
Aktivieren Sie die Funktionen auf dieser Seite lediglich, falls Sie entsprechend von Ihrem Kustom Integration Manager instruiert wurden.
Kustom Extra Merchant Data bezeichnet zusätzliche Informationen über Ihre Kunden, die ggf. von Ihrem Shop automatisch an Kustom übertragen werden und seitens Kustom für eine bessere Risikoeinschätzung erforderlich sind.
Mit „Customer Account Info“ werden Informationen über das Kundenkonto an Kustom übermittelt: Wann wurde das Konto angelegt, wann wurde es zuletzt verändert.
Die „Payment History Full“ übertägt Informationen über die Anzahl und Summen der Käufe eines Kunden, das Datum des ersten und letzten Kaufs sowie die verwendete Bezahltmethode. Wenn Sie diese Informationen an Kustom übertragen, weisen Sie bitte für jede Bezahlart im Shop einmal zu, um welchen Typ der Zahlungsart es sich handelt und ob und ggf. wie diese Bestellungen als bezahlt an Kustom gemeldet werden sollen.
Mit Hilfe des Pass-through Feldes „merchant_data“ können Sie bei Bedarf individuelle Zusatz-Informationen zu einer Bestellung an Kustom übergeben. Auf diese Daten können Sie später mittels API bei jedem Abruf der Bestelldaten von Kustom wieder zugreifen. Sie können in diesem Feld z.B. eine einfache Zeichenfolge aber auch eine komplexe JSON Struktur als String an Kustom übertragen.
Wird der entsprechende Schalter im Admin-Backend gesetzt, so wird die Methode getPassThroughField() der Klasse KustomPassThrough ausgeführt. Diese Klasse liefert standardmäßig eine leere Antwort zurück. Um entsprechend individuelle Informationen an Kustom zu übertragen, muss diese Klasse mit Hilfe eines eigenen Moduls überladen werden.
Dies ist der einfachste Weg, um Zusatz-Informationen an Kustom zu übermitteln. Näheres hierzu erfahren Sie in der Entwickler-Dokumentation.
Hier ist ein Beispiel für ein individuelles Erweiterungs-Modul:
class your_module_pass_through extends your_module_pass_trough_parent
{
public function getPassThroughField()
{
$mainData = „any custom string“;
return $mainData;
}
}
Ihr Modul müssen Sie über die Metadata.php in Ihrem Shop bekannt machen.
Ein weiterer, etwas komplexerer Weg, um Zusatz-Informationen an Kustom übermitteln, ist, das Kustom Modul mit einem individuellen Modul zu erweitern um weitere Informations-Pakete wie Travel, Event, Voucher oder Subscription an Kustom zu übermitteln.
Hier ist ein Beispiel für ein individuelles Erweiterungs-Modul:
class your_module_Kustom_emd extends your_module_Kustom_emd_parent
{
public function getAttachments($oxUser)
{
$mainData = parent::getAttachments($oxUser);
$myEMDData = array('your_custom_info' =>
array('example_field' => 'example data')
);
return array_merge($mainData, $myEMDData);
}
}
Ihr Modul müssen Sie über die Metadata.php in Ihrem Shop bekannt machen.
Unter dem Menü-Punkt „Versandarten“ im Bereich des Kustom Menüs befindet sich die Zuordnung der Versandarten zu den von Kustom definierten Versand-Methoden für den Kustom Checkout.
Hiermit teilen Sie Kustom mit, dass z.B. eine in OXID zuvor angelegte Versandart „Abholung“ der Kustom Methode „PickUpStore“ entspricht. Dieses Matching von den in OXID angelegten Versandarten zu den bei Kustom üblichen Bezeichnungen wird hier für alle Versandarten einmal hinterlegt.
Die Zuordnung der Versandarten ist freiwillig. Sie können die Auswahl auch leer lassen. Ein akkurate Zuordnung erleichtert Kustom jedoch das Einschätzung von Risikoprüfungen und den Kundenservice bei Rückfragen zur Bestellung.
Falls Sie Packstation Lieferungen unterstützen möchten, ist eine Zuordnung jedoch erforderlich wie unter dem nächsten Punkt beschrieben:
Die Versandarten Zuordnung wird außerdem dafür benutzt, festzulegen, welches ggf. DHL Versandarten sind, die eine Lieferung an DHL Packstationen erlauben. Wenn Sie keine Packstation Lieferungen anbieten möchten, wählen Sie „Postal“. Möchten Sie an Packstationen liefern, wählen Sie hingegen „Postal + DHLPackstation“.
Um den Kustom Checkout zu aktivieren, müssen Sie Ihre Merchant ID oder Ihren API-Benutzernamen pflegen und das dazugehörige Passwort unter dem Menüpunkt Kustom → Allgemein eintragen.
Folgende Felder müssen (ggf pro Auswählbarer Sprache) befüllt unter dem Menüpunkt Kustom → Allgemein sowie dem Menüpunkt Kustom → Konfiguration sein:
Damit der Kustom Checkout korrekt aktiviert werden kann müssen in der Datei config.inc.php die Variablen $this→sSSLShopURL und $this→sAdminSSLURL gepflegt sein.
$this->sShopURL = 'https://IHRE-SHOP.URL'; // eShop base url, required $this->sSSLShopURL = 'https://IHRE-SHOP.URL'; // eShop SSL url, required for Kustom-Checkout $this->sAdminSSLURL = 'https://IHRE-SHOP.URL/admin'; // eShop Admin SSL url, required for Kustom-Checkout
Loggen Sie sich hierfür auf die Kommandozeile (CLI) ein und navigieren Sie zu „Rootverzeichnis des Shops“/source
und bearbeiten sie die config.inc.php.
Navigieren Sie anschließend zu Shopeinstellungen → Zahlungsarten und aktivieren Sie die Zahlungsart Kustom Checkout
und pflegen Sie die Länderzuordnung für den Kustom Checkout im Länder-Tab
Stellen Sie sicher, dass die Zahlungsart Kustom Checkout in Ihren Versandarten unter Shopeinstellungen → Versandarten → Versandart auswählen → Reiter Zahlungsarten zugeordnet ist.