Über Gothia PayByBill

Allgemeines zu PayByBill

Mit PayByBill der Gothia Financial Group bieten Sie Ihren Kunden beliebte Zahlungsarten wie Lastschrift und Kauf auf Rechnung oder eine flexible Ratenzahlung an, wobei Sie eine eigene Rechnung mitsenden. Zugleich erhalten Sie jedoch pünktlich und sicher Ihre Zahlungen; um das Inkasso kümmert sich PayByBill.

Weitere Informationen finden Sie auch auf der Webseite von PayByBill (www.paybybill.com/de).

Diagramme zum Prozessablauf

Image Removed

Prozessablauf PayByBillImage Removed

Prozessablauf PayByBill Ratenzahlung

Multiexcerpt include
SpaceWithExcerpt DE MultiExcerptName Platform-Kurz PageWithExcerpt Wording

-Schnittstelle

PayByBill Rechnungs- und Ratenkauf

Dieses Kapitel beschreibt, wie Sie eine PayByBill-Zahlung reservieren. Nach erfolgreicher Reservierung können Sie PayByBill-Zahlungen bei Lieferung buchen oder bei Bedarf gutschreiben. Zusätzlich können Sie PayByBill-Reservierungen auch stornieren.

Um eine Zahlung mit PayByBill über eine Server-zu-Server-Verbindung abzuwickeln, rufen verwenden Sie bitte folgende URL auf:

https://www.computop-paygate.com/paybybill.aspx

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ans..30

O

eindeutige Referenznummer

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

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.

PayType

ans..16

M

Zahlungsart: “Invoice” für Rechnung oder “DirectDebet” für Lastschrift. „DirectDebet“ nur für Deutschland erlaubt. Bei Ratenkauf über Deutschland nur „DirectDebet“ erlaubt.

FirstName

ans..30

M

Vorname des Kunden

LastName

ans..30

M

Nachname des Kunden oder Firmenname

AddrStreet

ans..128

M

Straße des Kunden

AddrHouseNr

ans..5

O

Hausnummer des Kunden

AddrZipCode

ans..15

M

Postleitzahl des Kunden

AddrCity

ans..30

M

Wohnort des Kunden

AddrCountryCode

a2

M

Ländercode des Wohnortes, zweistellig gemäß ISO 3166

BirthDate

ans..10

OC

Pflicht, falls AddrCountryCode=DE: Geburtsdatum im Format YYYY-MM-DD

Parameter für Zahlungen mit PayByBill

SocialSecurityNumber

ans..20

OC

Pflicht, falls AddrCountryCode ungleich DE. Sozialversicherungsnummer, falls CompanyOrPerson=P. Handelsregisternummer, falls CompanyOrPerson=C.

Länderspezifische Formate

SE: DDMMYYNNNN

NO: DDMMYYNNNNN

DK: DDMMYY-NNNN

FI: DDMMYY-NNNN

NL: DDMMYYYY

Email

ans..100

M

E-Mail-Adresse des Kunden

Phone

ans..20

O

Telefonnummer des Kunden

MobileNo

ans..16

O

Mobiltelefonnummer des Kunden

AccIBAN

n8

OC

Pflicht, falls PayType=DirectDebet: Identifikation des Finanzinstituts des Kontoinhabers

AccNr

n..11

OC

Pflicht, falls PayType=DirectDebet; Kontonummer des Kontoinhabers

CustomerID

ans..50

M

Kundennummer beim Händler

CompanyOrPerson

a1

O

P=Person (Standard), C=Company

Salutation

ans..10

O

Anrede – “Mr”, “Mrs”, “Miss”

Title

ans..20

O

Titel z.B. Dr. oder Prof.

DistributionType

ans..8

O

Auslieferungsart der Rechnung: „Paper“ oder per „Email“

DistributionBy

ans..8

O

Auslieferer der gedruckten Rechnung. „Company“ für Gothia; „Client“, wenn der Händler selbst der Auslieferer ist.

bei Ratenkauf

EventToken

a2

M

1. Aufruf: „IP“ für Installment Purchase (zur Anforderung der AGB und AcceptID)

2 Aufruf: „AT“ für AcceptAccountTermsAndConditions (zur Bestätigung der AGB)

Month

n..2

M

Anzahl der Raten

ProductNr

ans..4

O

Account-Profilnummer, wie bei Gothia konfiguriert, z.B. „1“

PayID

an32

OC

bei zweitem Aufruf Pflicht: ID des Paygate zur Identifizierung einer Zahlung

Parameter für Zahlungen mit PayByBill

Folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihr System zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Transaktionsnummer des Händlers

Status

a..50

M

OK oder FAILED. AUTHORIZE_REQUEST beim ersten Aufruf mit EventToken=IP

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

CodeExt

n..10

O

Fehlercode von PayByBill, wenn mit Computop Support abgesprochen

ErrorText

ans..1024

O

Fehlertext von PayByBill, wenn mit Computop Support abgesprochen

InstallmentData

ans..1024

O

Ratenplan

InstallmentData=<Monat>;<Zahlungsbetrag>;

<Kapitalbalance>;<Gebühren>;<Zinsen>+ <Monat>;<Zahlungsbetrag>;…

TermsAndConditions

ans..1024

O

AGBs für die Ratenzahlung

FirstName

ans..128

O

Vorname

LastName

ans..128

O

Nachname

AddrStreet

ans..255

O

Straße und Hausnummer der Lieferadresse

AddrZip

ans..20

O

Postleitzahl der Lieferadresse

AddrCity

ans..50

O

Ortsname der Lieferadresse

InvoiceText

ans..1024

O

Zugangsdaten für das Ratenzahlungsvereinbarungsportal sowie die minimale Ratenhöhe des Produkts, sowie Rechnungsinformationen.

Beispiel:

InvoiceText=<minimale Ratenhöhe>;<Text>;<Kontonummer>;<Passwort>;<LogonText>;<OCR-Nummer>

Ergebnis-Parameter für PayByBill-Zahlungen

Buchung

Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Rechnungsstellung / einen Versand über PayByBill auszuführen, verwenden Sie bitte folgende URL:

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die zu buchende Transaktion

TransID

ans..64

M

Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang

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ährung, drei Zeichen DIN / ISO 4217

RefNr

ns..30

O

Referenznummer des Händlers (z.B. Rechnungsnummer)

MAC

an64

M

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

InvoiceNr

ans..16

M

eindeutige Rechnungsnummer

ProductNr

ans..4

O

Rechnungsprofilnummer, wie bei Gothia konfiguriert; z.B. „1“.

ArticleList

ans..1024

M

Artikelliste mit Beschreibung der Waren und Preise:

< Artikelnummer >;<Anzahl>;<Artikelbeschreibung>; <Nettopreis>;<Bruttopreis>;<MwSt>;<Steuersatz>;<Maßeinheit>

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

Datentyp (Größe):

Artikelnummer (ans..100)

Anzahl (n..3)

Artikelbeschreibung (ans..100)

Nettopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Bruttopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

MwSt.  (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Steuersatz (n..2), z.B. „19“ für 19%)

Maßeinheit (ans..50), z.B. st für Stück, kg für Kilogramm oder l für Liter

BDStreet

ans..100

M

Straßenname in der Rechnungsadresse

BDHouseNr

ans..5

O

Hausnummer in der Rechnungsadresse

BDCity

ans..100

M

Ort in der Rechnungsadresse

BDCountryCode

a2

M

Ländercode in der Rechnungsadresse, zweistellig gemäß ISO 3166

BDZipCode

ans..8

M

Postleitzahl in der Rechnungsadresse

DueDate

n8

O

Fälligkeitsdatum im Format DDMMYYYY

InvoiceDate

n8

O

Rechnungsdatum im Format DDMMYYYY

TxAmount

n..10

O

Steuerbetrag der gesamten Bestellung 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.

NetAmount

n..10

O

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

Parameter für PayByBill-Buchungen

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Transaktionsnummer des Händlers, die eindeutig sein muss

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

Reference

ans..16

O

Referenznummer für PayByBill (OCR-Nummer)

DocumentLink

ans..1024

O

Link zum PDF-Dokument der Rechnung

InvoiceText

ans..1024

O

Zugangsdaten für das Ratenzahlungsvereinbarungsportal sowie die minimale Ratenhöhe des Produkts, sowie Rechnungsinformationen.

Beispiel:

InvoiceText=<minimale Ratenhöhe>;<Text>;<Kontonummer>;<Passwort>;<LogonText>;<OCR-Nummer>

File

ans..1024

O

Ratenzahlungsvertrag als PDF-Dokument: Base64-codierter Datenstring

CodeExt

n..10

O

Fehlercode von PayByBill, wenn mit Computop Support abgesprochen

ErrorText

ans..256

O

Parameter für PayByBill-Buchungen

Ergebnis-Parameter für PayByBill-Buchungen

Gutschrift mit Referenz und Teilgutschrift

Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorangegangen Buchung beschränkt. Um eine Gutschrift (Credit) mit Referenztransaktion (Retoure über PayByBill) auszuführen, verwenden Sie bitte folgende URL:

https://www.computop-paygate.com/credit.aspx

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter für PayByBill-Gutschriften

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

Vom Paygate vergebene ID für die gutzuschreibende Transaktion

TransID

ans..64

M

Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang

Amount

n..10

M

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

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

Currency

a..3

M

Währung, drei Zeichen DIN / ISO 4217

RefNr

ns..30

O

Referenznummer des Händlers (z.B. Rechnungsnummer)

MAC

an64

M

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

InvoiceNr

ans..16

M

Nummer der Rechnung, auf die sich die Gutschrift bezieht

ArticleList

ans..1024

M

Artikelliste mit Beschreibung der Waren und Preise:

< Artikelnummer >;<Anzahl>;<Artikelbeschreibung>; <Nettopreis>;<Bruttopreis>;<MwSt>;<Steuersatz>;<Maßeinheit>

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

Datentyp (Größe):

Artikelnummer (ans..100)

Anzahl (n..3)

Artikelbeschreibung (ans..100)

Nettopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Bruttopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

MwSt.  (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Steuersatz (n..2), z.B. „19“ für 19%)

Maßeinheit (ans..50), z.B. st für Stück, kg für Kilogramm oder l für Liter

TxAmount

n..10

O

Steuerbetrag der gesamten Bestellung 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.

NetAmount

n..10

O

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

Parameter für PayByBill-Gutschriften

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Transaktionsnummer des Händlers, die eindeutig sein muss

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 (z.B. Rechnungsnummer)

Reference

ans..16

O

Referenznummer für PayByBill

CodeExt

n..10

O

Fehlercode von PayByBill, wenn mit Computop Support abgesprochen

ErrorText

ans..256

O

Ergebnis-Parameter für PayByBill-Gutschriften

Storno und Aktualisierung

Um eine Transaktion bei PayByBill zu stornieren, rufen verwenden Sie bitte folgende URL auf:

https://www.computop-paygate.com/reverse.aspx

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

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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 stornierende Transaktion

TransID

ans..64

M

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs

RefNr

ns..30

O

Referenznummer des Händlers (z.B. Rechnungsnummer)

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ährung, drei Zeichen DIN / ISO 4217

MAC

an64

M

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

Parameter für Storno von PayByBill-Zahlungen

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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Transaktionsnummer des Händlers, die eindeutig sein muss

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 (z.B. Rechnungsnummer)

CodeExt

n..10

O

Fehlercode von PayByBill, wenn mit Computop Support abgesprochen

ErrorText

ans..256

O

Ergebnis-Parameter für PayByBill-Stornierung

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 PayByBill-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können. Es ist nur eine komplette Stornierung möglich.

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

Aktion

Version

Beschreibung

Reverse

1.0 / 2.0

Standardversion ohne Rückgabe von Code

1.x / 2.x

Beschreibung der möglichen Batch-Versionen

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

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

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

FOOT,<CountRecords>,<SumAmount>

Beispiel für Master MID Funktion:

Beispiel für Master-MID-Funktion:

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

Type

a..11

M

HEAD für Header, FOOT für Footer, PayByBill für PayByBill

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

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

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ns..30

O

eindeutige Referenznummer

PayID

an32

M

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>

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

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:

Reverse (Storno)

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Status

a..50

M

OK oder FAILED

Code

n8

M

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien