Page tree

Search

Skip to end of metadata
Go to start of metadata


Über paydirekt

Allgemeines zu paydirekt

paydirekt ist ein neuer Online-Bezahlservice aller deutschen Banken und Sparkassen und daher genauso vertrauenswürdig wie das eigene Finanzinstitut. Dreh- und Angelpunkt von paydirekt ist das bewährte Girokonto, über welches die gesamte Abwicklung vorgenommen wird.

Der Käufer meldet sich für paydirekt über das Online-Banking seiner Hausbank an. Jede Zahlung wird durch die Hausbank des Käufers autorisiert und unmittelbar am Girokonto verbucht. Die Authentifikation des Käufers erfolgt durch ein adaptives Authentifizierungsverfahren. Bei jeder Zahlung ist zugleich eine Altersverifikation möglich.

Vorteile für den Händler sind die einfache Anbindung von paydirekt in das Shopsystem, eine hohe Transaktionssicherheit durch die Abwicklung der beteiligten Banken und Sparkassen und deren Bonitätsprüfung, die bestehende Zahlungsgarantie, sobald nach positiver Zahlungsbestätigung die Buchung ausgelöst ist, sowie die einfache Handhabung von Retouren und Reklamationen.


Logo

Info

Über paydirekt lassen sich Online-Einkäufe einfach und direkt vom Girokonto bezahlen. Händler profitieren von einer den strengen Anforderungen der deutschen Kreditwirtschaft entsprechenden Alternative zu bestehenden Online-Bezahlverfahren.

TypZahlungen per Onlineüberweisung

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


Diagramm zum Prozessablauf

paydirekt Prozessablauf


Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

ISODateTime (JJJJ-MM-TTThh:mm:ss)


Abkürzungen:

AbkürzungBeschreibung

CND

Bedingung (condition)

M

Pflicht (mandatory)

O

optional

C

bedingt (conditional)


Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.


Aufruf der paydirekt-Schnittstelle

Eine Zahlung mittels paydirekt kann in zwei Schritten erfolgen, wobei zunächst eine Zahlung für eine Bestellung initialisiert wird, bevor Sie diese dann beim Versand der Ware separat buchen. Alternativ kann die Zahlung auch in einem Schritt als Sale-Transaktion erfolgen. Die Folgetransaktionen erfolgen dann über eine Server-zu-Server-Verbindung. Damit können Sie diese Zahlungen buchen oder bei einer Rückgabe eine Gutschrift erteilen.

Um eine Zahlung mit paydirekt über ein Paygate-Formular abzuwickeln, rufen Sie folgende URL auf:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

TransID

ans..20

M

TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

RefNr

ns..30

O

eindeutige Referenznummer

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

OrderDesc

ans..768

O

Beschreibung der gekauften Waren, Einzelpreise etc.

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

UserData

ans..1024

O

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

URLSuccess

ans..256

M

Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData.

URLFailure

ans..256

M

Vollständige URL, die das Paygate aufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData.

Response

a7

O

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

URLNotify

ans..256

M

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

ReqID

ans..32

O

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

Capture

an..6

O

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture). AUTO: Buchung sofort nach der Autorisierung (Standardwert). MANUAL: Buchung erfolgt durch den Händler. <Zahl>: Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

ShopApiKey

ans..64

M

API-Key des Shops bei paydirekt

shAmount

n..10

O

Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

ShoppingBasketAmount

n..10

O

Warenwert der Bestellung ohne Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

ArticleList

ans..1024

O

Artikelliste mit Beschreibung der Waren und Preise: <Menge>;<Name>;<EAN>; <Preis>

<;> trennt Felder innerhalb eines Artikeldatensatzes
<+> trennt mehrere Artikeldatensätze

Menge: Anzahl der Positionen des Artikels

Name: Bezeichnung des Artikels

EAN: Internationale Artikelnummer (EAN bzw. GTIN), (falls nicht bekannt, dann als Leerstring „“)

Preis: Einzelpreis des Artikels inkl. Steuern; Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Email

ans..100

O

E-Mail-Adresse des Kunden

MinAge

n..3

O

Mindestalter in Jahren

ShoppingBasketCategory

a..8

O

Kategorisiert den Warenkorb:

„DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern

„PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern

„MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern

"ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende

"AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen

sdFirstName

ans..50

C

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

sdLastName

ans..50

C

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

sdCompany

ans..100

O

Firmenname in der Lieferanschrift

sdAddressAddition

ans..30

O

Adresszusatz in der Lieferanschrift

sdStreet

ans..100

C

Straßenname in der Lieferanschrift

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

sdStreetNr

ans..8

C

Hausnummer in der Lieferanschrift

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

sdZip

n..5

C

Postleitzahl in der Lieferanschrift

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

sdCity

ans..100

C

Ort in der Lieferanschrift

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

sdCountry­Code

an2

C

Ländercode in der Lieferanschrift

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

sdEmail

ans..100

C

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

Note

ans..37

O

Text, der dem Kunden im Verwendungszweck angezeigt wird

CustomerID

ans..64

O

Kundennummer

OverCapture

bool

O

Flag für Overcapture-Checkouts. Standard ist false.

Bei einem Overcapture-Checkout darf die Summe der Captures den Warenwert der Bestellung um bis zu 10% übersteigen.

Overcapture darf nur bei einem Checkout des Typs ORDER aktiviert sein.

OverCapture kann nur von Händlern verwendet werden, die bei paydirekt und Computop für dieses Feature freigeschaltet wurden.

DeliveryMethod

ans..12

O

Lieferort: STANDARD, PACKSTATION oder STORE_PICKUP. Der Standardwert ist STANDARD.

STANDARD: Die Güter werden an eine gewöhnliche Postadresse geliefert.

PACKSTATION: Die Güter werden an eine Packstation geliefert.

STORE_PICKUP: Die Güter werden in der Filiale abgeholt.

Dieses Feld enthält bei Express-Checkouts immer den Wert STANDARD und wird nicht anhand der gewählten Lieferoption aktualisiert.

DeliveryDate

dttm

O

Erwartetes Versanddatum im Format YYYY-MM-DD

ParcelService

ans..16

O

Paket-Dienstleister

TrackingNumber

ans..64

O

Sendungsnummer

Plain

ans..50

O

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

Custom

ans..1024

O

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

Parameter für Zahlungen mit paydirekt


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..20

M

Transaktionsnummer des Händlers

Status

a..50

M

OK, AUTHORIZE_REQUEST oder FAILED

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

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

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

RefNr

ns..30

O

eindeutige Referenznummer

UserData

ans..1024

O

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

TID

ans..32

O

Eindeutige Identifikation des Vorgangs und aller dazugehörigen Transaktionen bei paydirekt. Diese ID ist vorhanden, sobald sich ein Kunde auf der Checkout-Seite eingeloggt hat.

Reference

ans..36

M

Eindeutige ID des Vorgangs bei paydirekt

TransactionID

ans36

O

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

ShoppingBasketCategory

a..8

O

Kategorisiert den Warenkorb:

„DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern

„PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern

„MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern

"ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende

"AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen

sdFirstName

ans..50

C

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

sdLastName

ans..50

C

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

sdCompany

ans..100

O

Firmenname in der Lieferanschrift

sdAddressAddition

ans..30

O

Adresszusatz in der Lieferanschrift

sdStreet

ans..100

C

Straßenname in der Lieferanschrift

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

sdStreetNr

ans..8

C

Hausnummer in der Lieferanschrift

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

sdZip

n..5

C

Postleitzahl in der Lieferanschrift

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

sdCity

ans..100

C

Ort in der Lieferanschrift

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

sdCountryCode

an2

C

Ländercode in der Lieferanschrift

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

sdEMail

ans..100

C

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

AgeAccepted

a..12

O

ACCEPTED oder NOT ACCEPTED

Plain

ans..50

O

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

Custom

ans..1024

O

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

Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei paydirekt



paydirekt oneKlick

Im Gegensatz zum Standard-Checkout muss sich der Kunde für oneKlick einmalig registrieren. Die Registrierung stellt im Paygate ein eigenes Payment dar (AUTHORIZE), das aber nicht für weitere Aktionen nutzbar ist. Bei erfolgreicher Registrierung gibt das Paygate einen Token zurück (BillingAgreementID), der für alle nachfolgenden oneKlick-Transaktionen genutzt werden kann. Außerdem muss der Kunde eine E-Mail bestätigen, erst danach kann oneKlick genutzt werden.

Bei einem oneKlick-Checkout muss die BillingAgreementID ans Paygate gesendet werden. Statt der Weiterleitung an paydirekt wird der Checkout nun ohne weitere Bestätigung des Kunden abgeschlossen.


oneKlick-Registrierung

Die oneKlick-Registrierung kann als separater Prozess oder im Zuge eines Checkouts erfolgen. Die separate Registrierung verläuft über ein eigenes Formular. Nach der Registrierung erfolgen alle Folgetransaktionen über eine Server-zu-Server-Verbindung. Mit oneKlick können Sie Zahlungen trennen in Autorisierung und Buchung oder sofort buchend (SALE).

Die separate oneKlick-Registrierung als auch die Registrierung bei Checkout erfolgen immer über das Paygate-Formular mit der folgenden URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Hinweis: Die DeviceID oder der DeviceFingerPrint müssen für jedes Endgerät des Kunden eindeutig sein. Paydirekt bietet für iOS und Android ein SDK an, um eine eindeutige DeviceId zu erzeugen. Für Webanwendungen können Libraries wie Fingerprint.js ( https://github.com/Valve/fingerprintjs2 ) verwendet werden, um einen eindeutigen Fingerprint zu erhalten.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

TransID

ans..20

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

eindeutige Referenznummer

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

OrderDesc

ans..768

O

Beschreibung der gekauften Waren, Einzelpreise etc.

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

UserData

ans..1024

O

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

URLSuccess

ans..256

M

Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData.

URLFailure

ans..256

M

Vollständige URL, die das Paygate aufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData.

Response

a7

O

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

URLNotify

ans..256

M

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

ReqID

ans..32

O

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

ShopApiKey

ans..64

M

API-Key des Shops bei paydirekt

Plain

ans..50

O

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

Custom

ans..1024

O

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

EventToken

a8

M

"oneKlick": Weiterleitung zur paydirekt-Anmeldeseite für OneKlick.

"recurring": Weiterleitung zur paydirekt-Anmeldeseite für Recurring-OneKlick. Zusätzlich können Angaben zum Zahlplan im Parameter usageAgreement mitgegeben werden. Diese werden dann auf der paydirekt-Anmeldeseite angezeigt.

"ADS" – Anmeldung zu OneKlick während des Checkouts (während des Checkouts kann keine Anmeldung für recurring erfolgen). Für die Anmeldung zu OneKlick während des Checkouts müssen zusätzlich auch die für die OneKlick-Anmeldung notwendigen Device-Parameter mitgesendet werden.

usageAgreementans..256COptional, wenn EventToken="recurring": Details für wiederkehrende Zahlungen im JSON-Format. Siehe unten.

DeviceId

ans..64

C

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

DeviceFingerPrint

ans..64

O

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

Device

ans..20

M

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

Parameter für oneKlick-Registrierung mit paydirekt


usageAgreement

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

StartDate

ans10

M

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

IntervalUnit

a..7

M

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

Interval

n..

M

Frequenz der Zahlung

 

Beispiel usageAgreement als JSON-String

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

Der im JSON-Format erstellte Parameter muß Base64 encodiert werden.


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..20

M

Transaktionsnummer des Händlers

Status

a..50

M

OK, AUTHORIZE_REQUEST oder FAILED

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

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

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

RefNr

ns..30

O

eindeutige Referenznummer

UserData

ans..1024

O

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

BillingAgreementID

an..44

O

CustomerAuthorizationReference einer gültigen Käuferautorisierung.

Zweck: Rechterweiterung des ausgestellten Tokens um die Möglichkeit, Aktionen im Namen dieses Käufers innerhalb des in der Autorisierung enthaltenen Scopes durchzuführen. Wird für oneKlick-Checkouts benötigt.

Plain

ans..50

O

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

Custom

ans..1024

O

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

Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei paydirekt



Aufruf der paydirekt oneKlick-Schnittstelle

Zahlungen mit oneKlick sind mit Hilfe der BillingAgreementID über eine Server-zu-Server-Kommunikation möglich. Zahlungen mittels oneKlick sind als Autorisierung möglich, die dann separat gebucht werden muss, oder auch als Sale-Transaktion mit sofortiger Buchung.

Um eine oneKlick-Zahlung mit paydirekt über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

TransID

ans..20

M

TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

RefNr

ns..30

O

eindeutige Referenznummer

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

OrderDesc

ans..768

O

Beschreibung der gekauften Waren, Einzelpreise etc.

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

UserData

ans..1024

O

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

ReqID

ans..32

O

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

Capture

an..6

O

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture). AUTO: Buchung sofort nach der Autorisierung (Standardwert). MANUAL: Buchung erfolgt durch den Händler. <Zahl>: Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

ShopApiKey

ans..64

M

API-Key des Shops bei paydirekt

shAmount

n..10

O

Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

ShoppingBasketAmount

n..10

O

Warenwert der Bestellung ohne Versandkosten in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

ArticleList

ans..1024

O

Artikelliste mit Beschreibung der Waren und Preise: <Menge>;<Name>;<EAN>; <Preis>

<;> trennt Felder innerhalb eines Artikeldatensatzes
<+> trennt mehrere Artikeldatensätze

Menge: Anzahl der Positionen des Artikels

Name: Bezeichnung des Artikels

EAN: Internationale Artikelnummer (EAN bzw. GTIN), (falls nicht bekannt, dann als Leerstring „“)

Preis: Einzelpreis des Artikels inkl. Steuern; Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Email

ans..100

O

E-Mail-Adresse des Kunden

MinAge

n..3

O

Mindestalter in Jahren

ShoppingBasketCategory

a..8

O

Kategorisiert den Warenkorb:

„DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern

„PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern

„MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern

"ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende

"AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen

sdFirstName

ans..50

C

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

sdLastName

ans..50

C

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

sdCompany

ans..100

O

Firmenname in der Lieferanschrift

sdAddressAddition

ans..30

O

Adresszusatz in der Lieferanschrift

sdStreet

ans..100

C

Straßenname in der Lieferanschrift

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

sdStreetNr

ans..8

C

Hausnummer in der Lieferanschrift

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

sdZip

n..5

C

Postleitzahl in der Lieferanschrift

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

sdCity

ans..100

C

Ort in der Lieferanschrift

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

sdCountry­Code

an2

C

Ländercode in der Lieferanschrift

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

sdEmail

ans..100

C

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

IPAddressans..15MIP-Adresse des Kunden

Note

ans..37

O

Text, der dem Kunden im Verwendungszweck angezeigt wird

CustomerID

ans..64

O

Kundennummer

DeliveryMethod

ans..12

O

Lieferort: STANDARD, PACKSTATION oder STORE_PICKUP. Der Standardwert ist STANDARD.

STANDARD: Die Güter werden an eine gewöhnliche Postadresse geliefert.

PACKSTATION: Die Güter werden an eine Packstation geliefert.

STORE_PICKUP: Die Güter werden in der Filiale abgeholt.

Dieses Feld enthält bei Express-Checkouts immer den Wert STANDARD und wird nicht anhand der gewählten Lieferoption aktualisiert.

DeliveryDate

dttm

O

Erwartetes Versanddatum im Format YYYY-MM-DD

ParcelService

ans..16

O

Paket-Dienstleister

TrackingNumber

ans..64

O

Sendungsnummer

BillingAgreementID

an..44

M

CustomerAuthorizationReference einer gültigen Käuferautorisierung.

Zweck: Rechterweiterung des ausgestellten Tokens um die Möglichkeit, Aktionen im Namen dieses Käufers innerhalb des in der Autorisierung enthaltenen Scopes durchzuführen. Wird für oneKlick-Checkouts benötigt.

Parameter für Zahlungen mit paydirekt oneKlick


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..20

M

Transaktionsnummer des Händlers

Status

a..50

M

OK, AUTHORIZE_REQUEST oder FAILED

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

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

RefNr

ns..30

O

eindeutige Referenznummer

UserData

ans..1024

O

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

TID

ans..32

O

Eindeutige Identifikation des Vorgangs und aller dazugehörigen Transaktionen bei paydirekt. Diese ID ist vorhanden, sobald sich ein Kunde auf der Checkout-Seite eingeloggt hat.

Reference

ans..36

M

Eindeutige ID des Vorgangs bei paydirekt

TransactionID

ans36

O

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

ShoppingBasketCategory

a..8

O

Kategorisiert den Warenkorb:

„DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern

„PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern

„MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern

"ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende

"AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen

sdFirstName

ans..50

C

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

sdLastName

ans..50

C

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

sdCompany

ans..100

O

Firmenname in der Lieferanschrift

sdAddressAddition

ans..30

O

Adresszusatz in der Lieferanschrift

sdStreet

ans..100

C

Straßenname in der Lieferanschrift

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

sdStreetNr

ans..8

C

Hausnummer in der Lieferanschrift

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

sdZip

n..5

C

Postleitzahl in der Lieferanschrift

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

sdCity

ans..100

C

Ort in der Lieferanschrift

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

sdCountryCode

an2

C

Ländercode in der Lieferanschrift

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

sdEMail

ans..100

C

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

AgeAccepted

a..12

O

ACCEPTED oder NOT ACCEPTED

Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei paydirekt oneKlick



Buchung

Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für paydirekt über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die zu buchende Transaktion

TransID

ans..20

M

TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

RefNr

ns..30

O

Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a..3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

OrderDesc

ans..768

O

Beschreibung der gekauften Waren, Einzelpreise, Händlerkommentar etc.

UserData

ans..1024

O

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

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

CompleteType

ans..3

O

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

Note

ans..37

O

Text, der dem Kunden im Verwendungszweck angezeigt wird

Parameter für paydirekt-Buchungen


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..20

M

Transaktionsnummer des Händlers

Status

a..50

M

OK, CAPTURE_REQUEST oder FAILED

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

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

RefNr

ns..30

O

Referenznummer des Händlers

UserData

ans..1024

O

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

TransactionID

ans36

O

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

Ergebnis-Parameter für paydirekt-Buchungen



Gutschrift mit Referenz

Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Gutschriften sind bis zum Betrag von 200% über Buchung möglich, wenn das vom Computop Support für die Zahlungsart beim Händler konfiguriert wurde. Um eine Gutschrift (Credit) mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die gutzuschreibende Transaktion

TransID

ans..20

M

TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a..3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

OrderDesc

ans..768

O

Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc.

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

RefNr

ans..30

O

Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss

UserData

ans..1024

O

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

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

Note

ans..37

O

Text, der dem Kunden im Verwendungszweck angezeigt wird

Parameter für Gutschrift von paydirekt-Zahlungen


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..20

M

Transaktionsnummer des Händlers

Status

a..50

M

OK oder FAILED

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

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

RefNr

ns..30

O

Referenznummer des Händlers

UserData

ans..1024

O

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

TransactionID

ans36

O

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

Ergebnis-Parameter für Gutschrift von paydirekt-Zahlungen



Aufruf der Schnittstelle für Stornierungen

Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Transaktion bei paydirekt zu stornieren, verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die gutzuschreibende Transaktion

TransID

ans..20

M

TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a..3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

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

Parameter für Storno von paydirekt-Zahlungen


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

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

TransID

ans..20

M

Transaktionsnummer des Händlers

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a..3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

Status

a..50

M

OK oder FAILED

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

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

Ergebnis-Parameter für Storno von paydirekt-Zahlungen



Batch-Nutzung der Schnittstelle

Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.

Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer paydirekt-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.

Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:

Aktion

Version

Beschreibung

Capture

1.0 / 2.0

Standardversion ohne Rückgabe von Code

 

1.x / 2.x

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

Credit

1.0 / 2.0

Standardversion ohne Rückgabe von Code

 

1.x / 2.x

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

Beschreibung der möglichen Batch-Versionen


Der Aufbau für eine paydirekt-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:

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

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

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

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

FOOT,<CountRecords>,<SumAmount>


Beispiel für Master MID Funktion:

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


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

Parameter

Format

CND

Beschreibung

Type

a..11

M

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

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

TransID

ans..20

M

TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.

RefNr

ns..30

O

eindeutige Referenznummer

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Beschreibung der Felder im Datensatz von Batch-Dateien



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

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

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

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

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

FOOT,<CountRecords>,<SumAmount>


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

Parameter

Format

CND

Beschreibung

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Status

a..50

M

OK oder FAILED

Code

n8

M

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

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien