Paygate-Schnittstelle
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
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:
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 | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer für Ihre Buchhaltung |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
OrderDesc | ans..768 | M | Name der gekauften Waren. Die Sonderzeichen „#“, „&“, „%“ sowie „+“ sind hier nicht zulässig. |
OrderDesc2 | ans..400 | M | Beschreibung der gekauften Waren und deren Menge im Format goods_name1;Menge1+goods_name2;Menge2. <;> trennt Waren und Menge innerhalb eines Datensatzes Beispiel: iPhone X;1+iPhone 8;2 Die Sonderzeichen „#“, „&“ sowie „%“ sind hier nicht zulässig. |
ShopURL | an..128 | M | URL des Internet-Shops, zum Beispiel https://testmerchant.com |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
URLSuccess | ans..256 | M | Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. |
URLFailure | ans..256 | M | Vollständige URL, die das Paygate aufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. |
Response | a7 | O | Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt. |
URLNotify | ans..256 | O | Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData. |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Timeout | ans..3 | O | Zeitlimit für eine Transaktion (nur für Inlandshändler) von 1 Minute bis 15 Tage Angaben erfolgen durch eine zweistellige Integer-Zahl plus eine Kennung: m (Minute) h (Stunde) d (Tag) Da nur ganzzahlige Werte zulässig sind, muss für 1,5 Stunden der Wert 90m verwendet werden. Zusätzlich bedeutet 1c bis zum Ende des aktuellen Tages. Nutzung ist nur in Abstimmung mit dem Computop Support möglich. |
CustomerID | ans..16 | O | eindeutige Kundennummer |
AccBank | ans..7 | OC | Pflicht für eBanking: Der Endkunde wird direkt zur angegebenen Bank weitergeleitet. Nur für Händler im Inland möglich. - ICBCBTB: Industrial and Commercial Bank of China - ABCBTB: Agricultural Bank of China - CCBBTB: China Construction Bank - SPDBB2B: Shanghai Pudong Development Bank - BOCB2C: Bank of China - ICBCB2C: Industrial and Commercial Bank of China - CMB: China Merchants Bank - CCB: China Construction Bank - ABC: Agricultural Bank of China - SPDB: Shanghai Pudong Development Bank - CIB: Industrial Bank - GDB: Guangdong Development Bank - SDB: Shenzhen Development Bank - CMBC: China Minsheng Banking - COMM: Bank of Communications - CITIC: China Citic Bank - HZCBB2C: Bank of Hangzhou - CEBBANK: China Everbright Bank - SHBANK: Bank of Shanghai - NBBANK: Bank of Ningbo - SPABANK: Ping An Bank - BJBANK: Bank of Beijing - BJRCB: Beijing Rural Commercial Bank - FDB: Fudian Bank - POSTGC: Postal Savings Bank of China - abc1003: Visa - abs1004: Master |
Device | a6 | O | bei Übergabe von „Mobile“ wird statt der Desktop-Version die Mobil-Version von Alipay aufgerufen |
FxCurrency | ans.. | OC | Währung für das Settlement. Drei Zeichen DIN / ISO 4217. |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Parameter für Zahlungen mit Alipay Website Payment
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:
Parameter | Format | CND | Beschreibung | |
---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird | |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien | |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..64 | M | Transaktionsnummer des Händlers | |
Status | a..50 | M | OK bei URLSuccess sowie Authorize_Request und FAILED bei URLFailure | |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
RefNr | ns..30 | O | eindeutige Referenznummer | |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop | |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID | |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei Alipay Website Payment
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:
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 | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
OrderDesc | ans..256 | M | Name der Transaktion, die in der Transaktionsliste angezeigt wird. |
OrderDesc2 | ans..256 | O | Transaktionsnotiz |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
BuyerIDCode | ans..32 | M | Code, der durch die Alipay-App generiert wurde. Er dient der Identifizierung eines Nutzers. |
Parameter für Zahlungen mit Alipay Spot Payment
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.) |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate den Parameter mit dem Zahlungsergebnis an den Shop |
RefNr | ns..30 | O | eindeutige Referenznummer |
ErrorText | ans..48 | O | Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit Computop Support abgesprochen (in MAT konfiguriert) ist. |
TID | ans..64 | O | Vom Alipay-System generierte TransaktionsID |
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:
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 | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
OrderDesc | ans..256 | M | Name der Transaktion, die in der Transaktionsliste angezeigt wird. |
OrderDesc2 | ans..256 | O | Transaktionsnotiz |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
URLNotify | ans..256 | O | Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData. Sie überschreibt die Händler-Konfiguration (“NotifyURL” in MAT). |
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 | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.) |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
RefNr | ns..30 | O | eindeutige Referenznummer |
ErrorText | ans..48 | O | Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit Computop Support abgesprochen (in MAT konfiguriert) ist. |
QRCodeURL | ans..128 | O | Wenn die Anfrage erfolgreich verarbeitet worden ist, wird eine QR-Code Url zurückgegeben, die in einen QR-Code umgewandelt werden kann. |
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 | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.) |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
RefNr | ns..30 | O | eindeutige Referenznummer |
ErrorText | ans..48 | O | Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit Computop Support abgesprochen (in MAT konfiguriert) ist. |
TID | ans..64 | O | Vom Alipay-System generierte TransaktionsID |
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:
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 | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Für Händler in China (Inland) ist nur CNY erlaubt, für Crossborder-Händler ist CNY nicht erlaubt. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
OrderDesc | ans..256 | M | Name der Transaktion, die in der Transaktionsliste angezeigt wird. |
OrderDesc2 | ans..400 | M | Beschreibung der gekauften Waren und ihrer Anzahl im Format goods_name1;quantity1+goods_name2;quantity2. <;> trennt Waren und Anzahl innerhalb eines Datensatzes Beispiel: iPhone X;1+iPhone 8;2 Die Sonderzeichen “#”, “&” and “%” sind hier nicht erlaubt. |
ShopURL | an..128 | M | URL des Web-Shops, zum Beispiel https://testmerchant.com |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
URLNotify | ans..256 | O | Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData. Sie überschreibt die Händler-Konfiguration (“NotifyURL” in MAT). |
FxCurrency | ans.. | OC | Währung für die Abrechnung. Drei Zeichen DIN / ISO 4217. Nur für Crossborder-Händler erlaubt, Pflicht wenn Currency=CNY. CNY ist hier nicht erlaubt. |
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 | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.) |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
RefNr | ns..30 | O | eindeutige Referenznummer |
RequestString | ans..128 | O | Wenn die Anfrage erfolgreich verarbeitet worden ist, wird der Anfrage-String zum Aufruf der Alipay-API In-App Payment zurückgegeben. |
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 | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Eventuell muss der Kunde die Zahlung mit seinem Payment-Passwort in der App bestätigen.) |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
RefNr | ns..30 | O | eindeutige Referenznummer |
ErrorText | ans..48 | O | Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit Computop Support abgesprochen (in MAT konfiguriert) ist. |
TID | ans..64 | O | Vom Alipay-System generierte TransaktionsID |
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:
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 | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die zu stornierende Transaktion |
TransID | ans..64 | M | ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs |
RefNr | ns..30 | O | eindeutige Referenznummer |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a..3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..256 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Parameter für Storno von Alipay Spot Payment oder QR-Code Payment
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ns..30 | O | Referenznummer des Händlers |
UserData | ans..256 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
ErrorText | ans..48 | O | Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit Computop Support abgesprochen (in MAT konfiguriert) ist. |
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:
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 | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die gutzuschreibende Transaktion |
TransID | ans..64 | M | Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang |
RefNr | ans..30 | O | Referenznummer des Händlers |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a..3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..256 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Parameter für Gutschrift von Alipay-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
UserData | ans..256 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
RefNr | ns..30 | O | Referenznummer des Händlers |
ErrorText | ans..48 | O | Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit Computop Support abgesprochen (in MAT konfiguriert) ist. |
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:
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 | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die gutzuschreibende Transaktion |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | O | Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a..3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..256 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
Parameter für Statusabfrage von Zahlungen mit Alipay Spot Payment
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK, FAILED sowie AUTHORIZE_REQUEST (Wenn noch kein endgültiger Status von Alipay vorliegt. Evtl. muss der Kunde die Zahlung mit seinem Payment Passwort in der Alipay-App bestätigen.) |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
UserData | ans..256 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
RefNr | ns..30 | O | Referenznummer des Händlers |
ErrorText | ans..48 | O | Fehlertext vom nachgelagertem System, nur wenn dessen Rückgabe mit Computop Support abgesprochen (in MAT konfiguriert) ist. |
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:
Aktion | Version | Beschreibung |
---|---|---|
Credit | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
Reverse | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2x. | mit RefNr (gilt für alle Versionen außer 1.0) |
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:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Type | a..11 | M | HEAD für Header, FOOT für Footer, Alipay für Alipay |
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift) Reverse (Storno) |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
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):
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift) Reverse (Gutschrift) |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
Status | a..50 | M | OK oder FAILED |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien