Page tree

Search

Skip to end of metadata
Go to start of metadata


About paydirekt

General information about paydirekt

Paydirekt is a new online payment service for all German banks and savings banks and is as trustworthy as your own bank. At the heart of paydirekt is the trusted giro account through which the entire processing takes place.

The buyer registers for paydirekt via their own bank’s online system. Each payment is authorised by the buyer’s own bank and immediately posted to the giro account. Buyer authentication is via an adaptive authentication process. Each payment also requires an age verification.

The benefits for the merchant are simple connection of paydirekt to the shop system, highly secure transactions due to the processing of participating banks and savings banks and their credit rating, payment guarantee as soon as the posting is activated after positive payment confirmation and easy handling of returns and complaints.


Logo

Info

paydirekt allows online purchases to be paid simply and directly from your giro account. Merchants benefit from this alternative to existing online payment processes which correspond to the stringent requirements of the German credit sector.

TypePayments by Online Bank Transfer


Further information can be found on the website of paydirekt (https://www.paydirekt.de).

 

Process flow chart


paydirekt process flow


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Calling the paydirekt interface

A payment by paydirekt may be done in two steps, where first of all a payment for an order is initialised before you capture it separately on dispatching the goods. Alternatively the payment can be processes within one step as a sale transaction. The subsequent transactions then take place via a server-to-server connection. Hence, you can capture these payments or issue a credit in the event of a goods return.

In order to process a payment with paydirekt via a Paygate form, go to the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

MerchantID

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

Format

CND

Description

Beschreibung

TransID

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.

KeyFormatCNDDescriptionBeschreibung
RefNr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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 EN

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

O

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

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.

KeyFormatCNDDescriptionBeschreibung
URLSuccess

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.

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.

KeyFormatCNDDescriptionBeschreibung
URLFailure

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.

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.

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

KeyFormatCNDDescriptionBeschreibung
URLNotify

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.

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

KeyFormatCNDDescriptionBeschreibung
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

Format

CND

Description

Beschreibung

ShopApiKey

ans..64

M

API key of the shop with paydirekt

API-Key des Shops bei paydirekt

shAmount

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

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

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

ans..100

O

Email address of the customer

E-Mail-Adresse des Kunden

MinAge

n..3

O

minimum age in years

Mindestalter in Jahren

ShoppingBasketCategory

a..8

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„DIGITAL“ 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 <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „ANONYMOUS_DONATION“

sdLastName

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „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 <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Straßenname in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdStreetNr

ans..8

C

Street number in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdZip

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCity

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCountryCode

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "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“

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

ans..64

O

Customer number

Kundennummer

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

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

dttm

O

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

Erwartetes Versanddatum im Format JJJJ-MM-TT

ParcelService

ans..16

O

Parcel service

Paket-Dienstleister

TrackingNumber

ans..64

O

Consignment number

Sendungsnummer

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID

KeyFormatCNDDescriptionBeschreibung
Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden.

Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456

Parameters for payments with paydirekt


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify (pls. be prepared to receive additional parameters at any time). If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

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

an8

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: HashMAC-Authentication.
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HashMAC-Authentication

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

„DIGITAL“ 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 <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „ANONYMOUS_DONATION“

sdLastName

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „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 <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Straßenname in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdStreetNr

ans..8

C

Street number in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdZip

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCity

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCountryCode

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "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 value to be set by the merchant to return some information unencrypted, e.g. the MID

Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID

KeyFormatCNDDescriptionBeschreibung
Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden.

Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456

Result parameters for URLNotify, URLSuccess and URLFailure in case of paydirekt



paydirekt oneKlick

In contrast to standard checkout the customer must register himself one-time for oneKlick. The registration is done with a separate payment (AUTHORIZE) with Paygate which cannot be used for further actions. In case of successful registration Paygate returns a token (BillingAgreementID), that can be used for all subsequent oneKlick transactions. Moreover the customer has to confirm an E-Mail before oneKlick can be used.

Optionally an URL can be submitted, to which a notify will be send, when the customer has confirmed or revoked the eMail. This URL can be stored statically in the merchant configuration or transferred via the request parameter "URLConfirm".

For an oneKlick checkout the BillingAgreementID has to be submitted to Paygate . Instead of forwarding to paydirekt now the checkout will be finished without further customer confirmation.


oneKlick registration

The oneKlick registration can be done as a separate process or combined with a normal checkout. Separate registration is processed via a separate form. After the registration all subsequent transactions are made via a Server-to-Server connection. With oneKlick merchants can divide payments into authorisation and capture or can capture immediately (SALE).

Separate oneKlick registration as well as registration during checkout always is processed via the Paygate form with the following URL:


Notice: DeviceID and DeviceFingerPrint must be unique for each customer's terminal device. Paydirekt offers an SDK for iOS and Android, in order to create an unique DeviceId. For web applications libraries like Fingerprint.js ( https://github.com/Valve/fingerprintjs2 ) can be used to create an unique fingerprint.

Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

MerchantID

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

Format

CND

Description

Beschreibung

TransID

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.

KeyFormatCNDDescriptionBeschreibung
RefNr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

O

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

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.

KeyFormatCNDDescriptionBeschreibung
URLSuccess

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.

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.

KeyFormatCNDDescriptionBeschreibung
URLFailure

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.

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.

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

KeyFormatCNDDescriptionBeschreibung
URLNotify

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.

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.

Key

Format

CND

Description

Beschreibung

URLConfirm

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Key

Format

CND

Description

Beschreibung

ShopApiKey

ans..64

M

API key of the shop with paydirekt

API-Key des Shops bei 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.

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

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

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

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.

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID

KeyFormatCNDDescriptionBeschreibung
Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden.

Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456

Parameters for oneKlick registration with 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 EN

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

Example usageAgreement as JSON string

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

The parameter created within JSON format must be Base64 encoded.


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify (pls. be prepared to receive additional parameters at any time). If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

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

an8

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: HashMAC-Authentication.
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HashMAC-Authentication

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 value to be set by the merchant to return some information unencrypted, e.g. the MID

Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID

KeyFormatCNDDescriptionBeschreibung
Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden.

Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456

Result parameters for URLNotify, URLSuccess and URLFailure in case of paydirekt


The following table describes the result parameters which Paygate transmits to your URLConfirm. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

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

an8

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: HashMAC-Authentication.
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier: HashMAC-Authentication

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

Result parameters for URLConfirm in case of paydirekt


Calling the paydirekt oneKlick interface

Payments with oneKlick are possible via a server-to-server connection with help of the BillingAgreementID. Payments with oneKlick can be made as authorisation which has to be captured separately or as a sale transaction with immediate capture.

To carry out a oneKlick payment for paydirekt via a Server-to-Server connection, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

MerchantID

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

Format

CND

Description

Beschreibung

TransID

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.

KeyFormatCNDDescriptionBeschreibung
RefNr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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 EN

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

O

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

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

KeyFormatCNDDescriptionBeschreibung
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

Format

CND

Description

Beschreibung

ShopApiKey

ans..64

M

API key of the shop with paydirekt

API-Key des Shops bei paydirekt

shAmount

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

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

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

ans..100

O

Email address of the customer

E-Mail-Adresse des Kunden

MinAge

n..3

O

minimum age in years

Mindestalter in Jahren

ShoppingBasketCategory

a..8

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„DIGITAL“ 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 <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „ANONYMOUS_DONATION“

sdLastName

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „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 <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Straßenname in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdStreetNr

ans..8

C

Street number in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdZip

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCity

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCountryCode

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "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“

IPAddressans..15MCustomer´s IP addressIP-Adresse des Kunden

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

ans..64

O

Customer number

Kundennummer

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

dttm

O

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

Erwartetes Versanddatum im Format JJJJ-MM-TT

ParcelService

ans..16

O

Parcel service

Paket-Dienstleister

TrackingNumber

ans..64

O

Consignment number

Sendungsnummer

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.

Parameters for payments with paydirekt oneKlick


The following table describes the result parameters with which the Computop Paygate responds to your system (pls. be prepared to receive additional parameters at any time):

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

an8

M

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

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

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

„DIGITAL“ 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 <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „ANONYMOUS_DONATION“

sdLastName

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ and <> „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory <> „AUTHORITIES_PAYMENT“ und <> „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 <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Straßenname in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdStreetNr

ans..8

C

Street number in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdZip

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCity

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "ANONYMOUS_DONATION"

sdCountryCode

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory <> "DIGITAL" and <> "AUTHORITIES_PAYMENT" and <> "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory <> "DIGITAL" und <> "AUTHORITIES_PAYMENT" und <> "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

Result parameters for URLNotify, URLSuccess and URLFailure in case of paydirekt oneKlick



Capture

Captures are possible via a Server-to-Server connection. To carry out a Capture for paydirekt via a Server-to-Server connection please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

MerchantID

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.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be captured

Vom Paygate vergebene ID für die zu buchende Zahlung

Key

Format

CND

Description

Beschreibung

TransID

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

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 EN

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

O

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

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Key

Format

CND

Description

Beschreibung

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

ans..37

O

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

Text, der dem Kunden im Verwendungszweck angezeigt wird

Parameters for paydirekt captures


The following table describes the result parameters with which the Computop Paygate responds to your system (pls. be prepared to receive additional parameters at any time):

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

Transaktions-ID, die für jede Zahlung eindeutig sein muss
Statusa..50MOK, CAPTURE_REQUEST or FAILEDOK, CAPTURE_REQUEST oder FAILED

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

an8

M

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

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

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

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.

Result parameters for paydirekt captures



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. Credits are possible up to 200% of the captured amount, if this is configured by Computop Helpdesk for the merchant and that payment method. To carry out a credit with a reference transaction, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

MerchantID

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.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

Key

Format

CND

Description

Beschreibung

TransID

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

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 EN

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

O

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

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Key

Format

CND

Description

Beschreibung

Note

ans..37

O

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

Text, der dem Kunden im Verwendungszweck angezeigt wird

Parameters for credits of paydirekt payments

 

The following table describes the result parameters with which the Computop Paygate responds to your system (pls. be prepared to receive additional parameters at any time):

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

Transaktions-ID, 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

an8

M

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

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

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

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.

Result parameters for credits of paydireckt payments



Reverse

Reversals are possible via a Server-to-Server connection. In order to reverse a paydirekt transaction, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

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

MerchantID

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.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be reversed

Vom Paygate vergebene ID für die zu stornierende Zahlung

Key

Format

CND

Description

Beschreibung

TransID

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.

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 EN

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

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

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / 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 / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Parameters for reversals of paydirekt payments


The following table describes the result parameters with which the Computop Paygate responds to your system (pls. be prepared to receive additional parameters at any time):

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

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

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 EN

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

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

an8

M

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

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

Result parameters for reversal of paydirekt payments



Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing a paydirekt payment and which information can be found within the response file about the payment status.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

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)

Description of the possible batch versions


The structure for a paydirekt payment within a Batch file to be submitted is the following:

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>


Example for Master MID Funktion:

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


The following table describes the individual fields and values used within the data set (record) in the batch file:

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 EN

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID which should be unique for each paymentTransaktionsID, 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

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks as follows:

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>

 

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

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

an8

M

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

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

Description of result parameters within the record for Batch files