Paygate-Schnittstelle
a alphabetisch as alphabetisch mit Sonderzeichen n numerisch an alphanumerisch ans alphanumerisch mit Sonderzeichen ns numerisch mit Sonderzeichen bool Bool’scher Ausdruck (true oder false) 3 feste Länge mit 3 Stellen/Zeichen ..3 variable Länge mit maximal 3 Stellen/Zeichen enum Aufzählung erlaubter Werte dttm ISODateTime (JJJJ-MM-TTThh:mm:ss) CND Bedingung (condition) M Pflicht (mandatory) O optional C bedingt (conditional) Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.Definitionen
Datenformate
Format Beschreibung Abkürzungen
Abkürzung Beschreibung Kommentar Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist
Aufruf der Schnittstelle für eine Alipay Webseiten-Zahlung
Für Alipay-Zahlungen sind anschließend Stornierungen und Gutschriften gemäß folgender Kapitel möglich. Per Batch-Nutzung sind nur Gutschriften möglich. Für Transaktionen im stationären Handel (Point-of-Sale) verwenden Sie bitte die Anbindung Alipay Spot Payment oder Alipay QR-Code Payment.
Um eine Alipay Webseiten-Zahlung über ein Paygate-Formular abzuwickeln, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/alipay.aspx |
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter für Zahlungen mit Alipay Webseiten-Zahlung
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei Alipay Webseiten-Zahlung
Aufruf der Schnittstelle für Zahlung mit Alipay Spot Payment
Um eine Zahlung mit Alipay Spot Payment über eine Server-zu-Server-Verbindung abzuwickeln, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/alipayspot.aspx |
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter für Zahlungen mit Alipay Spot Payment
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Alipay Spot Payment
Aufruf der Schnittstelle für Zahlung mit Alipay QR-Code Payment
Um eine Zahlung mit Alipay QR-Code Payment über eine Server-zu-Server-Verbindung abzuwickeln, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/alipayQRCode.aspx |
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter für Zahlungen mit Alipay QR-Code Payment
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort in einer Server-zu-Server-Verbindung zurücksendet, für eine Auftragserteilung des QR-Codes, der später vom Kunden gescannt wird. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
Parameter der synchronen Antwort von Alipay QR-Code Payment – Auftragserteilung für QR-Code
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLNotify übergibt, wenn die asynchrone Benachrichtigung von Alipay über die Zahlungsausführung eingetroffen ist. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
Parameter der asynchronen Antwort von Alipay QR-Code Payment – Zahlungsausführung
Aufruf der Schnittstelle für Zahlung mit Alipay In-App Payment
Um eine Zahlung mit Alipay In-App Payment über eine Server-zu-Server-Verbindung abzuwickeln, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/alipayApp.aspx |
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter für Zahlungen mit Alipay In-App Payment
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort in einer Server-zu-Server-Verbindung zurücksendet, für eine Anforderung eines Anfrage-Strings zum Aufruf der API des In-App Payment. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
Parameter der synchronen Antwort von Alipay In-App Payment – Zusammenstellen des Anfrage-Strings für den API-Aufruf
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLNotify übergibt, wenn die asynchrone Benachrichtigung von Alipay über die Zahlungsausführung eingetroffen ist. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
Parameter der asynchronen Antwort von Alipay In-App Payment – Zahlungsausführung
Storno
Stornierungen einer Zahlung mit Alipay Spot Payment oder QR-Code Payment sind über eine Server-zu-Server-Kommunikation möglich. Das Paygate erlaubt Stornierungen, die sich auf eine vorher über das Paygate getätigte Zahlung oder Autorisierung beziehen. Wenn Sie sich bei einem Storno auf eine Zahlung beziehen, wird die komplette Zahlung storniert. Ein Storno ist nur vor dem täglichen Kassenschnitt bei Alipay möglich.
Für Alipay-Online-Zahlungen über alipay.aspx oder alipayApp.aspx sind keine Stornierungen möglich.
Um eine Stornierung für Alipay Spot Payment oder QR-Code Payment über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/reverse.aspx |
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter für Storno von Alipay Spot Payment oder QR-Code Payment
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Storno von Alipay Spot Payment oder QR-Code Payment
Gutschrift mit Referenz
Gutschriften einer Zahlung mit allen Alipay-Zahlungsvarianten sind über eine Server-zu-Server-Kommunikation möglich. Das Paygate erlaubt Gutschriften, die sich auf eine vorher über das Paygate getätigte Zahlung beziehen. Dabei ist die Höhe der Gutschrift auf die Höhe der vorangegangen Zahlung beschränkt.
Um eine Gutschrift (Credit) mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/credit.aspx |
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter für Gutschrift von Alipay-Zahlungen
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Gutschrift von Alipay-Zahlungen
Statusabfrage für Alipay Spot Payment
Statusabfragen betreffen nur Zahlungen mit Alipay Spot Payment und sind über eine Server-zu-Server-Kommunikation möglich. Das Paygate erlaubt Statusabfragen, die sich auf eine vorher über das Paygate getätigte Zahlung beziehen. Eine Statusabfrage wird nötig, sobald Sie bei der Anlage einer Zahlung als Status den Wert AUTHORIZE_REQUEST zurückbekommen haben. Dann muss der Kunde die Zahlung nochmals per App mit seinem Payment-Passwort bestätigen.
Um eine Statusanfrage mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/inquireExt.aspx |
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp. Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter für Statusabfrage von Zahlungen mit Alipay Spot Payment
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt: es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden die Parameter (z.B. mid, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
Ergebnis-Parameter für Statusabfrage bei Alipay Spot Payment
Batch-Nutzung der Schnittstelle
Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.
Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer Alipay-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.
Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:
Beschreibung der möglichen Batch-Versionen
Der Aufbau für eine Alipay-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> Alipay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount>
Beispiel für Master-MID-Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount
Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
Beschreibung der Felder im Datensatz von Batch-Dateien
Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> Alipay,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> Alipay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount>
Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien