3rd Party Gutschein Integration
Als Anbindung können wir andere Gutscheinsysteme(auch Fremdgutscheine genannt) über eine Standardschnittstelle (3rd-Party-Gutscheine-API) kompatibel aufnehmen.
Einleitung
3rd-Party Gutscheine können an das Hypersoft Web-Gutscheine Systeme angebunden werden, welches als Basis beim Einsatz lizenziert und eingerichtet sein muss. Die Hypersoft Web-Gutscheine werden hierfür für jeden Standort lizenziert.
Das Erstellen und Aufladen der Gutscheine kann hiermit im 3rd Party System und unabhängig von Hypersoft erfolgen.
Bezüglich rechtlicher Vorschriften verweisen Sie als Hypersoft Kunde an Ihren 3rd Party Partner und Sie als 3rd Partner an ihre eigene Verantwortung. Hypersoft verwendet das Zahlungsmittel wie übermittelt und bucht bzw. signiert dieses im Standard.
Seitens Hypersoft können 3rd-Party-Gutscheine zum Zeitpunkt der Einlösung abgefragt, Guthaben zur Zahlung verwendet werden und um den Zahlbetrag kann das Guthaben entsprechend reduziert werden.
Allgemeines zu 3rd Party Gutscheinen
3rd Party Gutscheine (Fremdgutscheine) können in der Regel nicht aufgeladen werden (da es von den meisten Anbietern nicht vorgesehen ist). Beachten Sie deshalb bitte:
Bei Nutzung der Hypersoft Kassenfunktion Zahlungsart ändern gibt es die Möglichkeit einen Gutschein als Zahlungsmittel zu verwenden. Bei Hypersoft Web-Gutscheinen wird im Fall der plötzlichen Unterbrechung dieser Prozedur (z.B. durch Abzug des Bedienerschlüssels) der Gutschein wieder aufgeladen. Bei einem Fremdgutschein ist dieses Aufladen leider nicht möglich. Daher wird bei Verwendung eines Fremdgutscheins und Unterbrechung (z.B. durch Abzug eines Schlüssels) ein Abschließen des Vorgangs über eine Zahlungsart erzwungen und der Bediener zum Abschluss des Vorgangs entsprechend gezwungen. Der Vorgang bleibt geöffnet und die Abbruchtaste ist bis zur Auswahl der Zahlungsart gesperrt.
Die Hypersoft Systemlösung
Die Hypersoft Systemlösung wird auf Grund der Komplexität und des standortübergreifenden Aufbaus im Standard (Best Practice) auf unterschiedlichen Ebenen (siehe Abbildung 1) betrachtet. Die 3rd Party Anbindung ist auf Grundlage dieser Dokumentation in die Hypersoft Systemlandschaft implementiert.
Zielbestimmung
Diese Dokumentation hat zum Ziel, die angebundene 3rd-Party Schnittstelle in ihrer aktuellen Funktionsweise zu beschreiben. Hierbei wird primär die Hypersoft Perspektive betrachtet, welche unter entsprechenden Restriktionen als Hypersoft Best Practice freigegeben ist.
Insofern sich Abweichungen zum freigegebenen Hypersoft Best Practice ergeben, so sind diese im Rahmen eines Change Request Verfahrens zu bearbeiten. Alle Abweichungen von den hier beschriebenen Funktionsweisen sind durch Hypersoft nicht zertifiziert und nicht für den Markt freigegeben.
Betriebsebene
Zugangspunkt/ externe Systeme...
Die in diesem Dokument beschriebene Schnittstelle kommuniziert derzeit ausschließlich aus der Betriebsebene. Folglich müssen entsprechende Zugänge als Grundlage zur Kommunikation der Schnittstelle gewährleistet sein.
Voraussetzungen zur Nutzung der Voucher API
Bitte Buchen Sie für die Anbindung (ein bis zwei Tage Support (je nach Aufgabenstellung kann dies auch mehr werden) der Hypersoft Entwicklungsabteilung. Hiermit können wir Ihnen mit dem Aufbau einer Testumgehung, Beantwortung von Fragen und gegebenenfalls Zertifizierung dienlich sein.
- Schriftliche Beschreibung der gewünschten Funktion sowie des Workflows
- Enterprise Supportstufe (Mindestlaufzeit 12 Monate)
- Unterzeichneter LOI (Letter of Intent) zwischen dem Technologiepartner und Hypersoft
- Nennung der technischen Ansprechpartner/ Entwickler des Technologiepartners
- Beauftragung von (mindestens) 1 Tag Support & Entwicklungsunterstützung
Sobald die oben genannten Anforderungen erfüllt sind, erfolgen folgende Schritte:
- Freischaltung aller Lizenzen für den unproduktiven Einsatz
- Schulung der Hypersoft Basics (mittels Teamviewer oder ähnlichem)
- Vorgespräch zwischen unserer, sowie der Entwicklungsabteilung des Technologiepartners
- Übergabe der Voucher Schnittstellenbeschreibung
- Unterstützung der Anbindung seitens des Technologiepartners
- Gemeinsame unproduktive Tests
- going-Live & Projektabschluss
Dieses Thema betrifft planungspflichtige Projektarbeit.
Das Hypersoft // System ist ein Standardprogramm, das in vielen verschiedenen Konfigurationen eingesetzt werden kann. Die korrekte Anwendung der hier beschriebenen Themen erfordert Expertenwissen und einen Abgleich der Erwartungen und nicht alle Hypersoft Mitarbeiter und Partner sind in allen so gekennzeichneten Themen gleichermaßen geschult. Aus diesem Grund kennzeichnen wir diese Themen als planungspflichtige Projektarbeit, damit Sie sich rechtzeitig mit dieser notwendigen Planung an Ihren Hypersoft Vertriebspartner oder den Hypersoft Support wenden können. Diese Vorgehensweise stellt sicher, dass wir Ihre Anforderungen entsprechend sorgfältig aufnehmen und zielorientiert beantworten.
API Anbindung für 3rd Party Gutscheinsysteme (Fremdsysteme)
Externe Gutscheine werden wie Hypersoft Web-Gutscheine pro Transaktion abgerechnet. Die Nutzung externer Gutscheine erfordert ebenfalls die Lizenzen für Hypersoft Web-Gutscheine pro teilnehmendem Standort.
Die MCP Einrichtung für die Anbindung von Webgutscheine kann 10 freie fremde Gutscheine verwalten, die das Web-Gutscheinsystem in MyHypersoft verarbeitet werden.
Es stehen hierfür die Gutschein-Präfixes 50 bis 59 zur Verfügung. Das heißt die Annahme des Fremdgutscheins wird mit einer speziellen Funktion an dem Hypersoft POS System eingeleitet. Hier wird ein Makro mit dem entsprechenden Präfix und der Kassenfunktion z.B. 5 + 0+ Fremdgutschein verwenden genutzt. Die daraufhin gescannte oder auch eingegebene Nummer des Fremdgutscheins bekommt den Präfix (z.B. in Deutschland) 4950... gefolgt von der Nummer des Gutscheins. Mit dieser Nummer wird an das Portal eine Anfrage gestellt und es erkennt anhand des Präfixes, dass die Prüfung an einen anderen Server weitergeleitet werden muss. Das Präfix (in unserem Beispiel 4950) ist die Erkennung und muss auch im Portal mit gültiger Kundennummer, Passwort und URL für die API Weiterleitung eingerichtet werden. Das Restguthaben dieser Fremdgutscheine kann optional auch ausgezahlt werden, hierzu muss der Standard Eintrag auf Restbetrag auszahlen gesetzt werden.
Ergänzen Sie die Einstellungen im MCP und achten Sie darauf die identischen Einträge wie im Portal zu machen.
Währungstabelle einstellen...
Beispiel für Zahlungstypen
Zahlungstypen steuern das Verhalten des Systems. Zahlungstypen sind Barzahlung, Kreditkartenzahlung, "Auf Zimmer" oder Kundenkonto. Gutscheinzahlung und Gutscheinrest. Ein Restguthaben ist nicht bei allen Gutscheintypen möglich:
Multizahlung unterstützt oder nicht...
Fremdgutscheine können nicht zurückgenommen werden. Sie können Vorgänge die mit Fremdgutschein teil/ oder ganz bezahlt wurden wieder öffnen, jedoch bleibt der Gutschein im Vorgang enthalten. Eine Retour oder Storno von Fremdgutscheine ist nicht möglich.
Deshalb empfehlen wir Fremdgutscheine in der Multizahlung hier zu deaktivieren: Multizahlung ohne Trinkgeldtaste, Gutscheintaste und Fremdgutscheintaste
3rd Party Gutscheine Im Kassiermodus
Für den POS Kassiermodus stehen Ihnen entsprechende Kassenfunktionen für Fremdgutscheine zur Verfügung (In der Beschreibung der Kassenfunktion erfahren Sie auch wie das Makro einzurichten ist):
Bei der Funktion Gutschein fremd Balance, wird das Guthaben abgefragt und angezeigt. Zur Zahlung betätigen Sie das Makros mit der Kassenfunktion Gutschein fremd verwenden, Sie haben dann die Möglichkeit die Gutscheinnummer über den dargestellten Nummernblock einzugeben oder den Gutschein einfach zu scannen.
Ein Restguthaben wird so wie in der Definition des Webgutscheines eingestellt angewandt. Sollte jedoch Restbetrag auszahlen eingestellt sein, aber ein Zahlungstyp Gutschein Überzahlung vorhanden sein, wird der Rest des Gutscheins auf diese Zahlungsart umgebucht und der Gast bekommt kein Restguthaben.
Einstellungen im Hypersoft Portal...
Bevor die Einstellungen für die Fremdgutscheine auf der Kasse vorgenommen werden, sind für die jeweiligen Filialen in MyHypersoft in den Zentraleinstellungen der Webgutscheine noch folgende Einstellungen vorzunehmen:
- Zentraleinstellungen aufrufen. Navigation in MyHypersoft
-
Passwort für die Kassenschnittstelle des Fremdgutscheins erstellen. Web-Gutscheine konfigurieren
-
Dieses Passwort muss in der Kasse bei der API des Fremdgutscheins hinterlegt werden.
-
Je nach Schnittstellentyp (Schnittstellentyp 50 bis 59, wird auf der Kasse definiert) ist es notwendig, noch ein Passwort oder ein Übergabeparameter zur API des Fremdgutscheins zu hinterlegen. Z. B. kann es notwendig sein, dass noch ein Passwort zu dieser Filiale notwendig ist, um die API des Fremdgutscheins anzusprechen. Dies ist aber je nach Schnittstellentyp unterschiedlich.
Reservierte Ports (bitte wählen Sie je nach Anbindung):
- Prefix xx50 für Hypersoft Gutscheinsysteme
- 3rd Party Prefix xx51 für die E-GUMA
- 3rd Party Prefix xx52 für die Incert
- 3rd Party Prefix xx53 für Innocard
-
3rd Party Prefix xx54 für Lunch Check
- 3rd Party Prefix xx59 für HKS
3rd Party Gutscheine am mPOS...
Auch am mPOS können Fremdgutscheine verwendet werden. Weiterführende Dokumentation: Gutscheine und Fremdgutscheine
Zahlungen mit Hypersoft- und 3rd Party Gutscheinen
Thematisch hier bereits beschrieben: Zahlungen mit Hypersoft- und 3rd Party Gutscheinen
Weiterführende Dokumentation:
Innocard Gutschein Integration
3rd Party Gutschein Entwicklung
Zurück zur übergeordneten Seite: Integrationen und Schnittstellen