Paygate-Schnittstelle
Datenformate: 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: CND Bedingung (condition) M Pflicht (mandatory) O optional C bedingt (conditional) Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.Definitionen
Format Beschreibung Abkürzung Beschreibung Kommentar Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist
Aufruf der MasterPass-Schnittstelle für V2
Eine Kreditkartenzahlung per MasterPass-Checkout besteht stets aus zwei Schritten. Zunächst werden in der MasterPass-Transaktion über die Schnittstelle MasterPass.aspx die benötigten Kreditkartendaten ermittelt. Anschließend muss über die separate Schnittstelle directmp.aspx die eigentliche Kreditkartentransaktion ausgeführt werden. Diese erfolgt über eine Server-zu-Server-Verbindung und unterstützt dabei alle Möglichkeiten der üblichen Kreditkartentransaktionen. Im Unterschied dazu übergeben Sie jedoch nicht die Ihnen unbekannten Kreditkartendaten, sondern die von MasterPass zuvor im ersten Schritt erhaltenen IDs.
Um eine Kreditkartenzahlung über MasterPass auszuführen, 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 | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | M | Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden! |
Amount | n..10 | M | Gesamtsumme aller Artikel des Warenkorbs ohne Lieferkosten. 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 | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
OrderDesc | ans..200 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
ArticleList | ans..768 | M | Artikelliste mit Beschreibung der Waren und Preise: <Artikelbeschreibung>;<Menge>;<Preis>; <Image-Url> <;> trennt Felder innerhalb eines Artikeldatensatzes Artikelbeschreibung: max. 50 Zeichen Menge: Stückzahl ohne Komma Preis: Menge * Einzelpreis Image-Url: optional; Bild 40x40 Pixel aus dem Shop |
AcceptableCards | ans..100 | M | Kartenlabels, die dem Käufer auf der MasterPass-Seite zur Auswahl angezeigt werden. Kommaseparierte Werte ohne Leerzeichen. Zulässig: master,amex,diners,discover,maestro,visa |
ShippingProfile | ans..5 | O | Shipping Location Profile ID: US, CS, FR, MEX, NA, UK |
SuppressShippingAddress | ans..5 | O | bei true wird die Lieferadresse auf der MasterPass-Seite nicht angezeigt, z.B. bei digitalen Gütern |
RewardProgram | ans..5 | O | true, wenn Reward-Daten zurückgegeben werden sollen |
AuthLevelBasic | ans..5 | O | true, wenn 3D-Authentifizierung von Advanced auf Basic zurückgesetzt werden soll |
URLSuccess | ans..256 | M | Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. |
URLFailure | asns..256 | M | Vollständige URL, die das Paygate aufruft, wenn die Zahlung gescheitert ist. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. |
Response | a7 | M | 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, reicht das Paygate den Parameter mit dem Zahlungsstatus an den Shop durch. |
Name | ans..100 | O | Name des Kunden (Lieferadresse) Nur wenn Name angegeben ist, werden die anderen Bestandteile der Lieferadresse übernommen. |
AddrStreet | ans..40 | O | Straßenname (Lieferadresse) |
AddrStreet2 | ans..40 | O | Apartment-/Zimmernummer (Lieferadresse) |
AddrStreet3 | ans..255 | O | Zusatz (Lieferadresse) |
AddrCity | ans..25 | O | Ortsname (Lieferadresse) |
AddrZip | ans..20 | O | Postleitzahl (Lieferadresse) |
AddrCountryCode | an2 | O | Ländercode der Lieferadresse, zweistellig gemäß ISO3166-1 |
AddrState | an5 | O | Abkürzung des Bundesstaats des Kunden nach ISO 3166-2, z.B.: DE-BW (Lieferadresse) |
Phone | ans..20 | O | Telefonnummer des Kunden (Lieferadresse) |
Parameter für Kreditkartenzahlungen mit MasterPass-Checkout V2
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess oder URLFailure ü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 |
MasterPassID | ans..32 | M | Vom Paygate vergebene ID für die MasterPass-Transaktion. Wichtig für die anschließende Zahlung. |
TransactionID | ans..255 | M | Transaktionsnummer von MasterPass. Wichtig für die anschließende Zahlung. |
Status | a..30 | M | OK (URLSuccess-Seite) oder FAILED (URLFailure-Seite) |
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 | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
RefNr | ans..30 | O | eindeutige Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Name | ans..100 | M | Name des Kunden (Lieferadresse) |
AddrStreet | ans..40 | M | Straßenname (Lieferadresse) |
AddrStreet2 | ans..40 | M | Apartment-/Zimmernummer (Lieferadresse) |
AddrStreet3 | ans..255 | M | Zusatz (Lieferadresse) |
AddrCity | ans..25 | M | Ortsname (Lieferadresse) |
AddrZip | ans..20 | M | Postleitzahl (Lieferadresse) |
AddrState | an5 | M | Abkürzung des Bundesstaats des Kunden nach ISO 3166-2, z.B.: DE-BW (Lieferadresse) |
Phone | ans..20 | M | Telefonnummer des Kunden (Lieferadresse) |
AddrCountryCode | an2 | M | Ländercode der Lieferadresse, zweistellig gemäß ISO3166-1 |
BillingName | ans..100 | O | Name des Kunden (Rechnungsadresse) |
BillingAddrStreet | ans..40 | O | Straßenname (Rechnungsadresse) |
BillingAddrStreet2 | ans..40 | O | Apartment-/Zimmernummer (Rechnungsadresse) |
BillingAddrStreet3 | ans..255 | O | Zusatz (Rechnungsadresse) |
BillingAddrCity | ans..25 | O | Ortsname (Rechnungsadresse) |
BillingAddrZip | ans..20 | O | Postleitzahl (Rechnungsadresse) |
BillingAddrState | an5 | O | Abkürzung des Bundesstaats des Kunden nach ISO 3166-2, z.B.: DE-BW (Rechnungsadresse) |
BillingAddrCountryCode | an2 | O | Ländercode der Rechnungsadresse, zweistellig gemäß ISO3166-1 |
ConFirstName | ans..20 | M | Vorname des Ansprechpartners (AP) |
ConLastName | ans..20 | M | Nachname (AP) |
ConGender | a1 | M | Geschlecht (AP): M, F |
ConCountry | a2 | M | Ländercode (AP) |
ConEMail | ans..512 | M | E-Mail-Adresse (AP) |
ConPhone | ans..20 | M | Telefonnummer (AP) |
ConDateOfBirth | n8 | M | Geburtsdatum (AP) im Format YYYYMMDD |
RewNumber | ans.. | M | Reward-Kundennummer |
RewID | ans.. | M | ID des Reward-Programms |
RewName | ans.. | M | Name des Reward-Programms |
RewExpiry | ans.. | M | Reward gültig bis |
Ergebnis-Parameter für URLSuccess und URLFailure bei MasterPass V2
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an URLNotify übergibt:
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 |
MasterPassID | ans..32 | M | Vom Paygate vergebene ID für die MasterPass-Transaktion. Wichtig für die anschließende Zahlung. |
TransactionID | ans..255 | M | Transaktionsnummer von MasterPass. Wichtig für die anschließende Zahlung. |
Status | a..30 | M | OK (URLSuccess-Seite) oder FAILED (URLFailure-Seite) |
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 | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
RefNr | ans..30 | O | eindeutige Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Ergebnis-Parameter für URLNotify bei MasterPass V2
Nach erfolgter MasterPass-Transaktion führen Sie anschließend die Kreditkartenzahlung aus. Dazu rufen Sie folgende URL für die Server-zu-Server-Verbindung auf:
Die Übergabeparameter und Rückgabewerte entsprechen bis auf nachfolgende Ausnahmen denen der standardmäßigen Kreditkartenzahlung, die im Handbuch der Kreditkartenzahlung als allgemeine Parameter beschrieben sind. Die nötigen Kreditkartendaten CCNr, CCCVC, CCExpiry sowie CCBrand stammen aus der MasterPass-Transaktion und müssen hier nicht übergeben werden. Stattdessen übergeben Sie als Referenz die folgenden beiden zusätzlichen Übergabeparameter.
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MasterPassID | ans..32 | M | Vom Paygate vergebene ID für die MasterPass-Transaktion. Wichtig für die anschließende Zahlung. |
TransactionID | ans..255 | M | Transaktionsnummer von MasterPass. Wichtig für die anschließende Zahlung. |
Zusätzliche Übergabeparameter für Kreditkartenzahlung bei MasterPass
Aufruf der MasterPass-Schnittstelle für V6
Eine Kreditkartenzahlung per MasterPass V6 erfordert mindestens zwei Anfragen an das Paygate sowie den Aufruf der MasterPass-Lightbox. Die erste Anfrage an das Paygate richten Sie an die MPServices.aspx. In der Antwort erhalten Sie die Parameter, die für den Aufruf der MasterPass-Lightbox benötigt werden. Die Details für das Skript zum Aufruf der Lightbox erhält der Händler direkt von MasterPass. Die Lightbox präsentiert das MasterPass-Wallet. Hier meldet sich der Kunde an und wählt seine Kreditkarte und seine Lieferadresse aus. Dann übergibt die Lightbox die Parameter aus dem Wallet, die Sie zum Abschluss der Zahlung benötigen. Im letzten Schritt wird dann auch die Kreditkartenzahlung über die MPCheckout.aspx autorisiert.
Es gibt die vier Masterpass-Services: Pairing, LongAccessToken, PreCheckout sowie Checkout & Checkout_Pairing. Für den einfachen Ablauf rufen Sie direkt den Service Checkout auf. Wenn Sie hingegen den PreCheckout nutzen und die Daten aus dem Kunden-Wallet einbeziehen möchten, führen Sie alle Services nacheinander aus.
Pairing verknüpft einmalig den Händler-Shop mit dem MasterPass-Wallet des Kunden. Nach erfolgreichem Pairing kann der Händler den PreCheckout durchführen.
Den Service LongAccessToken rufen Sie auf, nachdem der Kunde in seinem Wallet das Pairing bestätigt hat. Das LongAccessToken müssen Sie für diesen Kunden speichern. Nur wenn Sie ein gültiges LongAccessToken für den Kunden besitzen, können Sie den Service PreCheckout nutzen. Nach jedem PreCheckout erhalten Sie ein neues LongAccessToken. Dieses ist dann wiederum nur für einen PreCheckout gültig
Mit dem Service PreCheckout können Sie Daten aus dem Kunden-Wallet auslesen. Das geschieht ohne aktive Beteiligung des Kunden. Es genügt, dass der Kunde dem Händler den Zugriff einmalig per Pairing erlaubt hat. Welche konkreten Daten zur Verfügung stehen, wurde beim Pairing festgelegt. Über den Parameter RequestedDataTypes legen Sie fest, welche Daten Sie für die aktuelle Abfrage erhalten möchten. Bei den Kreditkartennummern werden nur die letzten vier Stellen übermittelt. In Ihrem Shop zeigen Sie dem Kunden seine Daten aus dem Wallet an. Der Kunde wählt bereits im Shop seine Kreditkarte, Lieferadresse, usw. aus.
Mit dem Service Checkout- bzw. Checkout_Pairing bereiten Sie den Aufruf des Kunden-Wallets für den Abschluss des Kaufs vor. Hier übergeben Sie den Warenkorb. Wählen Sie Checkout_Pairing, wird dem Kunden im Wallet noch die Seite für das Pairing angeboten. In der Antwort erhalten Sie das RequestToken bzw. das PairingToken für die Anzeige der MasterPass-Lightbox.
Die vom Kunden gewünschten Daten übergeben Sie nach dem Checkout-Service an die MasterPass-Lightbox. Der Kunde muss den Kauf nur noch mit seinem Passwort bestätigen, ohne dass der Inhalt seines Wallets angezeigt wird.
Um im ersten Schritt einen MasterPass-Service auszuführen, 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 folgenden Tabellen beschreiben die verschlüsselten Übergabeparameter und Rückgabewerte der einzelnen Services.
MasterPass-Service: Pairing
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 | ans..30 | O | Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden! |
EventToken | ans..40 | M | Auszuführender MasterPass-Service, hier: Pairing |
URLOrigin | ans..255 | M | URL der Seite, von der aus die Lightbox aufgerufen wird |
MAC | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Parameter für MasterPass-Service Pairing
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort übergibt:
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 | ans..30 | O | eindeutige Referenznummer des Händlers |
Status | a..30 | 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) |
PairingRequestToken | ans..80 | M | Wird beim Aufruf der Lightbox als Parameter pairingRequestToken übergeben |
Ergebnis-Parameter für MasterPass-Service Pairing
MasterPass-Service: LongAccessToken
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 | PayID aus dem Pairing-Vorgang |
TransID | ans..64 | O | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | O | Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden! |
EventToken | ans..40 | M | Auszuführender MasterPass-Service, hier: LongAccessToken |
PairingToken | ans..80 | M | Wird von MasterPass als Antwortparameter vom Lightbox-Aufruf geliefert |
PairingVerifier | ans..80 | M | Wird von MasterPass als Antwortparameter vom Lightbox-Aufruf geliefert |
MAC | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Parameter für MasterPass-Service LongAccessToken
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort übergibt:
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 | O | Transaktionsnummer des Händlers |
RefNr | ans..30 | O | eindeutige Referenznummer des Händlers |
Status | a..30 | 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) |
LongAccessToken | ans..80 | M | Das LongAccessToken wird zum Aufruf des Pre-Checkouts benötigt |
Ergebnis-Parameter für MasterPass-Service LongAccessToken
MasterPass-Service: PreCheckout
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 | ans..30 | O | Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden! |
EventToken | ans..40 | M | Auszuführender MasterPass-Service, hier: PreCheckout |
URLOrigin | ans..255 | M | URL der Seite, von der aus die Lightbox aufgerufen wird |
RequestedDataTypes | ans..80 | M | Liste der Datenbereiche, die abgerufen werden sollen. Mögliche Werte (kommasepariert): CARD,PROFILE,ADDRESS,REWARD_PROGRAM |
LongAccessToken | ans..80 | M | Das Token aus dem LongAccessToken-Service oder aus dem vorausgegangenen PreCheckout |
MAC | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Parameter für MasterPass-Service PreCheckout
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort übergibt:
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 | ans..30 | O | eindeutige Referenznummer des Händlers |
Status | a..30 | 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) |
PreCheckoutXML | ans..80 | M | Daten aus dem Kunden-Wallet im XML-Format |
LongAccessToken | ans..80 | M | Dieses LongAccessToken wird zum Aufruf des nächsten PreCheckouts benötigt |
Ergebnis-Parameter für MasterPass-Service PreCheckout
MasterPass-Service: Checkout & Checkout_Pairing
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 | O | PayID aus dem PreCheckout-Service |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | O | Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden! |
EventToken | ans..40 | M | Auszuführender MasterPass-Service, hier: Checkout bzw. Checkout_Pairing |
URLOrigin | ans..255 | M | URL der Seite, von der aus die Lightbox aufgerufen wird |
Amount | n..10 | M | Gesamtsumme aller Warenkorbartikel ohne Lieferkosten. 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 |
ArticleList | ans..768 | M | Artikelliste mit Beschreibung der Waren und Preise: <Artikelbeschreibung>;<Menge>;<Preis>; <Image-Url> <;> trennt Felder innerhalb eines Artikeldatensatzes |
MAC | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Parameter für MasterPass-Service Checkout & Checkout_Pairing
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort übergibt:
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 | ans..30 | O | eindeutige Referenznummer des Händlers |
Status | a..30 | 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) |
RequestToken | ans..80 | M | Wird als Parameter für den Aufruf der Lightbox benötigt |
PairingRequestToken | ans..80 | MC | Nur bei Checkout_Pairing: Wird als Parameter für den Aufruf der Lightbox benötigt |
Ergebnis-Parameter für MasterPass-Service Checkout & Checkout_Pairing
MasterPass-Checkout
Zum Abschließen des MasterPass-Vorgangs und zum Auslösen der Kreditkartenzahlung 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: Mit dem Parameter skipAuth=yes kann verhindert werden, dass eine Kreditkartenzahlung ausgelöst wird. Die Kreditkartenzahlung kann dann über die Schnittstelle directmp.aspx mit den gleichen Parametern wie bei MasterPass V2 ausgelöst werden, siehe oben.
Hinweis: Sie können hier auch Parameter übergeben, die speziell für Ihre Kreditkartenzahlungsart verwendet werden. Diese werden für die Autorisierung einfach weitergereicht. Welche Parameter in Frage kommen, entnehmen Sie bitte der Dokumentation für die entsprechende Zahlungsart.
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 | PayID aus dem vorausgegangenen Checkout-Service |
TransID | ans..64 | O | TransaktionsID, die für jede Zahlung eindeutig sein muss. Wird für die Kreditkartenzahlung verwendet. Wenn keine TransID angegeben wird, dann wird die TransID aus dem vorausgegangenen Service verwendet. |
RefNr | ans..30 | O | Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden! Wird für die Kreditkartenzahlung verwendet. Wenn keine RefNr angegeben wird, dann wird die RefNr aus dem vorausgegangenen Service verwendet. |
Amount | n..10 | M | Gesamtsumme aller Warenkorbartikel ohne Lieferkosten. 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 | ans..64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
OrderDesc | ans..200 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, reicht das Paygate den Parameter mit dem Zahlungsstatus an den Shop durch. |
SkipAuth | a..5 | O | yes: Es wird keine Kreditkartenzahlung ausgelöst. In der Antwort werden zusätzlich Kontaktdaten, Liefer- und Rechnungsadresse wie bei MasterPass.aspx V2 ausgegeben (siehe oben). Die Kreditkartenzahlung muss über die directmp.aspx ausgelöst werden (siehe oben). |
CheckoutToken | ans..80 | M | Lightbox-Rückgabeparameter oauthToken |
CheckoutVerifier | ans..80 | M | Lightbox-Rückgabeparameter oauthVerifier |
CheckoutUrl | ans..255 | M | Lightbox-Rückgabeparameter checkoutUrl |
PairingToken | ans..80 | O | pairing_token: wird für Checkout mit Pairing benötigt |
PairingVerifier | ans..80 | O | pairing_verifier: wird für Checkout mit Pairing benötigt |
Name | ans..100 | O | Name des Kunden (Lieferadresse) Nur wenn Name angegeben ist, werden die anderen Bestandteile der Lieferadresse übernommen. |
AddrStreet | ans..40 | O | Straßenname (Lieferadresse) |
AddrStreet2 | ans..40 | O | Apartment-/Zimmernummer (Lieferadresse) |
AddrStreet3 | ans..255 | O | Zusatz (Lieferadresse) |
AddrCity | ans..25 | O | Ortsname (Lieferadresse) |
AddrZip | ans..20 | O | Postleitzahl (Lieferadresse) |
AddrCountryCode | an2 | O | Ländercode der Lieferadresse, zweistellig gemäß ISO3166-1 |
AddrState | an5 | O | Abkürzung des Bundesstaats des Kunden nach ISO 3166-2, z.B.: DE-BW (Lieferadresse) |
Phone | ans..20 | O | Telefonnummer des Kunden (Lieferadresse) |
Parameter für Kreditkartenzahlungen mit MasterPass-Checkout V6
Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort übergibt. Die Parameter beziehen sich auf die Kreditkartenzahlung. Weitere Antwortparameter entnehmen Sie bitte der Dokumentation zu Ihrer Kreditkartenzahlungsart.
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 | ans..30 | O | eindeutige Referenznummer des Händlers |
Status | a..30 | 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 Kreditkartenzahlungen mit MasterPass-Checkout V6
Aufruf der Schnittstelle für eine Buchung
Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für MasterPass ü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 buchende Transaktion |
TransID | ans..64 | M | Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang |
RefNr | ns..30 | O | Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden |
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 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
FinishAuth | a1 | O | Übergeben Sie den Wert <Y>, um bei Teilbuchungen die Autorisierungsverlängerung oder die Reservierung des Restbetrages zu stoppen. |
Note | ans..37 | O | Text, der dem Kunden im Verwendungszweck angezeigt wird |
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 MasterPass-Buchungen
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 |
Ergebnis-Parameter für MasterPass-Buchungen
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:
Die folgenden Tabellen beschreiben die Übergabeparameter und Rückgabewerte, die über die Socket-Verbindung ausgetauscht werden.
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 |
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 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
OrderDesc | ans..768 | O | Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc. |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
CredNo | ans.. | O | Kreditnummer. Wird auf den Wert „0“ gesetzt, falls nicht übermittelt. |
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 MasterPass-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) |
Ergebnis-Parameter für Gutschrift von MasterPass-Zahlungen