Table of Contents

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.

Page properties

Logo

Info

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

Type

Payments by Online Bank Transfer EN

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

Process flow chart

paydirekt process flow

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Definition
PageWithExcerpt	Definition EN

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

form, go to the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

paydirekt.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1620806271842_-1873002353
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	paydirekt_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1620806271845_-1909607768
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

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.

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	O	Description of purchased goods, unit prices etc.	Beschreibung der gekauften Waren, Einzelpreise etc.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	URLSuccess
page	URLSuccess
type	page

Table Excerpt Include

static	true
name	URLFailure
page	URLFailure
type	page

Table Excerpt Include

static	true
name	Response
page	Response
type	page

Table Excerpt Include

static	true
name	URLNotify
page	URLNotify
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Table Excerpt Include

static	true
name	Capture
page	Capture
type	page

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

, 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

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

, 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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

, 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

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

, 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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

.

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

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Partner-Name
PageWithExcerpt	DE:Wording

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

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

Parameters for payments with paydirekt

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_IntroURL
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621412848788_-1661376529
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	paydirekt_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621413046582_-944778073
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

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

Table Excerpt Include

static	true
name	Status_OK_AUTHORIZE_REQUEST
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

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

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

which cannot be used for further actions. In case of successful registration

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

. 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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

form with the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

paydirekt.aspx

Multiexcerpt includeSpaceWithExcerptENMultiExcerptNameRequest_Intro

PageWithExcerptReuse APINotice: 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.

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621414757246_-1661376529
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	oneklick_registration_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621414757250_-944778073
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

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.

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	O	Description of purchased goods, unit prices etc.	Beschreibung der gekauften Waren, Einzelpreise etc.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	URLSuccess
page	URLSuccess
type	page

Table Excerpt Include

static	true
name	URLFailure
page	URLFailure
type	page

Table Excerpt Include

static	true
name	Response
page	Response
type	page

Table Excerpt Include

static	true
name	URLNotify
page	URLNotify
type	page

Key

Format

CND

Description

Beschreibung

URLConfirm

ans..256

O

Complete URL which

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

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

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Platform-Kurz
PageWithExcerpt	DE:Wording

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.

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

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.
usageAgreement	ans..256	C	Optional, 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.

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

Parameters for oneKlick registration with paydirekt

usageAgreement

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621415706844_-431620405
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	oneklick_registration_usageagreement

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621415706846_-560183458
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Key	Format	CND	Description	Beschreibung
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 payment	Frequenz der Zahlung

Example usageAgreement as JSON string

Code Block

language	js

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

The parameter created within JSON format must be Base64 encoded.

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_IntroURL
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621416239847_1480646597
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	oneklick_registration_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621416239849_881061047
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

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

Table Excerpt Include

static	true
name	Status_OK_AUTHORIZE_REQUEST
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

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.

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

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

The following table describes the result parameters which

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Kurz
PageWithExcerpt	Wording

transmits to your URLConfirm. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621418145912_-17782409
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	oneklick_registration_urlconfirm

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621418145915_2108703498
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

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

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format		CND	Description	Beschreibung
BillingAgreementID	an..44		O	CustomerAuthorizationReference of a valid buyer authorisation.	CustomerAuthorizationReference einer gültigen Käuferautorisierung.
AuthorizationStatus	an..50			APPROVED, REVOKED or EXPIRED	APPROVED, 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:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

oneKlick.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621419323848_1534180658
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	oneklick_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621419323851_-327818398
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

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.

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	O	Description of purchased goods, unit prices etc.	Beschreibung der gekauften Waren, Einzelpreise etc.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Table Excerpt Include

static	true
name	Capture
page	Capture
type	page

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

, 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

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

, 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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

, 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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

, 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“

IPAddress

ans..15

M

Customer´s IP address

IP-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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621421058162_-1422379118
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	oneklick_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621421058164_-1040638939
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

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

Table Excerpt Include

static	true
name	Status_OK_AUTHORIZE_REQUEST
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

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:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

capture.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621421774843_1808163338
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	capture_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621421774844_-1583490766
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Capture
page	PayID
type	page

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.
RefNr	ns..30	O	Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred	Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	O	Description of purchased goods, unit prices etc.	Beschreibung der gekauften Waren, Einzelpreise etc.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621422212202_-1422379118
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	capture_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621422212204_-1040638939
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

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
Status	a..50		M	OK, CAPTURE_REQUEST or FAILED	OK, CAPTURE_REQUEST oder FAILED

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

within Multiexcerpt includeSpaceWithExcerptEN

MultiExcerptNamePlatform-Kurz

PageWithExcerpt	Wording

for the merchant and that payment method. To carry out a credit with a reference transaction, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

credit.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621423672281_1250815247
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621423672283_-2102395070
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Credit
page	PayID
type	page

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.
RefNr	ns..30	O	Reference number (e.g. invoice number) which must be unique for each return shipment	Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
OrderDesc	ans..768	O	Description of purchased goods, unit prices etc.	Beschreibung der gekauften Waren, Einzelpreise etc.

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

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

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621424192159_179400880
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621424192160_1556121920
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

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

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

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:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

reverse.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621424936683_-671370214
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	reverse_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621424936684_310597183
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Reverse
page	PayID
type	page

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.

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Parameters for reversals of paydirekt payments

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621425440051_1853057387
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	reverse_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621425440053_148300249
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	MID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

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

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

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:

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621426652354_654834716
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_versions

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621426652356_-2132333806
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

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:

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621426762217_1524371909
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621426762220_-806925116
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

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)

Table Excerpt Include

name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	RefNr
page	RefNr
type	page

Table Excerpt Include

static	true
name	PayID_Batch
page	PayID
type	page

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):

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1621427370475_1004179927
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	batch_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1621427370476_-421287805
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

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)

Table Excerpt Include

static	true
name	PayID_Batch
page	PayID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Description of result parameters within the record for Batch files

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version 6

Key

About paydirekt

General information about paydirekt

Process flow chart

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Calling the paydirekt interface

paydirekt oneKlick

oneKlick registration

usageAgreement

Example usageAgreement as JSON string

Calling the paydirekt oneKlick interface

Capture

Credit with reference

Reverse

Batch processing via the interface

Paygate

Computop

Help

Intranet Tools

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 5

New Version 6

Key

About paydirekt

General information about paydirekt

Process flow chart

Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePlatform-KurzPageWithExcerptWording interface

Calling the paydirekt interface

paydirekt oneKlick

oneKlick registration

usageAgreement

Example usageAgreement as JSON string

Calling the paydirekt oneKlick interface

Capture

Credit with reference

Reverse

Batch processing via the interface

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface