Ü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.

TypZahlungen per Onlineüberweisung

Weitere Informationen finden Sie auch auf der Webseite von paydirekt (https://www.paydirekt.de).


Diagramm zum Prozessablauf

paydirekt Prozessablauf


Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

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ürzungBeschreibungKommentar

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment. The underscore may not be used.TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise etc.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
URLSuccess"urls": {"success": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
URLFailure"urls": {"failure": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, 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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
Response

---

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyRESTFormatCNDDescriptionBeschreibung
URLNotify"urls": {"notify": "..."}

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

Key

REST

Format

CND

Description

Beschreibung

ShopApiKey

"payment": {"paydirekt": {"shopApiKey": "..." }}

ans..64

M

API key of the shop with paydirekt

API-Key des Shops bei paydirekt

shAmount

"amount": {"shippingTotal": ...}

n..10

O

Shipping costs in the smallest currency unit (e.g. EUR Cent)

Please contact Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit).

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

"amount": {"itemTotal": ...}

n..10

O

Value of ordered goods without shipping costs in the smallest currency unit (e.g. EUR Cent)

Please contact Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit).

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

"order": {"items": "..."}

ans..1024

O

Article list with description of items and prices: <Quantity>;<Name>;<EAN>;<Price>

<;> separates the fields of an article data set
<+> separates the article data sets

quantity: ordered quantity of the article

Name: designation of the article

EAN: international article number (EAN or GTIN), (if not known, submit as empty string "”)

Price: unit price of the article incl. taxes; amount in the smallest currency unit (e.g. EUR Cent)

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)

Email

"billing": {"contactInfo": {"email": "..." }}

ans..100

O

Email address of the customer

E-Mail-Adresse des Kunden

MinAge

"payment": {"paydirekt": {"minAge": "..." }}

n..3

O

minimum age in years

Mindestalter in Jahren

ShoppingBasketCategory

"payment": {"paydirekt": {"basketCategory": "..." }}

a..8

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„PHYSICAL“ for shopping baskets with solely physical goods

„MIXED“ for shopping baskets with digital and physical goods

"ANONYMOUS_DONATION": The sopping basket solely is an anonymous donation

"AUTHORITIES_PAYMENT": The sopping basket solely contains  payments for authorities

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

"shipping": {"consumer": {"firstName": "..." }}

ans..50

C

First name in the delivery address. Mandatory if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and <>IS NOT „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdLastName

"shipping": {"consumer": {"lastName": "..." }}

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT„AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdCompany

"shipping": {"business": {"companyLegalName": "..." }}

ans..100

O

Company name in the delivery address

Firmenname in der Lieferanschrift

sdAddressAddition

"shipping": {"addressInfo": {"addressLine2": "..." }}

ans..30

O

Address addition in the delivery address

Adresszusatz in der Lieferanschrift

sdStreet

"shipping": {"addressInfo": {"addressLine1": {"street": "..." }}}

ans..100

C

Street name in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

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

Street number in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdZip

"shipping": {"addressInfo": {"postalCode": "..." }}

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCity

"shipping": {"addressInfo": {"city": "..." }}

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCountryCode

"shipping": {"addressInfo": {"country": { "A2": "..." }}}

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdEmail

"shipping": {"contactInfo": {"email": "..." }}

ans..100

C

Email address of the receiver

mandatory, if ShoppingBasketCategory = „DIGITAL“

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

Note

"payment": {"paydirekt": {"note": "..." }}

ans..37

O

Text that will we displayed as reason for payment to the customer

Text, der dem Kunden im Verwendungszweck angezeigt wird

CustomerID

"billing": {"consumer": {"consumerId": "..." }}

ans..64

O

Customer number

Kundennummer

OverCapture

"payment": {"paydirekt": {"overCapture": "..." }}

bool

O

Flag for overcapture checkouts. Default is false.

For an overcapture checkout the sum of captures may exceed the goods value of the order up to 10%.

Overcapture may be activated for checkouts of type ORDER only.

OverCapture can only be used with merchants which are unlocked for this feature both at paydirekt and at Computop.

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

"payment": {"paydirekt": {"deliveryMethod": "..." }}

ans..12

O

Delivery place STANDARD, PACKSTATION or STORE_PICKUP. The default value is STANDARD.

STANDARD: The goods will be delivered to a normal postal address.

PACKSTATION: The goods will be delivered to a packstation.

STORE_PICKUP: The goods will be picked-up within a branch store.

For express checkouts this field always has the value STANDARD and will not be updated depending on selected delivery option.

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

"payment": {"paydirekt": {"deliveryDate": "..." }}

dttm

O

Expected date of shipment in the format YYYY-MM-DD

Erwartetes Versanddatum im Format JJJJ-MM-TT

ParcelService

"payment": {"paydirekt": {"parcelService": "..." }}

ans..16

O

Parcel service

Paket-Dienstleister

TrackingNumber

"payment": {"paydirekt": {"trackingNumber": "..." }}

ans..64

O

Consignment number

Sendungsnummer

KeyRESTFormatCNDDescriptionBeschreibung
Plain"metadata[plain]": "..."

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

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. 

KeyRESTFormatCND

Description

Beschreibung
Custom"metadata": "..."

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

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.

RESTFormatCNDBeschreibung

"paymentId": "..."

an32M

Kann "00000000000000000000000000000000" lauten, wenn dies noch nicht vom Paygate festgelegt wurde

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MDer Händler muss den Kunden zu dieser URL weiterleiten, um die Zahlung abzuschließen
"_Links.redirect.type": "..."an..20M"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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

Format

CND

Description

Beschreibung

TransID

ans..20

M

TransactionID which should be unique for each payment

TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)

OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

Format

CND

Description

Beschreibung

TID

ans..32

O

Unique ID of this activity and all associated transactions at paydirekt. This ID exists as soon as a customer hat logged in at the checkout page.

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

Unique ID of this acticity at paydirekt

Eindeutige ID des Vorgangs bei paydirekt

TransactionID

ans36

O

Unique transaction-ID (UUID). The value is assigned by the paydirekt system.

Eindeutige Transaktions-ID (UUID). Der Wert wird durch das paydirekt-System vergeben.

ShoppingBasketCategory

a..8

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„PHYSICAL“ for shopping baskets with solely physical goods

„MIXED“ for shopping baskets with digital and physical goods

"ANONYMOUS_DONATION": The sopping basket solely is an anonymous donation

"AUTHORITIES_PAYMENT": The sopping basket solely contains  payments for authorities

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

First name in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdLastName

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdCompany

ans..100

O

Company name in the delivery address

Firmenname in der Lieferanschrift

sdAddressAddition

ans..30

O

Address addition in the delivery address

Adresszusatz in der Lieferanschrift

sdStreet

ans..100

C

Street name in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

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

Street number in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdZip

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCity

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCountryCode

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

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

Email address of the receiver

mandatory, if ShoppingBasketCategory = „DIGITAL“

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

AgeAccepted

a..12

O

ACCEPTED or NOT ACCEPTED

ACCEPTED oder NOT ACCEPTED

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

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. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment. The underscore may not be used.TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise etc.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
URLSuccess"urls": {"success": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
URLFailure"urls": {"failure": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, 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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
Response

---

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyRESTFormatCNDDescriptionBeschreibung
URLNotify"urls": {"notify": "..."}

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

Key

REST

Format

CND

Description

Beschreibung

URLConfirm

"urls": {"confirm": "..."}

ans..256

O

Complete URL which Paygate calls up when the customer has confirmed the eMail for oneKlick registration or has revoked the registration. The URL may be called up only via port 443. It may not contain parameters.

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.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

Key

REST

Format

CND

Description

Beschreibung

ShopApiKey

"payment": {"paydirekt": {"shopApiKey": "..." }}

ans..64

M

API key of the shop with paydirekt

API-Key des Shops bei paydirekt

EventToken

"payment": {"paydirekt": {"eventToken": "..." }}

a8

M

"oneKlick": Forwarding to paydirekt login page for OneKlick.

"recurring": Forwarding to paydirekt login oage for Recurring-OneKlick. Additionally information about payment plan can be submitted within parameter usageAgreement. Then they will be shown on the paydirect login page.

"ADS" – OneKlick registration during Checkout (during Checkouts a registration for recurring is not possible). For OneKlick registration during Checkout additionally the device parameters necessary for oneKlick registration must be submitted.

"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"payment": {"paydirekt": {"usageAgreement": "..." }}ans..256COptional, if EventToken="recurring": Details for recurring payments in JSON format. See below.Optional, wenn EventToken="recurring": Details für wiederkehrende Zahlungen im JSON-Format. Siehe unten.

DeviceId

"device": {"deviceId": ...}

ans..64

C

Unique Device-ID for identifying the customer’s device. Mandatory, if DeviceFingerPrint is not submitted.

Eindeutige Device-ID zur Identifikation des Endgeräts des Käufers. Pflicht, wenn DeviceFingerPrint nicht übergeben wird.

DeviceFingerPrint

"device": {"fingerPrint": ...}

ans..64

O

Fingerprint of the customer’s device at the time of authorisation creation

Fingerprint des Endgeräts des Käufers zum Zeitpunkt der Autorisierungsanlage

Device

"device": {"name": ...}

ans..20

M

Name of the customer’s device – will be displayed to customer within the portals.

Name des Endgeräts des Käufers – wird dem Käufer in seinen Portalen angezeigt.

KeyRESTFormatCNDDescriptionBeschreibung
Plain"metadata[plain]": "..."

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

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. 

KeyRESTFormatCND

Description

Beschreibung
Custom"metadata": "..."

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung

StartDate

ans10

M

Date of first payment within formt "YYYY-MM-DD"

Datum der ersten Zahlung im Format "JJJJ-MM-TT"

IntervalUnit

a..7

M

Payment interval ("DAY","WEEK","MONTH","QUARTER","YEAR")

Zahlungsintervall ("DAY","WEEK","MONTH","QUARTER","YEAR")

Interval

n..

M

Frequency of paymentFrequenz der Zahlung

Beispiel usageAgreement als JSON-String

{
   "amount":{
      "amount":50,
      "currency":"EUR"
   },
   "startDate":"2019-09-01",
   "recurrenceInterval":{
      "intervalUnit":"WEEK",
      "interval":8
   }
}

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.

RESTFormatCNDBeschreibung

"paymentId": "..."

an32M

Kann "00000000000000000000000000000000" lauten, wenn dies noch nicht vom Paygate festgelegt wurde

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MDer Händler muss den Kunden zu dieser URL weiterleiten, um die Zahlung abzuschließen
"_Links.redirect.type": "..."an..20M"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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

Format

CND

Description

Beschreibung

TransID

ans..20

M

TransactionID which should be unique for each payment

TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)

OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

Format

CND

Description

Beschreibung

BillingAgreementID

an..44

O

CustomerAuthorizationReference of a valid buyer authorisation.

Purpose: Rights enhancement of the issued token for the opportunity to execute actions on behalf of the customer within the scope of authorisation. Is needed for oneKlick checkouts.

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.

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

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. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

Format

CND

Description

Beschreibung

TransID

ans..20

M

TransactionID which should be unique for each payment

TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

BillingAgreementID

an..44

O

CustomerAuthorizationReference of a valid buyer authorisation.

CustomerAuthorizationReference einer gültigen Käuferautorisierung.

AuthorizationStatusan..50
APPROVED, REVOKED or EXPIREDAPPROVED, 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment. The underscore may not be used.TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise etc.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

Key

REST

Format

CND

Description

Beschreibung

ShopApiKey

"payment": {"paydirekt": {"shopApiKey": "..." }}

ans..64

M

API key of the shop with paydirekt

API-Key des Shops bei paydirekt

shAmount

"amount": {"shippingTotal": ...}

n..10

O

Shipping costs in the smallest currency unit (e.g. EUR Cent)

Please contact Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit).

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

"amount": {"itemTotal": ...}

n..10

O

Value of ordered goods without shipping costs in the smallest currency unit (e.g. EUR Cent)

Please contact Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit).

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

"order": {"items": "..."}

ans..1024

O

Article list with description of items and prices: <Quantity>;<Name>;<EAN>;<Price>

<;> separates the fields of an article data set
<+> separates the article data sets

quantity: ordered quantity of the article

Name: designation of the article

EAN: international article number (EAN or GTIN), (if not known, submit as empty string "”)

Price: unit price of the article incl. taxes; amount in the smallest currency unit (e.g. EUR Cent)

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)

Email

"billing": {"contactInfo": {"email": "..." }}

ans..100

O

Email address of the customer

E-Mail-Adresse des Kunden

MinAge

"payment": {"paydirekt": {"minAge": "..." }}

n..3

O

minimum age in years

Mindestalter in Jahren

ShoppingBasketCategory

"payment": {"paydirekt": {"basketCategory": "..." }}

a..8

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„PHYSICAL“ for shopping baskets with solely physical goods

„MIXED“ for shopping baskets with digital and physical goods

"ANONYMOUS_DONATION": The sopping basket solely is an anonymous donation

"AUTHORITIES_PAYMENT": The sopping basket solely contains  payments for authorities

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

"shipping": {"consumer": { "firstName": "..." }}

ans..50

C

First name in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdLastName

"shipping": {"consumer": { "lastName": "..." }}

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdCompany

"shipping": {"business": { "companyLegalName": "..." }}

ans..100

O

Company name in the delivery address

Firmenname in der Lieferanschrift

sdAddressAddition

"shipping": {"addressInfo": { "addressLine2": "..." }}

ans..30

O

Address addition in the delivery address

Adresszusatz in der Lieferanschrift

sdStreet

"shipping": {"addressInfo": {"addressLine1": {"street": "..." }}}

ans..100

C

Street name in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

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

Street number in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdZip

"shipping": {"addressInfo": { "postalCode": "..." }}

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCity

"shipping": {"addressInfo": { "city": "..." }}

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCountryCode

"shipping": {"addressInfo": { "country": { "A2": "..." }}}

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdEmail

"shipping": {"contactInfo": { "email": "..." }}

ans..100

C

Email address of the receiver

mandatory, if ShoppingBasketCategory = „DIGITAL“

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

IPAddress"browserInfo": {"ipAddress": "..."}ans..15MCustomer´s IP addressIP-Adresse des Kunden

Note

"payment": {"paydirekt": {"note": "..." }}

ans..37

O

Text that will we displayed as reason for payment to the customer

Text, der dem Kunden im Verwendungszweck angezeigt wird

CustomerID

"billing": {"consumer": {"consumerId": "..." }}

ans..64

O

Customer number

Kundennummer

DeliveryMethod

"payment": {"paydirekt": {"deliveryMethod": "..." }}

ans..12

O

Delivery place STANDARD, PACKSTATION or STORE_PICKUP. The default value is STANDARD.

STANDARD: The goods will be delivered to a normal postal address.

PACKSTATION: The goods will be delivered to a packstation.

STORE_PICKUP: The goods will be picked-up within a branch store.

For express checkouts this field always has the value STANDARD and will not be updated depending on selected delivery option.

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

"payment": {"paydirekt": {"deliveryDate": "..." }}

dttm

O

Expected date of shipment in the format YYYY-MM-DD

Erwartetes Versanddatum im Format JJJJ-MM-TT

ParcelService

"payment": {"paydirekt": {"parcelService": "..." }}

ans..16

O

Parcel service

Paket-Dienstleister

TrackingNumber

"payment": {"paydirekt": {"trackingNumber": "..." }}

ans..64

O

Consignment number

Sendungsnummer

BillingAgreementID

"payment": {"paydirekt": {"billingAgreementId": "..." }}

an..44

M

CustomerAuthorizationReference of a valid buyer authorisation.

Purpose: Rights enhancement of the issued token for the opportunity to execute actions on behalf of the customer within the scope of authorisation. Is needed for oneKlick checkouts.

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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment

TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "AUTHORIZE_REQUEST"

"status": "FAILED"

a..50

M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)

OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

TID


ans..32

O

Unique ID of this activity and all associated transactions at paydirekt. This ID exists as soon as a customer hat logged in at the checkout page.

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

Unique ID of this acticity at paydirekt

Eindeutige ID des Vorgangs bei paydirekt

TransactionID


ans36

O

Unique transaction-ID (UUID). The value is assigned by the paydirekt system.

Eindeutige Transaktions-ID (UUID). Der Wert wird durch das paydirekt-System vergeben.

ShoppingBasketCategory

"payment": {"paydirekt": {"basketCategory": "..." }}

a..8

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„PHYSICAL“ for shopping baskets with solely physical goods

„MIXED“ for shopping baskets with digital and physical goods

"ANONYMOUS_DONATION": The sopping basket solely is an anonymous donation

"AUTHORITIES_PAYMENT": The sopping basket solely contains  payments for authorities

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

"shipping": {"consumer": { "firstName": "..." }}

ans..50

C

First name in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdLastName

"shipping": {"consumer": { "lastName": "..." }}

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdCompany

"shipping": {"business": { "companyLegalName": "..." }}

ans..100

O

Company name in the delivery address

Firmenname in der Lieferanschrift

sdAddressAddition

"shipping": {"addressInfo": { "addressLine2": "..." }}

ans..30

O

Address addition in the delivery address

Adresszusatz in der Lieferanschrift

sdStreet

"shipping": {"addressInfo": {"addressLine1": {"street": "..." }}}

ans..100

C

Street name in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

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

Street number in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdZip

"shipping": {"addressInfo": { "postalCode": "..." }}

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCity

"shipping": {"addressInfo": { "city": "..." }}

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCountryCode

"shipping": {"addressInfo": { "country": { "A2": "..." }}}

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdEMail

"shipping": {"contactInfo": { "email": "..." }}

ans..100

C

Email address of the receiver

mandatory, if ShoppingBasketCategory = „DIGITAL“

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

AgeAccepted


a..12

O

ACCEPTED or NOT ACCEPTED

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be captured

Vom Paygate vergebene ID für die zu buchende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment. The underscore may not be used.TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.
RefNr"referenceNumber": "..."ns..30OMerchant reference number: here a separate reference number, e.g. an invoice number, can be transferredReferenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise etc.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

Key

REST

Format

CND

Description

Beschreibung

CompleteType

"payment": {"paydirekt": {"completeType": "..." }}

ans..3

O

If <YES> is transferred, the possible open order of paydirekt is closed on capture.

Wird <YES> übergeben, wird bei der Buchung die mögliche offene Order von paydirekt geschlossen.

Note

"payment": {"paydirekt": {"note": "..." }}

ans..37

O

Text that will we displayed as reason for payment to the customer

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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment

Transaktions-ID, die für jede Zahlung eindeutig sein muss
Status

"status": "OK"

"status": "CAPTURE_REQUEST"

"status": "FAILED"

a..50MOK, CAPTURE_REQUEST or FAILEDOK, CAPTURE_REQUEST oder FAILED

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

TransactionID


ans36

O

Unique transaction-ID of this capture (UUID). The value is assigned by the paydirekt system.

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 vom Computop 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment. The underscore may not be used.TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.
RefNr"referenceNumber": "..."ns..30OReference number (e.g. invoice number) which must be unique for each return shipmentReferenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise etc.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

Key

REST

Format

CND

Description

Beschreibung

Note

"payment": {"paydirekt": {"note": "..." }}

ans..37

O

Text that will we displayed as reason for payment to the customer

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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment

Transaktions-ID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

TransactionID


ans36

O

Unique transaction-ID (UUID). The value is assigned by the paydirekt system.

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be reversed

Vom Paygate vergebene ID für die zu stornierende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment. The underscore may not be used.TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment

Transaktions-ID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Action

Version

Description

Beschreibung

Capture

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

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:

HEAD,<MerchantID>,<Date>,<Version>

PAYDIREKT,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

PAYDIREKT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

PAYDIREKT,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>


Beispiel für Master-MID-Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, PAYDIRECT for paydirekt

HEAD für Header, FOOT für Footer, PAYDIREKT für Paydirekt

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit
Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)
Reverse (Storno)

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

Beschreibung der Felder im Datensatz von Batch-Dateien


Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:

HEAD,<MerchantID>,<Date>,<Version>

PAYDIREKT,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

PAYDIREKT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

PAYDIREKT,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>


Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit
Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)
Reverse (Storno)

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien