Paygate-Schnittstelle
| Multiexcerpt include | ||||||
|---|---|---|---|---|---|---|
|
Zahlung mit ChinaPay via Formular-Schnittstelle
Um eine ChinaPay-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.
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 | Transaktionsnummer des Händlers, die 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 | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
OrderDesc | ans..768 | M | Beschreibung der Waren, Einzelpreise usw. Die Sonderzeichen “&”, “%” und “+” sind hier nicht zulässig. Format: Anzahl der Artikelkategorien#Gesamtanzahl der Artikel#Artikel1 Name^Artikel1 Preis^Artikel1 Anzahzl#Artikel2 Name^Artikel2 Preis^Artikel2 Anzahl...#Artikel{m} Name^Artikel{m} Preis^Artikel{m} Anzahl Format des Artikelpreises: 3-stelliges Währungscode + Ganzzahl mit bis zu 16 Ziffern + ein Dezimalpunkt + 2 Dezimalstellen, z.B. CNY100000.00 Die tatsächliche Gesamtanzahl der Artikel muss größer oder gleich (>=) Anzahl der Artikelkategorien sein. | |
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. | |
Timeout | ans..3 | O | Zeitlimit für die Transaktion | |
Channel | n..4 | O | 0001-B2C; 0002-B2B. Standardwert 0001 | |
AccBank | n..15 | C | Pflicht für E-Banking: der Endkunde wird direkt zur angegebenen Bank weitergeleitet. Nur möglich für Inlandskunden. | |
PayoutList | ans..24 | C | Nur für Split-Zahlungen. Nicht ausfüllen, wenn kein Split vorliegt. Einzelne Werte werden durch „;“ getrennt. SplitType: 0001: Echtzeit-Split; 0002: verzögerter Split Zum Beispiel: “0001;0;xxx^200, xxx^200, xxx^200” (Hinweis: ”xxx” ist die merchantID des PSPs) | |
CustomParameter | ans.. | O | Zusätzliche Parameter für Transaktionen, die per Semikolon getrennt werden. Sie können 11 Felder verwenden. Die Länge von BusId soll weniger als 8 sein, die Werte P1 bis P10 weniger als 512. BusId;P1;P2;P3;P4;P5;P6;P7;P8;P9;P10 Zum Beispiel: 00000001;123;451;124 | |
TimeStamp | n..20 | O | Zeit des Händlersystems in Millisekunden | |
IPAddr | a..15 | O | IP-Adresse des Client-Browsers | |
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 ChinaPay
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure oder 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, die für eine Zahlung durchgeführt werden |
TransID | an..32 | M | Transaktionsnummer des Händlers |
RefNr | an..32 | O | Referenznummer des Händlers |
Status | a..30 | M | OK, PENDING oder AUTHORIZE_REQUEST bei URLSuccess sowie 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 |
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 URLSuccess, URLFailure und URLNotify bei ChinaPay
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ährung, drei Zeichen DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
RefNr | an..32 | O | Referenznummer des Händlers (z.B. Rechnungsnummer) |
| 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 Gutschriften bei ChinaPay
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, die eindeutig sein muss | |
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 | O | Referenznummer des Händlers (z.B. Rechnungsnummer) | |
Ergebnis-Parameter für Gutschriften bei ChinaPay