Diagramme zum Prozessablauf
Multiexcerpt include | ||||||||
---|---|---|---|---|---|---|---|---|
|
Paygate-Schnittstelle
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Aufruf der Schnittstelle für WeChat
Um eine WeChat-Zahlung über ein Paygate-Formular abzuwickeln, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Hinweis: Bei INAPP-Anfragen (Channel=APP) erfolgt der Aufruf über einer Server-zu-Server-Verbindung.
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 | an..32 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss | |
RefNr | an..32 | 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 inländische Händler ist zur CNY zulässig. Für Cross-Border-Händler ist nur GBP, HKD, USD, JPY, CAD, AUD, EUR, NZD, KRW, THB, SGD, RUB zulässig. | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
Channel | a..32 | M | Die WeChat-Zahlungsmethode: QRCode: QR-Code-Zahlung. Dem Kunden auf der PC-Webseite anzeigen. | |
OrderDesc | an..128 | M | Beschreibung der gekauften Waren, Einzelpreise etc. Die Sonderzeichen “#”,”&”, ”%” und “+” sind hier nicht erlaubt. | |
OrderDesc2 | an..2048 | O | Ausführliche Artikelliste. Jeder Artikel durch Semikolon (;) getrennt. Beispiel: BookID:10,BookPrice:120;PenID:10,Material:Steel | |
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 | M | 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. | |
UserData | ans..1024 | 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. | |
IPAddr | ns..16 | O | Betrugsprävention: IP-Adresse | |
TimeOut | n..14 | O | Zeitlimit für die Transaktion. Einheit: Minuten. Mindestens 5 Minuten. | |
GoodsCategory | an..32 | O | Beabsichtigter Zweck auf Rabatt-Coupon | |
ProductNr | an..32 | O | Äquivalent zur Produkt ID zur Identifikation des Produkts | |
Limit | bool | O | Wenn true, werden keine Kreditkarten akzeptiert, anderernfalls werden Kreditkarten akzeptiert | |
ShopSystem | a..8 | C | Pflicht bei W2A. Genutzte Plattform, mögliche Werte: IOS/Android/WAP. | |
ShopName | an..120 | C | Pflicht bei W2A. Name der App für IOS/Android; Name der Webseite für WAP. | |
ShopURL | an..128 | C | Pflicht bei W2A. BundleID bei IOS; Paket-Name bei Android, Wap-URL bei WAP. | |
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 WeChat
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 | an..32 | M | Transaktionsnummer des Händlers |
RefNr | an..32 | O | eindeutige Referenznummer |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
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..1024 | C | Nicht bei Channel=INAPP: Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
PrepayID | ans..64 | C | Nur bei Channel=INAPP: erforderlich zum Aufruf vom Paygate Payment SDK |
CodeExt | an..32 | O | Fehlercode von Wechat |
ErrorText | ans..128 | O | Ausführliche Fehlermeldung von Wechat |
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
Barcode-Zahlung
Verwenden Sie bitte folgende URL, um WeChat Barcode-Zahlungen über eine Server-zu-Server-Verbindung abzuwickeln:
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 | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
OrderDesc | an..128 | M | Beschreibung gekaufter Waren, Einzelpreise usw. Die Sonderzeichen “#”, “&”, “%” und “+” sind hier nicht zulässig. | |
OrderDesc2 | an..2048 | O | Warendetails | |
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. | |
UserData | ans..1024 | 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. | |
TimeOut | n..14 | O | Zeitlimit für eine Transaktion. Einheit: Minuten. Mindestens 1 Minute. | |
GoodsCategory | an..32 | O | Beabsichtigter Zweck auf dem Rabatt-Coupon | |
Limit | bool | O | Wenn true, akzeptiert die Zahlunge keine Kreditkarten, anderenfalls akzeptiert sie Kreditkarten | |
BuyerIDcode | n128 | M | Zahlungscode des Kunden mit feste Länge |
Parameter für Barcode-Zahlungen mit WeChat
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 |
RefNr | ns..30 | O | eindeutige Referenznummer |
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..1024 | C | Wenn beim Aufruf angegeben, übergibt das Paygate den Parameter mit dem Zahlungsergebnis an den Shop |
CodeExt | an..32 | O | Fehlercode von Wechat |
ErrorText | ans..128 | O | Ausführliche Fehlermeldung von Wechat |
Ergebnis-Parameter für Barcode-Zahlungen mit WeChat
QRCode (Server-Modus)
Verwenden Sie bitte folgende URL, um eine WeChat-Zahlung mit QRCode im Server-Modus abzuwickeln:
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 | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
OrderDesc | an..128 | M | Beschreibung der gekauften Waren, Einzelpreise usw. Die Sonderzeichen “#”, “&”, “%” und “+” sind hier nicht zulässig. | |
OrderDesc2 | an..2048 | O | Ausführliche Artikelliste. Jeder Artikel ist durch ein Semikolon (;) getrennt. Beispiel: BuchID:10,BuchPreise:120;StiftID:10,Material:Stahl | |
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. | |
UserData | ans..1024 | 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. | |
IPAddr | ns..16 | O | Betrugsprävention: IP-Adresse des Kunden | |
TimeOut | n..14 | O | Zeitlimit für eine Transaktion. Einheit: Minuten. Mindestens 5 Minuten. | |
GoodsCategory | an..32 | O | Beabsichtiger Zweck auf dem Rabatt-Coupon | |
ProductNr | an..32 | O | Äquivalent der Product ID zur Identifizierung des Produkts | |
Limit | bool | O | Wenn true, akzeptiert die Zahlunge keine Kreditkarten, anderenfalls akzeptiert sie Kreditkarten |
Parameter für QRCode-Zahlungen mit WeChat im Server-Modus
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 |
RefNr | ns..30 | O | eindeutige Referenznummer |
Channel | a..32 | M | QRCode |
Status | a..50 | M | AUTHORIZE_REQUEST 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..1024 | C | Wenn beim Aufruf angegeben, übergibt das Paygate den Parameter mit dem Zahlungsergebnis an den Shop |
QRCodeUrl | ans..64 | C | QRCode Url. Gibt es nur, wenn kein Fehler auftritt. |
CodeExt | an..32 | O | Fehlercode von Wechat |
ErrorText | ans..128 | O | Ausführliche Fehlermeldung von Wechat |
Ergebnis-Parameter für QRCode-Zahlungen mit WeChat im Server-Modus
Storno
Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Zahlung über eine Server-zu-Server-Verbindung zu stornieren, 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 Stornierungen von WeChat-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | MC | 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) |
Ergebnis-Parameter für Stornierungen
Gutschrift mit Referenz
Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorangegangen Buchung 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 | an..32 | M | Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang | |
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. Für inländische Händler ist zur CNY zulässig. Für Cross-Border-Händler ist nur GBP, HKD, USD, JPY, CAD, AUD, EUR, NZD, KRW, THB, SGD, RUB zulässig. | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
RefNr | an..32 | M | eindeutige Referenznummer | |
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 WeChat-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 | an..32 | 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 | an..32 | M | eindeutige Referenznummer |
CodeExt | an..32 | O | Fehlercode von Wechat |
ErrorText | ans..128 | O | Ausführliche Fehlermeldung von Wechat |
Ergebnis-Parameter für Gutschrift von WeChat-Zahlungen