Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation
Table of Contents


About Gothia PayByBill

General information about PayByBill

With PayByBill from the Gothia Financial Group you can offer your customers popular methods of payment such as direct debit, purchase on invoice or flexible hire purchase. PayByBill enables merchants to send their own invoice. At the same time merchants will receive payments. PayByBill takes care of the debt collection.


Page properties
Logo

Info
Excerpt

PayByBill enables merchants to offer payment methods such as invoice purchasing, financing and direct debit. The solution offers merchants a payment guarantee and is available for Denmark, Germany, Finland, the Netherlands, Norway and Sweden.

TypePayments by Cash-In / Bill

 

Further information can be found on the webpage of PayByBill (www.paybybill.com/de).

 

Process flow charts

Multiexcerpt
MultiExcerptNameProcessFlow

draw.io Diagram
bordertrue
diagramNamePayByBill_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Process flow PayByBill

 

Multiexcerpt
MultiExcerptNameProcessFlow_Installment

draw.io Diagram
bordertrue
diagramNamePayByBill_Installment_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Process flow PayByBill installment payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


PayByBill purchase on invoice and hire purchase

This chapter describes how to reserve a PayByBill payment. Following successful reservation you can capture PayByBill payments or if necessary credit them. Merchants can also cancel PayByBill reservations.

In order to execute a PayByBill payment via server-to-server communication, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
paybybill.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661490737286_-840347001
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaybybill_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661490737287_827803962
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

PayTypeans..16MPayment type: “Invoice” or “DirectDebet”. “DirectDebet” is permitted in Germany only. In case of hire purchase via Germany only ‘DirectDebet’ is allowed.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

First name of the custumer

Vorname des Kunden

LastName

ans..30

M

Last name of the customer or company name

Nachname des Kunden oder Firmenname

AddrStreet

ans..128

M

Customer’s street

Straße des Kunden

AddrHouseNr

ans..5

O

Customer’s street number

Hausnummer des Kunden

AddrZipCode

ans..15

M

Postcode of the customer

Postleitzahl des Kunden

AddrCity

ans..30

M

Customer’s place of residence

Wohnort des Kunden

AddrCountryCode

a2

M

Country code of the customer's residence, 2 characters according to ISO 3166

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

BirthDate

ans..10

OC

Obligatory if AddrCountryCode=DE: Date of birth in the format YYYY-MM-DD

Pflicht, falls AddrCountryCode=DE: Geburtsdatum im Format JJJJ-MM-TT
SocialSecurityNumberans..20OC

Obligatory if AddrCountryCode=DE: Social security number if CompanyOrPerson=P. Register of Companies number if CompanyOrPerson=C.

Country-specific formats

SE: DDMMYYNNNN

NO: DDMMYYNNNNN

DK: DDMMYY-NNNN

FI: DDMMYY-NNNN

NL: DDMMYYYY

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

Email address of the customer

E-Mail-Adresse des Kunden

Phone

ans..20

O

Customer’s phone number

Telefonnummer des Kunden

MobileNo

ans..16

O

Customer’s mobile telephone number

Mobiltelefonnummer des Kunden

AccIBAN

n8

OC

Obligatory if PayType=DirectDebet: Identification of the financial institution of the account holder

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

AccNr

n..11

OC

Obligatory if PayType=DirectDebet: account holder’s account number

Pflicht, falls PayType=DirectDebet; Kontonummer des Kontoinhabers

CustomerID

ans..50

M

Customer number at the merchant

Kundennummer beim Händler

CompanyOrPerson

a1

O

P=Person (standard), C=Company

P=Person (Standard), C=Company

Salutation

ans..10

O

Salutation – ‘Mr’, ‘Mrs’, ‘Miss’

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

Title

ans..20

O

Title, e.g. Dr. or Prof.

Titel z.B. Dr. oder Prof.

DistributionType

ans..8

O

Method of dispatch of the invoice: ‘paper’ or by ‘email’

Auslieferungsart der Rechnung: „Papier“ oder per „E-Mail“

DistributionBy

ans..8

O

Sender of the printed invoice. ‘Company’ for Gothia; ‘Client’ if the merchant is the sender.

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



In case of hire purchasebei Ratenkauf

EventToken

a2

M

1. call: “IP” for Instalment Purchase (to request the terms & conditions and AcceptID)

2. call: “AT” for AcceptAccountTermsAndConditions (to confirm the terms & conditions)

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

Number of instalments

Anzahl der Raten

ProductNr

ans..4

O

Account profile number, as configured with Gothia, e.g. ‘1’

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

PayID

an32

OC

Obligatory on second call:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
ID for the identification of a payment

bei zweitem Aufruf Pflicht: ID des

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePlatform-Kurz
PageWithExcerptDE:Wording
zur Identifizierung einer Zahlung

Parameters for payments with PayByBill


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661492034076_-2044679091
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepaybybill_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661492034078_1366861904
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Statusa..50MOK (URLSuccess) or FAILED (URLFailure), AUTHORIZE_REQUEST on first call with EventToken=IP
OK (URLSuccess) oder FAILED (URLFailure), AUTHORIZE_REQUEST beim ersten Aufruf mit EventToken=IP

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorText

ans..1024256

O

Error text from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

InstallmentData

ans..1024

O

Installment plan

InstallmentData=<Month>;<PaymentAmount>;

<CapitalBalance>;<Fees>;<Interest>+ <Month>;<PaymentAmount>; …

Ratenplan

InstallmentData=<Monat>;<Zahlungsbetrag>;

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

TermsAndConditions

ans..1024

O

Terms & conditions for payment by instalment

AGBs für die Ratenzahlung

FirstName

ans..128

O

First name

Vorname

LastName

ans..128

O

Last name

Nachname

AddrStreet

ans..255

O

Street and street number in the delivery address

Straße und Hausnummer der Lieferadresse

AddrZip

ans..20

O

Postcode in the delivery address

Postleitzahl der Lieferadresse

AddrCity

ans..50

O

Town/city in the delivery address

Ortsname der Lieferadresse

InvoiceText

ans..1024

O

Access data for the instalment payment portal and the minimum instalment amount for the product plus invoice information.

Example:

InvoiceText=<minimum rate amount>;<Text>;<account number>;<password>;<LogonText>;<OCR number>

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>

Result parameters for PayByBill payments

 


Capture

Captures are possible via a Server-to-Server connection. To settle an invoice / carry out dispatch by PayByBill, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
capture.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661371510340_56532525
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661371510342_-1946407383
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Capture
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

InvoiceNrans..16Munique reference numbereindeutige Rechnungsnummer
ProductNrans..4OAccount profile number, as configured with Gothia, e.g. ‘1’Rechnungsprofilnummer, wie bei Gothia konfiguriert; z.B. „1“.
ArticleListans..1024M

Article list with description of items and prices:

<Article number> ;<quantity> ;<article description> ;<net price> ;<gross price> ;<VAT> ;<tax rate>; <unit>

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

Data type (size):

Article number (ans..100)

Quantity (n..3)

Article description (ans..100)

Net amount (n..10) in the smallest currency unit (e.g. EUR Cent)

Gross amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT rate (n..2), e.g. 19 for 19%

unit (ans..50), e.g. kg for kilogram, or l for litre

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

Street name in the invoicing address

Straßenname in der Rechnungsadresse

BDHouseNr

ans..5

O

Street number in the invoicing address

Hausnummer in der Rechnungsadresse

BDCity

ans..100

M

Town/city in the invoicing address

Ort in der Rechnungsadresse

BDCountryCode

a2

M

Country code for the invoicing address, 2 characters according to ISO 3166

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

BDZipCode

ans..8

M

Postcode in the invoicing address

Postleitzahl in der Rechnungsadresse

DueDate

n8

O

Due date in the format DDMMYYYY

Fälligkeitsdatum im Format TTMMJJJJ

InvoiceDate

n8

O

Invoice date in the format DDMMYYYY:

Rechnungsdatum im Format TTMMJJJJ

TxAmount

n..10

O

Tax amount of the entire order in the smallest currency unit (e.g. EUR Cent).

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

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

Net amount in the smallest currency unit (e.g. EUR Cent)

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

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.

Parameters for PayByBill captures

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661372592112_-739284770
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661372592115_630237050
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

Beschreibung

Reference

ans..16

O

Reference number for PayByBill (OCR number)

Referenznummer für PayByBill (OCR-Nummer)

DocumentLink

ans..1024

O

Link to PDF document of the invoice

Link zum PDF-Dokument der Rechnung

InvoiceText

ans..1024

O

Access data for the instalment payment portal and the minimum instalment amount for the product plus invoice information.

Example:

InvoiceText=<minimum rate amount>;<Text>;<account number>;<password>;<LogonText>;<OCR number>

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

Instalment payment contract as PDF document: Base64 encrypted data string

Ratenzahlungsvertrag als PDF-Dokument: Base64-codierter Datenstring

CodeExt

n..10

O

Error code from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorText

ans..256

O

Error text from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

Result parameters for PayByBill captures

 


Credit with reference and partial credit

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture. To carry out a

credit

with a reference transaction (returns via PayByBill), please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptName

BaseURL

Credit_Intro
PageWithExcerptReuse API

credit.aspx

Wording
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661373515763_1625551061
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661373515767_1789096905
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Credit
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

Beschreibung

InvoiceNrans..16MNumber of invoice as reference for the refundNummer der Rechnung, auf die sich die Gutschrift bezieht
ArticleListans..1024M

Article list with description of items and prices:

<Article number> ;<quantity> ;<article description> ;<net price> ;<gross price> ;<VAT> ;<tax rate>; <unit>

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

Data type (size):

Article number (ans..100)

Quantity (n..3)

Article description (ans..100)

Net amount (n..10) in the smallest currency unit (e.g. EUR Cent)

Gross amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT rate (n..2), e.g. 19 for 19%

unit (ans..50), e.g. kg for kilogram, or l for litre

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

Tax amount of the entire order in the smallest currency unit (e.g. EUR Cent).

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

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

Net amount in the smallest currency unit (e.g. EUR Cent)

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

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.

Parameters for PayByBill credits

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661374186507_2040015657
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661374186510_-1033805824
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

Beschreibung

Reference

ans..16

O

Reference number for PayByBill

Referenznummer für PayByBill

CodeExt

n..10

O

Error code from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorText

ans..256

O

Error text from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

Result parameters for PayByBill credits



Reversal and Updating

To reverse a payment with PayByBill, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
reverse.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661374396644_1717209595
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661374396647_1913982407
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Reverse
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for reversals of PayByBill payments

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661376366214_830290949
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamereverse_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661376366216_-1973134797
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlercode von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

ErrorText

ans..256

O

Error text from PayByBill, if agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording

Fehlertext von PayByBill, wenn mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abgesprochen

Result parameters for PayByBill reversals



Batch processing via the interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Intro
PageWithExcerptReuse API
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 PayByBill payment and which information can be found within the response file about the payment status. You can only cancel in full.

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

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661353208752_474723497
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_versions
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661353208754_-1278065342
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Action

Version

Description

Beschreibung

Reverse

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 PayByBill payment within a Batch file to be submitted is the following:

Multiexcerpt
MultiExcerptNamebatch_structure
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
HEAD,<MerchantID>,<Date>,<Version>
PayByBill,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount>


Example for Master MID function:

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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Request_Intro
PageWithExcerptReuse API
The following table describes the individual fields and values used within the data set (record) in the batch file:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661353412024_-1006177078
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661353412026_362935994
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, PayByBill for PayByBill

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

Action

a..20

M

The parameter Action defines the type of transaction:

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Reverse (Storno)

Table Excerpt Include
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks the following way:

Multiexcerpt
MultiExcerptNamebatch_structure_response
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
HEAD,<MerchantID>,<Date>,<Version>
PayByBill,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Response_Intro
PageWithExcerptReuse API
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
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1661354104443_219603824
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1661354104446_463893176
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction:

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Reverse (Storno)

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Description of result parameters within the record for Batch files