Über paydirekt
Allgemeines zu paydirekt
paydirekt ist ein neuer Online-Bezahlservice aller deutschen Banken und Sparkassen und daher genauso vertrauenswürdig wie das eigene Finanzinstitut. Dreh- und Angelpunkt von paydirekt ist das bewährte Girokonto, über welches die gesamte Abwicklung vorgenommen wird.
Der Käufer meldet sich für paydirekt über das Online-Banking seiner Hausbank an. Jede Zahlung wird durch die Hausbank des Käufers autorisiert und unmittelbar am Girokonto verbucht. Die Authentifikation des Käufers erfolgt durch ein adaptives Authentifizierungsverfahren. Bei jeder Zahlung ist zugleich eine Altersverifikation möglich.
Vorteile für den Händler sind die einfache Anbindung von paydirekt in das Shopsystem, eine hohe Transaktionssicherheit durch die Abwicklung der beteiligten Banken und Sparkassen und deren Bonitätsprüfung, die bestehende Zahlungsgarantie, sobald nach positiver Zahlungsbestätigung die Buchung ausgelöst ist, sowie die einfache Handhabung von Retouren und Reklamationen.
Logo |
|
Info | Über paydirekt lassen sich Online-Einkäufe einfach und direkt vom Girokonto bezahlen. Händler profitieren von einer den strengen Anforderungen der deutschen Kreditwirtschaft entsprechenden Alternative zu bestehenden Online-Bezahlverfahren. |
Type |
Weitere Informationen finden Sie auch auf der Webseite von paydirekt (https://www.paydirekt.de).
Diagramm zum Prozessablauf
paydirekt Prozessablauf
Paygate-Schnittstelle
Definitionen
Datenformate
Format | Beschreibung |
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) |
Abkürzungen
Abkürzung | Beschreibung | Kommentar |
CND | Bedingung (condition) | |
M | Pflicht (mandatory) | Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein |
O | optional | Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich |
C | bedingt (conditional) | Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist |
Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.
Aufruf der paydirekt-Schnittstelle
Eine Zahlung mittels paydirekt kann in zwei Schritten erfolgen, wobei zunächst eine Zahlung für eine Bestellung initialisiert wird, bevor Sie diese dann beim Versand der Ware separat buchen. Alternativ kann die Zahlung auch in einem Schritt als Sale-Transaktion erfolgen. Die Folgetransaktionen erfolgen dann über eine Server-zu-Server-Verbindung. Damit können Sie diese Zahlungen buchen oder bei einer Rückgabe eine Gutschrift erteilen. Um eine Zahlung mit paydirekt über ein Paygate-Formular abzuwickeln, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/paydirekt.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:
| Key | REST | Format | CND | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. | ||||||||||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |||||||||
ans..30 | O | Eindeutige Referenznummer des Händlers | ||||||||||
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||||||||||
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | ||||||||||
––– | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |||||||||
OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise etc. | |||||||||
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||||||||||
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. Allgemeine Hinweise:
| ||||||||||
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. Allgemeine Hinweise:
| ||||||||||
––– | 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. | |||||||||
ans..256 | M | Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. Allgemeine Hinweise:
| ||||||||||
ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. | ||||||||||
an..6 | OM | Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).
| ||||||||||
ShopApiKey | ans..64 | M | API-Key des Shops bei paydirekt | |||||||||
shAmount | n..10 | O | Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | |||||||||
ShoppingBasketAmount | n..10 | O | Warenwert der Bestellung ohne Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | |||||||||
ArticleList | ans..1024 | O | Artikelliste mit Beschreibung der Waren und Preise: <Menge>;<Name>;<EAN>; <Preis> <;> trennt Felder innerhalb eines Artikeldatensatzes<+> trennt mehrere Artikeldatensätze Menge: Anzahl der Positionen des Artikels Name: Bezeichnung des Artikels EAN: Internationale Artikelnummer (EAN bzw. GTIN), (falls nicht bekannt, dann als Leerstring „“) Preis: Einzelpreis des Artikels inkl. Steuern; Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) | |||||||||
ans..100 | O | E-Mail-Adresse des Kunden | ||||||||||
MinAge | n..3 | O | Mindestalter in Jahren | |||||||||
ShoppingBasketCategory | ans..32 | O | Kategorisiert den Warenkorb: „DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern „PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern „MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern "ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende "AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen | |||||||||
sdFirstName | ans..50 | C | Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ | |||||||||
dLastName | ans..50 | C | Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ | |||||||||
sdCompany | ans..100 | O | Firmenname in der Lieferanschrift | |||||||||
sdAddressAddition | ans..30 | O | Adresszusatz in der Lieferanschrift | |||||||||
sdStreet | "shipping": {"addressInfo": {"addressLine1": {"street": "..." }}} | ans..100 | C | Straßenname in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | ||||||||
sdStreetNr | "shipping": {"addressInfo": {"addressLine1": {"streetNumber": "..." }}} | ans..8 | C | Hausnummer in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | ||||||||
sdZip | n..5 | C | Postleitzahl in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |||||||||
sdCity | ans..100 | C | Ort in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |||||||||
sdCountryCode | an2 | C | Ländercode in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |||||||||
sdEmail | ans..100 | C | E-Mail-Adresse des Empfängers Pflicht, wenn ShoppingBasketCategory = „DIGITAL“ | |||||||||
Note | ans..37 | O | Text, der dem Kunden im Verwendungszweck angezeigt wird | |||||||||
CustomerID | ans..64 | O | Kundennummer | |||||||||
OverCapture | bool | O | Flag für Overcapture-Checkouts. Standard ist false. Bei einem Overcapture-Checkout darf die Summe der Captures den Warenwert der Bestellung um bis zu 10% übersteigen. Overcapture darf nur bei einem Checkout des Typs ORDER aktiviert sein. OverCapture kann nur von Händlern verwendet werden, die bei paydirekt und Computop für dieses Feature freigeschaltet wurden. | |||||||||
DeliveryMethod | ans..12 | O | Lieferort: STANDARD, PACKSTATION oder STORE_PICKUP. Der Standardwert ist STANDARD. STANDARD: Die Güter werden an eine gewöhnliche Postadresse geliefert. PACKSTATION: Die Güter werden an eine Packstation geliefert. STORE_PICKUP: Die Güter werden in der Filiale abgeholt. Dieses Feld enthält bei Express-Checkouts immer den Wert STANDARD und wird nicht anhand der gewählten Lieferoption aktualisiert. | |||||||||
DeliveryDate | dttm | O | Erwartetes Versanddatum im Format JJJJ-MM-TT | |||||||||
ParcelService | ans..16 | O | Paket-Dienstleister | |||||||||
TrackingNumber | ans..64 | O | Sendungsnummer | |||||||||
ans..50 | O | Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID. Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. | ||||||||||
ans..1024 | O | Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate -Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück. Hier finden Sie ein Beispiel: Custom |
Parameter für Zahlungen mit paydirekt
Bei Verwendung der REST-API
Bei Verwendung der REST-API erhalten Sie immer einen Link, über den der Händler den Verbraucher umleiten muss, um die Zahlung abzuschließen.
REST | Format | CND | Beschreibung |
"paymentId": "..." | an32 | M | Kann "00000000000000000000000000000000" lauten, wenn dies noch nicht vom Paygate festgelegt wurde |
"_Links.self.type": "..." | an..20 | M | "application/json" |
"_Links.redirect.href": "..." | an..1024 | M | Der Händler muss den Kunden zu dieser URL weiterleiten, um die Zahlung abzuschließen |
"_Links.redirect.type": "..." | an..20 | M | "text/html" |
Der Händler kann inquire.aspx verwenden
Bei Verwendung der Key-Value-Pair-API
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. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird | |
an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. | |
an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
a..50 | M | OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure) | |
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! | |
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |
ans..30 | O | Eindeutige Referenznummer des Händlers | |
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | |
TID | ans..32 | O | Eindeutige Identifikation des Vorgangs und aller dazugehörigen Transaktionen bei paydirekt. Diese ID ist vorhanden, sobald sich ein Kunde auf der Checkout-Seite eingeloggt hat. |
Reference | ans..36 | M | Eindeutige ID des Vorgangs bei paydirekt |
TransactionID | ans36 | O | Eindeutige Transaktions-ID (UUID). Der Wert wird durch das paydirekt-System vergeben. |
ShoppingBasketCategory | ans..32 | O | Kategorisiert den Warenkorb: „DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern „PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern „MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern "ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende "AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen |
sdFirstName | ans..50 | C | Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ |
sdLastName | ans..50 | C | Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ |
sdCompany | ans..100 | O | Firmenname in der Lieferanschrift |
sdAddressAddition | ans..30 | O | Adresszusatz in der Lieferanschrift |
sdStreet | ans..100 | C | Straßenname in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" |
sdStreetNr | ans..8 | C | Hausnummer in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" |
sdZip | n..5 | C | Postleitzahl in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" |
sdCity | ans..100 | C | Ort in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" |
sdCountryCodey | an2 | C | Ländercode in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" |
sdEMail | ans..100 | C | E-Mail-Adresse des Empfängers Pflicht, wenn ShoppingBasketCategory = „DIGITAL“ |
AgeAccepted | a..12 | O | ACCEPTED oder NOT ACCEPTED |
ans..50 | O | Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID. Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. | |
ans..1024 | O | Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate -Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück. Hier finden Sie ein Beispiel: Custom |
Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei paydirekt
paydirekt oneKlick
Im Gegensatz zum Standard-Checkout muss sich der Kunde für oneKlick einmalig registrieren. Die Registrierung stellt im Paygate ein eigenes Payment dar (AUTHORIZE), das aber nicht für weitere Aktionen nutzbar ist. Bei erfolgreicher Registrierung gibt das Paygate einen Token zurück (BillingAgreementID), der für alle nachfolgenden oneKlick-Transaktionen genutzt werden kann. Außerdem muss der Kunde eine E-Mail bestätigen, erst danach kann oneKlick genutzt werden.
Optional kann eine URL angegeben werden, an die eine Benachrichtigung geschickt wird, wenn der Kunde die E-Mail bestätigt oder widerrufen hat. Diese URL kann statisch in der Händlerkonfiguration hinterlegt werden oder durch den Request-Parameter "URLConfirm" übergeben werden.
Bei einem oneKlick-Checkout muss die BillingAgreementID ans Paygate gesendet werden. Statt der Weiterleitung an paydirekt wird der Checkout nun ohne weitere Bestätigung des Kunden abgeschlossen.
oneKlick-Registrierung
Die oneKlick-Registrierung kann als separater Prozess oder im Zuge eines Checkouts erfolgen. Die separate Registrierung verläuft über ein eigenes Formular. Nach der Registrierung erfolgen alle Folgetransaktionen über eine Server-zu-Server-Verbindung. Mit oneKlick können Sie Zahlungen trennen in Autorisierung und Buchung oder sofort buchend (SALE).
Die separate oneKlick-Registrierung als auch die Registrierung bei Checkout erfolgen immer über das Paygate-Formular mit der folgenden URL:
https://www.computop-paygate.com/paydirekt.aspx
Hinweis: Die DeviceID oder der DeviceFingerPrint müssen für jedes Endgerät des Kunden eindeutig sein. Paydirekt bietet für iOS und Android ein SDK an, um eine eindeutige DeviceId zu erzeugen. Für Webanwendungen können Libraries wie Fingerprint.js (https://github.com/Valve/fingerprintjs2) verwendet werden, um einen eindeutigen Fingerprint zu erhalten.
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:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
ans..30 | O | Eindeutige Referenznummer des Händlers | ||
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |
OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise etc. | |
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||
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. Allgemeine Hinweise:
| ||
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. Allgemeine Hinweise:
| ||
––– | 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. | |
ans..256 | M | Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. Allgemeine Hinweise:
| ||
URLConfirm | ans..256 | O | Vollständige URL, die das Paygate aufruft, wenn der Kunde die E-Mail zur oneKlick-Registrierung bestätigt hat oder die Registrierung widerrufen hat. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten. | |
ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. | ||
ShopApiKey | ans..64 | M | API-Key des Shops bei paydirekt | |
EventToken | a8 | M | "oneKlick": Weiterleitung zur paydirekt-Anmeldeseite für OneKlick. "recurring": Weiterleitung zur paydirekt-Anmeldeseite für Recurring-OneKlick. Zusätzlich können Angaben zum Zahlplan im Parameter usageAgreement mitgegeben werden. Diese werden dann auf der paydirekt-Anmeldeseite angezeigt. "ADS" – Anmeldung zu OneKlick während des Checkouts (während des Checkouts kann keine Anmeldung für recurring erfolgen). Für die Anmeldung zu OneKlick während des Checkouts müssen zusätzlich auch die für die OneKlick-Anmeldung notwendigen Device-Parameter mitgesendet werden. | |
usageAgreement | ans..256 | C | Optional, wenn EventToken="recurring": Details für wiederkehrende Zahlungen im JSON-Format. Siehe unten. | |
DeviceId | ans..64 | C | Eindeutige Device-ID zur Identifikation des Endgeräts des Käufers. Pflicht, wenn DeviceFingerPrint nicht übergeben wird. | |
DeviceFingerPrint | ans..64 | O | Fingerprint des Endgeräts des Käufers zum Zeitpunkt der Autorisierungsanlage | |
Device | ans..20 | M | Name des Endgeräts des Käufers – wird dem Käufer in seinen Portalen angezeigt. | |
ans..50 | O | Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID. Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. | ||
ans..1024 | O | Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate -Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück. Hier finden Sie ein Beispiel: Custom |
Parameter für oneKlick-Registrierung mit paydirekt
usageAgreement
| Key | Format | CND | Description |
|---|---|---|---|
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | |
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | |
StartDate | ans10 | M | Datum der ersten Zahlung im Format "JJJJ-MM-TT" |
IntervalUnit | a..7 | M | Zahlungsintervall ("DAY","WEEK","MONTH","QUARTER","YEAR") |
Interval | n.. | M | Frequenz der Zahlung |
Beispiel usageAgreement als JSON-String
1{2 "amount":{3 "amount":50,4 "currency":"EUR"5 },6 "startDate":"2019-09-01",7 "recurrenceInterval":{8 "intervalUnit":"WEEK",9 "interval":810 }11}Der im JSON-Format erstellte Parameter muß Base64 encodiert werden.
Bei Verwendung der REST-API
Bei Verwendung der REST-API erhalten Sie immer einen Link, über den der Händler den Verbraucher umleiten muss, um die Zahlung abzuschließen.
REST | Format | CND | Beschreibung |
"paymentId": "..." | an32 | M | Kann "00000000000000000000000000000000" lauten, wenn dies noch nicht vom Paygate festgelegt wurde |
"_Links.self.type": "..." | an..20 | M | "application/json" |
"_Links.redirect.href": "..." | an..1024 | M | Der Händler muss den Kunden zu dieser URL weiterleiten, um die Zahlung abzuschließen |
"_Links.redirect.type": "..." | an..20 | M | "text/html" |
Der Händler kann inquire.aspx verwenden
Bei Verwendung der Key-Value-Pair-API
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. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird | |
an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. | |
an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
a..50 | M | OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure) | |
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! | |
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |
ans..30 | O | Eindeutige Referenznummer des Händlers | |
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | |
BillingAgreementID | an..44 | O | CustomerAuthorizationReference einer gültigen Käuferautorisierung. Zweck: Rechterweiterung des ausgestellten Tokens um die Möglichkeit, Aktionen im Namen dieses Käufers innerhalb des in der Autorisierung enthaltenen Scopes durchzuführen. Wird für oneKlick-Checkouts benötigt. |
ans..50 | O | Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID. Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. | |
ans..1024 | O | Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate -Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück. Hier finden Sie ein Beispiel: Custom |
Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei paydirekt
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLConfirmübergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird | |
an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. | |
an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) | |
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! | |
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |
BillingAgreementID | an..44 | O | CustomerAuthorizationReference einer gültigen Käuferautorisierung. |
AuthorizationStatus | an..50 | APPROVED, REVOKED oder EXPIRED |
Ergebnis-Parameter für URLConfirm bei paydirekt
Aufruf der paydirekt oneKlick-Schnittstelle
Zahlungen mit oneKlick sind mit Hilfe der BillingAgreementID über eine Server-zu-Server-Kommunikation möglich. Zahlungen mittels oneKlick sind als Autorisierung möglich, die dann separat gebucht werden muss, oder auch als Sale-Transaktion mit sofortiger Buchung.
Um eine oneKlick-Zahlung mit paydirekt über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/oneKlick.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:
| Key | REST | Format | CND | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. | ||||||||||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |||||||||
ans..30 | O | Eindeutige Referenznummer des Händlers | ||||||||||
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||||||||||
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | ||||||||||
––– | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |||||||||
OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise etc. | |||||||||
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||||||||||
ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. | ||||||||||
an..6 | OM | Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).
| ||||||||||
ShopApiKey | ans..64 | M | API-Key des Shops bei paydirekt | |||||||||
shAmount | n..10 | O | Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | |||||||||
ShoppingBasketAmount | n..10 | O | Warenwert der Bestellung ohne Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | |||||||||
ArticleList | ans..1024 | O | Artikelliste mit Beschreibung der Waren und Preise: <Menge>;<Name>;<EAN>; <Preis> <;> trennt Felder innerhalb eines Artikeldatensatzes<+> trennt mehrere Artikeldatensätze Menge: Anzahl der Positionen des Artikels Name: Bezeichnung des Artikels EAN: Internationale Artikelnummer (EAN bzw. GTIN), (falls nicht bekannt, dann als Leerstring „“) Preis: Einzelpreis des Artikels inkl. Steuern; Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) | |||||||||
ans..100 | O | E-Mail-Adresse des Kunden | ||||||||||
MinAge | n..3 | O | Mindestalter in Jahren | |||||||||
ShoppingBasketCategory | ans..32 | O | Kategorisiert den Warenkorb: „DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern „PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern „MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern "ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende "AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen | |||||||||
sdFirstName | ans..50 | C | Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ | |||||||||
dLastName | ans..50 | C | Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ | |||||||||
sdCompany | ans..100 | O | Firmenname in der Lieferanschrift | |||||||||
sdAddressAddition | ans..30 | O | Adresszusatz in der Lieferanschrift | |||||||||
sdStreet | "shipping": {"addressInfo": {"addressLine1": {"street": "..." }}} | ans..100 | C | Straßenname in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | ||||||||
sdStreetNr | "shipping": {"addressInfo": {"addressLine1": {"streetNumber": "..." }}} | ans..8 | C | Hausnummer in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | ||||||||
sdZip | n..5 | C | Postleitzahl in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |||||||||
sdCity | ans..100 | C | Ort in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |||||||||
sdCountryCode | an2 | C | Ländercode in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |||||||||
sdEmail | ans..100 | C | E-Mail-Adresse des Empfängers Pflicht, wenn ShoppingBasketCategory = „DIGITAL“ | |||||||||
IPAddress | ans..15 | M | IP-Adresse des Kunden | |||||||||
Note | ans..37 | O | Text, der dem Kunden im Verwendungszweck angezeigt wird | |||||||||
CustomerID | ans..64 | O | Kundennummer | |||||||||
DeliveryMethod | ans..12 | O | Lieferort: STANDARD, PACKSTATION oder STORE_PICKUP. Der Standardwert ist STANDARD. STANDARD: Die Güter werden an eine gewöhnliche Postadresse geliefert. PACKSTATION: Die Güter werden an eine Packstation geliefert. STORE_PICKUP: Die Güter werden in der Filiale abgeholt. Dieses Feld enthält bei Express-Checkouts immer den Wert STANDARD und wird nicht anhand der gewählten Lieferoption aktualisiert. | |||||||||
DeliveryDate | dttm | O | Erwartetes Versanddatum im Format JJJJ-MM-TT | |||||||||
ParcelService | ans..16 | O | Paket-Dienstleister | |||||||||
TrackingNumber | ans..64 | O | Sendungsnummer | |||||||||
BillingAgreementID | an..44 | O | CustomerAuthorizationReference einer gültigen Käuferautorisierung. Zweck: Rechterweiterung des ausgestellten Tokens um die Möglichkeit, Aktionen im Namen dieses Käufers innerhalb des in der Autorisierung enthaltenen Scopes durchzuführen. Wird für oneKlick-Checkouts benötigt. |
Parameter für Zahlungen mit paydirekt oneKlick
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. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird | ||
an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. | ||
an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
a..50 | M | OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure) | ||
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! | ||
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | ||
ans..30 | O | Eindeutige Referenznummer des Händlers | ||
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||
TID | ans..32 | O | Eindeutige Identifikation des Vorgangs und aller dazugehörigen Transaktionen bei paydirekt. Diese ID ist vorhanden, sobald sich ein Kunde auf der Checkout-Seite eingeloggt hat. | |
Reference | ans..36 | M | Eindeutige ID des Vorgangs bei paydirekt | |
TransactionID | ans36 | O | Eindeutige Transaktions-ID (UUID). Der Wert wird durch das paydirekt-System vergeben. | |
ShoppingBasketCategory | ans..32 | O | Kategorisiert den Warenkorb: „DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern „PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern „MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern "ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende "AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen | |
sdFirstName | ans..50 | C | Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ | |
dLastName | ans..50 | C | Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“ | |
sdCompany | ans..100 | O | Firmenname in der Lieferanschrift | |
sdAddressAddition | ans..30 | O | Adresszusatz in der Lieferanschrift | |
sdStreet | "shipping": {"addressInfo": {"addressLine1": {"street": "..." }}} | ans..100 | C | Straßenname in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" |
sdStreetNr | "shipping": {"addressInfo": {"addressLine1": {"streetNumber": "..." }}} | ans..8 | C | Hausnummer in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" |
sdZip | n..5 | C | Postleitzahl in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |
sdCity | ans..100 | C | Ort in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |
sdCountryCode | an2 | C | Ländercode in der Lieferanschrift Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION" | |
sdEmail | ans..100 | C | E-Mail-Adresse des Empfängers Pflicht, wenn ShoppingBasketCategory = „DIGITAL“ | |
AgeAccepted | a..12 | O | ACCEPTED oder NOT ACCEPTED |
Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei paydirekt oneKlick
Buchung
Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für paydirekt über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
https://www.computop-paygate.com/capture.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:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. | ||
an32 | M | Vom Paygate vergebene ID für die zu buchende Zahlung | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
RefNr | ns..30 | O | Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden | |
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |
OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise etc. | |
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||
ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. | ||
CompleteType | ans..3 | O | Wird <YES> übergeben, wird bei der Buchung die mögliche offene Order von paydirekt geschlossen. | |
Note | ans..37 | O | Text, der dem Kunden im Verwendungszweck angezeigt wird |
Parameter für paydirekt-Buchungen
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. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird | ||
an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. | ||
an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
Status | a..50 | M | OK, CAPTURE_REQUEST oder FAILED | |
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! | ||
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | ||
ans..30 | O | Eindeutige Referenznummer des Händlers | ||
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||
TransactionID | ans36 | O | Eindeutige Transaktions-ID dieser Buchung (UUID). Der Wert wird durch das paydirekt-System vergeben. |
Ergebnis-Parameter für paydirekt-Buchungen
Gutschrift mit Referenz
Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Gutschriften sind bis zum Betrag von 200% über Buchung möglich, wenn das vomComputop Helpdesk für die Zahlungsart beim Händler konfiguriert wurde. 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:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. | ||
an32 | M | Vom Paygate vergebene ID für die gutzuschreibende Zahlung | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
RefNr | ns..30 | O | Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss | |
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |
OrderDesc | ans..768 | O | Beschreibung der gekauften Waren, Einzelpreise etc. | |
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||
ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. | ||
Note | ans..37 | O | Text, der dem Kunden im Verwendungszweck angezeigt wird |
Parameter für Gutschrift von paydirekt-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. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird | ||
an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. | ||
an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) | ||
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! | ||
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | ||
ans..30 | O | Eindeutige Referenznummer des Händlers | ||
ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. | ||
TransactionID | ans36 | O | Eindeutige Transaktions-ID (UUID). Der Wert wird durch das paydirekt-System vergeben. |
Ergebnis-Parameter für Gutschrift von paydirekt-Zahlungen
Aufruf der Schnittstelle für Stornierungen
Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Transaktion bei paydirekt zu stornieren, 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:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. | ||
an32 | M | Vom Paygate vergebene ID für die zu stornierende Zahlung | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: | |
ans..32 | O | Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht. |
Parameter für Storno von paydirekt-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. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | HändlerID, die von Computop vergeben wird | ||
an32 | M | Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. | ||
an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | ||
TransID | ans..20 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden. | |
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | ||
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | ||
a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) | ||
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! | ||
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Ergebnis-Parameter für Storno von paydirekt-Zahlungen
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 paydirekt-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:
Action | Version | Beschreibung |
Capture | 1.0 / 2.0 | Standardversion ohne Rückgabe von Parameter Code |
1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) | |
Credit | 1.0 / 2.0 | Standardversion ohne Rückgabe von Parameter Code |
1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
Beschreibung der möglichen Batch-Versionen
Der Aufbau für eine paydirekt-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
1HEAD,<MerchantID>,<Date>,<Version>2PAYDIREKT,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>3PAYDIREKT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>4PAYDIREKT,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>5FOOT,<CountRecords>,<SumAmount>Beispiel für Master-MID-Funktion:
1HEAD,[Master]MerchantID,Date,2.x2Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)3FOOT,CountRecords,SumAmountDie folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
| Key | Format | CND | Description |
|---|---|---|---|
Type | a..11 | M | HEAD für Header, FOOT für Footer, PAYDIREKT für Paydirekt |
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) Reverse (Storno) |
n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | |
a3 | M | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle | |
ans..64 | M | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss | |
ans..30 | O | Eindeutige Referenznummer des Händlers | |
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:
1HEAD,<MerchantID>,<Date>,<Version>2PAYDIREKT,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>3PAYDIREKT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>4PAYDIREKT,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>5FOOT,<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):
| Key | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) Reverse (Storno) |
an32 | M | Vom Paygate vergebene ID für diese Transaktion | |
a..50 | M | OK (URLSuccess) oder FAILED (URLFailure) | |
an8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien