About BillPay

General information about BillPay

With BillPay the merchant sends the invoice with the logo and bank details of BillPay. BillPay pays the invoice amount and takes over the complete downstream debtor management.

Notice: Billpay will be discontinued at end of March 2022.


Logo

Info

BillPay enables merchants to offer purchase on account in Germany, Austria, Switzerland and the Netherlands or purchase by direct debit in Germany and Austria. Instalment payments can also be offered in Germany and Austria with PayLater. A graphic snippet provided by BillPay simplifies the calculation of instalments and reduces programming work. A 100% disbursement takes place already after the first month.

TypeMixed payment methods


Further information can be found at the webpage of BillPay (https://www.billpay.de).


Notice: For a simpler integration into the merchant’s shop, BillPay has a Javascript widget which displays BillPay’s payment methods in the checkout process, which must be implemented. The documentation of the widget is available on the website https://techdocs.billpay.de/de/An_Entwickler/JavaScript-Widget.html.

 

Process flow chart

BillPay process flow including payment method control PreScore (above the middle line)


 interface


Calling the interface for Billpay invoice purchase

This chapter describes how to initiate a BillPay payment. After successful initialisation you can post BillPay payments on delivery. Additionally you can partly activate BillPay reservations and in this way set the date of payment for the customer. A subsequent change of the shopping cart is possible via the same interface and is described here. The cancellation of a BillPay payment is explained later in this document.

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

Billpay.aspx


Key

Format

CND

Description

Beschreibung

Language

a2

M

Language code according to ISO 639-1 (e.g. de for German)

Sprachkennzeichen nach ISO 639-1 (z.B. de für Deutsch)

NewCustomerans..5MDefines whether or not the purchaser is a new customer. Values: <YES>, <NO>, <GUEST>Definiert, ob der Käufer ein Neukunde ist. Werte: <YES>, <NO>, <GUEST>
BillPayActionn1M

Defines the method of payment used. Values:

<1> for invoice purchase
<2> for direct debit
<4> for PayLater
<7> for PayLater with assumption of debt
<8> for invoice purchase with assumption of debt
<9> for direct debit with assumption of debt

Definiert, welche Zahlungsart verwendet wird. Werte:

<1> für Rechnungskauf
<2> für Lastschrift
<4> für PayLater
<7> für PayLater mit Schuldbeitritt
<8> für Rechnung mit Schuldbeitritt
<9> für Lastschrift mit Schuldbeitritt

GtcValuea..3MDefines whether or not the customer has confirmed BillPay’s terms and conditions. Values: <YES> or <NO>Definiert, ob der Kunde die AGB von BillPay bestätigt hat. Werte: <YES> oder <NO>
DateOfBirthan10MCBirth date of the customer in the format YYYY-MM-DD (may not be transmitted in the case of BillPay B2B)Geburtsdatum des Kunden im Format JJJJ-MM-TT (darf bei BillPay B2B nicht übergeben werden)
IpAddrans15MCustomer´s IP address in IPv4 or IPv6 formatIP-Adresse des Kunden im Format IPv4 oder IPv6
ActivationDelayn..3OC

Mandatory for BillPayAction = 7, 8 or 9 (assumption of debt)

Number of days until fulfilment of service (e.g. start of journey)

Pflicht bei BillPayAction = 7, 8 oder 9 (Schuldbeitritt)

Anzahl der Tage bis zur Wahrnehmung der Dienstleistung (z.B. Reiseantritt)

CompanyOrPersona1OCDistinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2BUnterscheidung des Käufers nach Privatperson oder Firma. Werte: <F> für Firmen, <P> für Personen, Standardwert <P>. Pflicht bei BillPay B2B
BrowserSessionIDans..100OSessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)SessionID zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget)



Invoice dataRechnungsdaten
bdSalutationa..15M

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Anrede des Kunden auf der Rechnung. Zulässige Werte:

Männlich: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Weiblich: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

bdTitleans..20OTitle of the customer or contact person within the company on the invoice, e.g. Dr. or Prof.Titel des Kunden oder der Kontaktperson in der Firma auf der Rechnung, z.B. Dr. oder Prof.
bdFirstNameans..50MFirst name of customer or contact person in companyVorname des Kunden oder der Kontaktperson in der Firma
bdLastNameans..50MLast name of customer or contact person in companyNachname des Kunden oder der Kontaktperson in der Firma
bdStreeta..50MStreet name in the invoicing addressStraßenname der Rechnungsadresse
bdStreetNrans..5MStreet number of the invoicing addressHausnummer der Rechnungsadresse
bdStreet2a..50OAddress addition in the billing addressAdresszusatz der Rechnungsadresse
bdZipn5MPostcode in the invoicing addressPostleitzahl der Rechnungsadresse
bdCityans..50MTown/city of the invoicing addressOrt der Rechnungsadresse
bdCountryCodea3MCountry code in the billing address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.Ländercode der Rechnungsadresse dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT).
EMailans..50ME-mail address of the customer or contact person on the invoicing addressE-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift
Phoneans..15OC

Telephone number of the customer or contact person on the invoicing address.

Obligatory for hire purchase (BillPayAction=3)

Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift.

Bei Ratenkauf (BillPayAction=3) ist der Parameter Pflicht.

MobileNoans..50OMobile telephone number of the customer on the invoicing addressHandy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift



Delivery dataLieferdaten
UseBillingDataa3MIs the invoicing address to be used as the delivery address? Permissible: <Yes> or <No>. If <No>, parameters for the delivery address become obligatory. If <Yes>, no parameters are transferred for the delivery address.Soll die Rechnungsadresse als Lieferadresse genutzt werden? Zulässig: <Yes> oder <No>. Bei <No> werden Parameter zur Lieferadresse Pflicht. Bei <Yes> werden keine Parameter zur Lieferadresse übergeben.
sdSalutationa..15C

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Obligatory, if UseBillingData=No

Anrede des Kunden auf der Rechnung. Zulässige Werte:

Männlich: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Weiblich: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Pflicht, wenn UseBillingData=No

sdTitleans..20OTitle of the customer on the invoice, e.g. Dr. or Prof.Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof.
sdFirstNameans..50CObligatory, if UseBillingData=No: First name of customer or contact person in companyPflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma
sdLastNameans..50CObligatory, if UseBillingData=No: Last name of customer or contact person in companyPflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma
sdStreeta..50CObligatory, if UseBillingData=No: Street in the delivery addressPflicht, wenn UseBillingData=No: Straßenname der Lieferadresse
sdStreetNrans..5CObligatory, if UseBillingData=No: Street number of the delivery addressPflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse
sdStreet2a..50OAddress addition in the delivery addressAdresszusatz der Lieferadresse
sdZipn5CObligatory, if UseBillingData=No: Postcode in the delivery addressPflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse
sdCityans..50CObligatory, if UseBillingData=No: Town/city of the delivery addressPflicht, wenn UseBillingData=No: Ort der Lieferadresse
sdCountryCodea3CObligatory, if UseBillingData=No: Country code in the delivery address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.Pflicht, wenn UseBillingData=No: Ländercode der Lieferanschrift dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT).
sdPhoneans..15OTelephone number of the customer in the delivery addressTelefonnummer des Kunden in der Lieferanschrift
sdMobileNoans..50OMobile telephone number of the customer in the delivery addressHandy-Nummer des Kunden in der Lieferanschrift



Company dataFirmendaten
CompanyNameans..200CCompany name. Obligatory if CompanyOrPerson=FFirmenname. Pflicht, falls CompanyOrPerson=F
LegalForma..12C

Legal form of the company. Obligatory, if CompanyOrPerson=F

Values: <ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

Rechtsform des Unternehmens. Pflicht, wenn CompanyOrPerson=F

Werte:<ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

RegisterNumberans..20C

Register of Companies number/commercial register

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

Handelsregisternummer/Firmenbuch

Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft

HolderNameans..100C

Optional: Name of the firm owner

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

Optional: Name des Firmeninhabers

Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft

TaxNumberans..20C

VAT Reg. No.

Notice: The specification of the VAT Reg. No. increases the probability of a hit

Umsatzsteueridentifikationsnummer

Hinweis: Die Angabe der USt-ID erhöht die Trefferwahrscheinlichkeit




Article and order dataArtikel- und Bestelldaten
ArticleListans..768M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..
- Artikcle type, optional, Obligatory for BillPayAction 7/8/9; n1:
     0: Other (default value)

     1: Flight

     2: Luggage with flight

     3: Combination of articles with flight

     4: Combination of articles without flight

     5: Hotel

     6: Travel insurance

     7: Car rental
- Departure destination, optional, mandatory with article type 1-3; a..3
- Departure date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Arrival destination, optional, mandatory with article type 1-3; a..3
- Arrival date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Booking class, optional, mandatory with article type 1-3; a..2 (bc: Business class, fc: First class, co: Bus, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Round trip, ow: One-way, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Change of booking not possible, rf: Change of booking, chargeable, possible, fl: No change of booking fees, na: not available)

Note on the structure of the article list:

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

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

Warenkorb des Kunden mit folgenden Artikeldaten:

- Artikelnr., ans..20
- Anzahl, n..7
- Artikelname, ans..50
- Artikelbeschreibung, ans..50
- Artikelpreis netto in kleinster Währungseinheit, n..7
- Artikelpreis brutto in kleinster Währungseinheit, n..7
- Kategorie, ans..
- Subkategorie1, ans..
- Subkategorie2, ans..
- Artikeltyp, optional, Pflicht bei BillPayAction 7/8/9; n1:
•              0: Anderes (Defaultwert)

•              1: Flug

•              2: Gepäck mit Flug

•              3: Kombination aus Artikeln mit Flug

•              4: Kombination aus Artikeln ohne Flug

•              5: Hotel

•              6: Reiseversicherung

•              7: Autovermietung
- Abreiseort, optional, Pflicht bei Artikeltyp 1-3; a..3
- Abreisedatum, optional, Pflicht bei Artikeltyp 1-3; n8 im Format YYYYMMDD
- Ankunftsort, optional, Pflicht bei Artikeltyp 1-3; a..3
- Ankunftsdatum, optional, Pflicht bei Artikeltyp 1-3; n8 im Format YYYYMMDD
- Buchungsklasse, optional, Pflicht bei Artikeltyp 1-3; a..2 (bc: Business-Klasse, fc: Erste Klasse, co: Bus, na: nicht verfügbar)
- Routentyp, optional, Pflicht bei Artikeltyp 1-3; a..2 (rt: Rundreise, ow: Einweg, na: nicht verfügbar)
- Tickettyp, optional, Pflicht bei Artikeltyp 1-3; a..2 (nr: Umbuchung nicht möglich, rf: Umbuchung gegen Gebühr möglich, fl: keine Umbuchungsgebühren, na: nicht verfügbar)

Hinweis zum Aufbau der Artikelliste:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

Jeder Artikel wird als kompletter Artikeldatensatz übergeben:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

OrderDescans..768M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

Gesamter Warenkorb des Kunden einschließlich Bestellung, Gebühren und Rabatten mit folgenden Daten:

- Versandname (Name der Versandmethode), ans..50
- Versandkosten netto in kleinster Währungseinheit, n..7
- Versandkosten brutto in kleinster Währungseinheit, n..7
- Rabatt netto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Rabatt brutto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Gesamtpreis netto in kleinster Währungseinheit, n..7
- Gesamtpreis brutto in kleinster Währungseinheit, n..7

Hinweis zum Aufbau der Bestellinformation:

<;> trennt die Felder der Bestellinformation

Jede Bestellung wird als kompletter Datensatz übergeben.

Alle übergebenen Daten werden validiert, wobei die Summe der Einzelpositionen den Gesamtpreis ergeben muss. Dabei muss gelten:

Gesamtpreis brutto=Summe(Artikelanzahl x Artikelbruttopreis) + Versandkosten brutto – Rabatt brutto

Gesamtpreis=Summe(Artikelanzahl x Artikelnettopreis) + Versandkosten – Rabatt

Beispiel:

Versandname;Versandkosten;Versandkosten brutto;Rabatt;Rabatt brutto;Gesamtpreis;Gesamtpreis brutto

DHL Standard;336;400;1390;1654;22307;26546

OrderHistoryans..768O

Customer’s order history/order information from the last 20 orders with the following information:

- Historical order number., ans..20
- Date of order, format YYYYMMDD hh:mm:ss
- Total price in the smallest currency unit, n..7
- Currency according to ISO 4217
- Payment method of the order with the following values:

<0> Direct Debit, <1> Credit Card, <2> Advance Payment, <3> Cash on Delivery, <4> Paypal, <5> Online Transfer, <6> Invoice, <7> BillPay invoice, <100> Other.

- Status of the order with the following values:
<0> paid, <1> open, <2> reminder, <3> debt collection, <4> overpaid, <5> underpaid, <6> cancelled.

Note on the structure of the OrderHistory:

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

A max. of 20 data records may be transferred

Example: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

Bestellhistorie/Bestellinformation des Kunden der letzten 20 Bestellungen mit folgenden Informationen:

- Historische Bestellnr., ans..20
- Bestelldatum, Format YYYYMMDD hh:mm:ss
- Gesamtpreis in kleinster Währungseinheit, n..7
- Währung nach ISO 4217
- Zahlungsart der Bestellung mit folgenden Werten:

<0> Lastschrift, <1> Kreditkarte, <2> Vorkasse, <3> Nachnahme, <4> PayPal, <5> Sofort/giropay, <6> Rechnung, <7> BillPay-Rechnung, <100> Sonstige.

- Status der Bestellung mit folgenden Werten:
<0> bezahlt, <1> offen, <2> Mahnwesen, <3> Inkasso, <4> überbezahlt, <5> unterbezahlt, <6> geplatzt.

Hinweis zum Aufbau der OrderHistory:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

max. 20 Datensätze dürfen übergeben werden

Beispiel: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

CustomerClassificationn1O

Customer specification

0 – Customer has not yet ordered or has successfully completed payment for fewer than 2 orders

1 – Customer has already made successful payment for 2 or more orders

Kundenspezifikation

0 – Kunde hat noch nie bestellt oder weniger als 2 Bestellungen erfolgreich bezahlt

1 – Kunde hat bereits 2 oder mehr Bestellungen erfolgreich bezahlt

Limitn..12OC

Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro.

If CustomerClassification=0
- and no successful payment: Limit=0
- and one successful payment: Limit=2500


If CustomerClassification=1

Rule               Limit
1 € < x < 40 €         8000
40 € =< x < 75 €  15000
75 € =< x < 300 € x * 200
300 € =< x < 2000 €      (600 + (x-300) / 2) * 100
2000 € =< x           250000

Example: Payment history EUR 180 over 2 purchases:

Limit = 180*200 = 36000

Pflicht, wenn CustomerClassification übermittelt wird: Numerischer Wert Limit, basierend auf der positiven Bezahlerfahrung x in Euro.

Wenn CustomerClassification=0
- und keine erfolgreiche Zahlung: Limit=0
- und eine erfolgreiche Zahlung: Limit=2500


Wenn CustomerClassification=1

Regel                                     Limit
1 € < x < 40 €                         8000
40 € =< x < 75 €     15000
75 € =< x < 300 €   x * 200
300 € =< x < 2000 €               (600 + (x-300) / 2) * 100
2000 € =< x                            250000

Beispiel: Zahlungserfahrung 180 Euro in 2 Käufen:

Limit = 180*200 = 36000




Bank dataBankdaten
AccOwnerans..50M

First name and surname of the account holder (purchaser)

Notice: Obligatory parameters if BillPayAction=2 (electronic direct debit) or 3 (instalment payment)

Vor- und Zuname des Kontoinhabers (Käufers)

Hinweis: Pflichtparameter, wenn BillPayAction=2 (ELV) oder 3 (Ratenzahlung)

IBANans..34M

Customer's IBAN

Notice: Obligatory parameters if BillPayAction=2 (electronic direct debit) or 3 (instalment payment)

IBAN des Kunden

Hinweis: Pflichtparameter, wenn BillPayAction=2 (ELV) oder 3 (Ratenzahlung)

BICan..11OC

Customer’s BIC

Notice: Obligatory parameters if BillPayAction=2 (electronic direct debit) or 3 (instalment payment)

BIC des Kunden

Hinweis: Pflichtparameter, wenn BillPayAction=2 (ELV) oder 3 (Ratenzahlung)




in case of BillPay hire purchasebei Billpay-Ratenkauf
BpBaseAmountn..7C

Obligatory in case of hire purchase (BillPayAction=3): gross amount to be financed excluding fees.

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

Pflicht bei Ratenkauf (BillPayAction=3): zu finanzierender Bruttobetrag ohne Gebühren.

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

BpRateCountn..2C

Obligatory in case of hire purchase (BillPayAction=3): Number of monthly instalments selected by purchaser, e.g. 6/9/12/18/24

Notice: BpRateCount is to be used together with PayID and BillPayAction for a subsequent call

Pflicht bei Ratenkauf (BillPayAction=3): Anzahl der vom Käufer gewählten Monatsraten, z.B. 6/9/12/18/24

Hinweis: BpRateCount ist zusammen mit PayID und BillPayAction für einen Folgeaufruf zu verwenden




Travel dataReisedaten
TripDataans..768OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten:

- Anzahl bereits gebuchter Reisen, n..3
- Gesamtbetrag bereits gebuchter Reisen in kleinster Währungseinheit, n..7
- Währung bereits gebuchter Reisen, a3

Hinweise zum Aufbau des Parameters TripData:
<;> trennt die Felder eines Datensatzes

Beispiel:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerListans..768OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten:

- Anrede, a..
- Vorname, ans..40
- Nachname, ans..40
- Geburtstag im Format YYYYMMDD, a8
- Mitgliedschaft, n1
•              0: nicht verfügbar (Standardwert)

•              1: Mitglied in einem Vielfliegerprogramm

•              2: Kein Mitglied in einem Vielfliegerprogramm

- MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0)

Hinweise zum Aufbau des Parameters TravelerList:
<;> trennt die Felder eines Datensatzes

Pro Reisendem muss ein kompletter Datensatz übergeben werden.

Beispiel:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for BillPay payments



Key

Format

CND

Description

Beschreibung

BpTransactionIDans..50C

BillPay transaction number

Notice: BpTransactionID is returned only if BpStatus=APPROVED

BillPay-Transaktionsnummer

Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED

BpStatusa..8MStatus of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurredStatus der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS>



Corrected address dataKorrigierte Adressdaten
Streetans..50Ocorrected street of customerkorrigierte Straße des Kunden
StreetNrans..5Ocorrected street number of customerkorrigierte Hausnummer des Kunden
Zipans..5Ocorrected postcode of customerkorrigierte PLZ des Kunden
Cityans..50Ocorrected town/city of customerkorrigierter Wohnort des Kunden
Countrya3OCustomer’s corrected country code according to ISO3166 alpha-3korrigierter Ländercode des Kunden nach ISO3166 alpha-3



virtual BillPay bank detailsvirtuelle BillPay-Bankverbindung
BpAccOwnerans..255C

Account holder for the receivables (usually “BillPay GmbH”)

Notice: is returned only if BpStatus=APPROVED

Kontoinhaber für die Forderung (i.d.R. „BillPay GmbH“)

Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED

IBANans..34C

BillPay-IBAN for the receivables

Notice: is returned only if BpStatus=APPROVED

BillPay-IBAN für die Forderung

Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED

BICan..11C

BillPay-BIC for the receivables

Notice: is returned only if BpStatus=APPROVED

BillPay-BIC für die Forderung

Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED

BpBankans..255C

Name of the bank for the receivables

Notice: is returned only if BpStatus=APPROVED

Name der Bank für die Forderung

Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED

BpInvoiceRefans..255C

Purpose (contains RefNr)

Notice: is returned only if BpStatus=APPROVED

Verwendungszweck (enthält RefNr)

Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED




Response in case of hire purchaseRückgabe bei Ratenkauf
BpConditionsListans..768M

BillPay conditions for instalment payment

- Number of monthly instalments “term”, n..7
- Value of shopping cart, “base” n..7
- Gross order value “cart”, n..7
- Financing interest charge “surcharge”, n..7
- Gross total value “total”, n..7
- Monthly charge % “interest”, n..2
- eff. annual interest rate % “annual”, n..4
- BillPay fee “fee”, n..7

All amounts in the smallest currency unit (e.g. EUR Cent)

<;> separates fields of a hire purchase data record  
<+> separates different hire purchase conditions

Example: „term“;„base“;„cart“;„surcharge“;„total“; „interest“;„anual“;„fee“+…

BillPay-Konditionen für Ratenzahlung

- Anzahl Monatsraten „term“, n..7
- Wert des Warenkorbs „base“, n..7
- Bruttobestellwert „cart“, n..7
- Finanzierungszinsaufschlag „surcharge“, n..7
- Bruttogesamtwert „total“, n..7
- Monatsaufschlag % „interest“, n..2
- eff. Jahreszins % „annual“, n..4
- BillPay-Gebühr „fee“, n..7

Alle Beträge in kleinster Währungseinheit, z.B. EUR Cent.

<;> trennt Felder eines Finanzierungsdatensatzes
<+> trennt verschiedene Finanzierungskonditionen

Beispiel: „term“;„base“;„cart“;„surcharge“;„total“; „inte-rest“;„anual“;„fee“+…

BpPaymentPlanans..768M

BillPay instalment plans with the following data:

- Number of monthly instalments “term”, n..2
- Gross value of first instalment, “due1”, n..7
- Gross value of 2nd to nth instalment, “due2” to “due-n”, n..7

<;> separates fields of a data record in the instalment plan   
<+> separates different instalment plans

Example: „term“;„due1“;„due2“;„due_n“+ „term“;„due1“;„due2“;„due_n“+

BillPay-Ratenpläne mit folgenden Daten:

- Anzahl Monatsraten „term“, n..2
- Bruttowert erste Rate „due1“, n..7
- Bruttowert 2. bis n-te Rate „due2“ bis „due-n“, n..7

<;> trennt Felder eines Datensatzes im Ratenplan
<+> trennt verschiedene Ratenpläne

Beispiel: „term“;„due1“;„due2“;„due_n“+ „term“;„due1“;„due2“;„due_n“+

BpLink1ans..768MLink to BillPay terms and condition for hire purchase which is to be displayedzu zeigender Link zu BillPay-AGBs für Ratenkauf
BpLink2ans..768MLink to BillPay data protection regulations which is to be displayedzu zeigender Link zu Datenschutzbestimmungen von BillPay
BpLink3ans..768MLink to BillPay terms of payment which is to be displayedzu zeigender Link zu BillPay-Zahlungsbedingungen
BpInfo1ans..MC

Base64 encrypted data string for the generation of a PDF document which contains a summary of all relevant data for the BillPay purchase by instalment order. This document must be forwarded to the purchaser!

Notice: This parameter is returned only with purchase by instalment with the subsequent request to finalise the payment.

Base64-codierter Datenstring zur Erzeugung eines PDF-Dokuments, welches eine Zusammenfassung aller für die Bestellung mit dem BillPay-Ratenkauf relevanten Daten enthält. Dieses Dokument muss an den Käufer weitergeleitet werden!

Hinweis: Dieser Parameter wird nur beim Ratenkauf beim abschließenden Request zur Finalisierung der Zahlung zurückgegeben.

BpInfo2ans..MC

Base64-encrypted data string for the generation of a PDF document which contains standard information about the conclusion of credit contracts and which must be sent to the credit recipient.

Notice: This parameter is returned only with purchase by instalment with the subsequent request to finalise the payment.

Base64-codierter Datenstring zur Erzeugung eines PDF-Dokuments, welches Standardinformationen zum Abschluss von Kreditverträgen enthält und an den Kreditnehmer versendet werden muss!

Hinweis: Dieser Parameter wird nur beim Ratenkauf beim abschließenden Request zur Finalisierung der Zahlung zurückgegeben.




Response in case of errorRückgabe im Fehlerfall
ErrorText1ans..255O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText1 enthält die detaillierte Fehlernachricht von BillPay für den Händler.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText2ans..255O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText2 enthält die detaillierte Fehlernachricht von BillPay für den Käufer.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText3n..6O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText3 enthält den detaillierten BillPay-Fehlercode.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ValidationErrorsans..1024O

in case of one or more validation errors with following data:

- error field
- error code > 1
- Customer error notification
- Merchant error notification

<;> separates fields within a validation error
<+> separates different validation errors

Example: <error field>; <error code>; <error message customer>; <error message merchant>+etc.

bei einem oder mehreren Validierungsfehlern mit folgenden Daten:

- Fehlerfeld
- Fehlercode > 1
- Fehlernachricht für den Kunden
- Fehlernachricht für den Händler

<;> trennt Felder in einem Validierungsfehler
<+> trennt verschiedene Validierungsfehler

Beispiel: <Fehlerfeld>;<Fehlercode>;<Fehlernachricht Kunde>;<Fehlernachricht Händler>+ …

Result parameters for BillPay payments


Subsequent change of shopping cart

The contents of a shopping cart can be changed later, in the case of goods returned or additional articles. In this case the old shopping cart is completely replaced, but address, reference numbers, currency, method of payment and number of instalments are retained. If the order value is same or less this change is always accepted. In the case of an increase in the order value a new authorisation is attempted. The new shopping cart is valid only in the case of success otherwise the previous cart is retained. If an order is already activated, BillPay will notify the customer about the changed amount.

Please use the following URL to change the shopping cart associated with a payment previously initialised with BillPay:

Billpay.aspx


The following table describes the transfer parameters to be encrypted:

Key

Format

CND

Description

Beschreibung




Article and order dataArtikel- und Bestelldaten
ArticleListans..768M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..

Note on the structure of the article list:

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

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+…

Warenkorb des Kunden mit folgenden Artikeldaten:

- Artikelnr., ans..20
- Anzahl, n..7
- Artikelname, ans..50
- Artikelbeschreibung, ans..50
- Artikelpreis netto in kleinster Währungseinheit, n..7
- Artikelpreis brutto in kleinster Währungseinheit, n..7
- Kategorie, ans..
- Subkategorie1, ans..
- Subkategorie2, ans..

Hinweis zum Aufbau der Artikelliste:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

Jeder Artikel wird als kompletter Datensatz übergeben:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+…

OrderDescans..768M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

Gesamter Warenkorb des Kunden einschließlich Bestellung, Gebühren und Rabatten mit folgenden Daten:

- Versandname (Name der Versandmethode), ans..50
- Versandkosten netto in kleinster Währungseinheit, n..7
- Versandkosten brutto in kleinster Währungseinheit, n..7
- Rabatt netto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Rabatt brutto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Gesamtpreis netto in kleinster Währungseinheit, n..7
- Gesamtpreis brutto in kleinster Währungseinheit, n..7

Hinweis zum Aufbau der Bestellinformation:

<;> trennt die Felder der Bestellinformation

Jede Bestellung wird als kompletter Datensatz übergeben.

Alle übergebenen Daten werden validiert, wobei die Summe der Einzelpositionen den Gesamtpreis ergeben muss. Dabei muss gelten:

Gesamtpreis brutto=Summe(Artikelanzahl x Artikelbruttopreis) + Versandkosten brutto – Rabatt brutto

Gesamtpreis=Summe(Artikelanzahl x Artikelnettopreis) + Versandkosten – Rabatt

Beispiel:

Versandname;Versandkosten;Versandkosten brutto;Rabatt;Rabatt brutto;Gesamtpreis;Gesamtpreis brutto

DHL Standard;336;400;1390;1654;22307;26546

EventTokena2MAbbreviation of the action to be done: Presently only CO (Change order) possibleAbkürzung der auszuführenden Aktion: Derzeit nur CO (Change order) möglich

Parameters for subsequent change of shopping cart with BillPay payments



Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number for accounting. Returned only if a RefNr has already been assigned.

Eindeutige Referenznummer für die Buchhaltung. Wird nur zurückgegeben, wenn bereits eine RefNr zugeordnet war.

BpTransactionIDans..50C

BillPay transaction number

BillPay-Transaktionsnummer

BpStatusa..8MStatus of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurredStatus der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS>



Response in case of hire purchaseRückgabe bei Ratenkauf
BpConditionsListans..768M

BillPay conditions for instalment payment

- term: Number of monthly instalments, n..7
- base: Value of shopping cart, n..7
- cart: Gross value including fees and rebates, n..7
- surcharge: Interest increase of financing, n..7
- total: Gross total value, n..7
- interest: monthly %-surcharge, n..2
- anual: eff. Interest per annum in %, n..4
- fee: BillPay handling fee, n..7

Notice: In this case the new conditions for the already selected number of monthly instalments are given.

<;>separates fields within a data record

Example: <term>;<base>;<cart>;<surcharge>;<total>;<interest>;<anual>;<fee>

BillPay-Konditionen für die Ratenzahlung:

- term: Anzahl Monatsraten, n..7
- base: Wert des Warenkorbs, n..7
- cart: Bruttowert inklusive Gebühren und Rabatten, n..7
- surcharge: Zinsaufschlag der Finanzierung, n..7
- total: Bruttogesamtwert, n..7
- interest: monatlicher %-Aufschlag, n..2
- anual: eff. Jahreszins in %, n..4
- fee: BillPay-Bearbeitungsgebühr, n..7

Hinweis: Hier werden die neuen Konditionen für die bereits gewählte Anzahl an Monatsraten ausgegeben.

<;> trennt Felder innerhalb eines Datensatzes

Beispiel: <term>;<base>;<cart>;<surcharge>;<total>;<interest>;<anual>;<fee>

BpPaymentPlanans..768M

Instalment plan selected by the buyer:

- RateNr: number of the instalment
- RateAmount: instalment amount
- DueDate: due date of the instalment

Notice: In this case the instalment plan for the already selected number of monthly instalments are given.

<;>separates fields within a data record
<+> separates different data records

Example: <Rate1>;<RateAmount>;<DueDate>+ <Rate_n>;<RateAmount_n>;<DueDate_n>+ etc.

Notice: DueDate is empty if the order has not been activated.

Vom Käufer gewählter Ratenplan:

- RateNr: Nummer der Rate
- RateAmount: Betrag der Rate
- DueDate: Fälligkeitsdatum der Rate

Hinweis: Hier wird der Ratenplan für die bereits gewählte Anzahl an Monatsraten ausgegeben.

<;> trennt Felder innerhalb eines Datensatzes
<+> trennt unterschiedliche Datensätze

Beispiel: <Rate1>;<RateAmount>;<DueDate> + <Rate_n>;<RateAmount_n>;<DueDate_n> +…

Hinweis: Falls die Bestellung nicht aktiviert wurde, ist DueDate leer.




Response in case of errorRückgabe im Fehlerfall
ErrorText1ans..255O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText1 enthält die detaillierte Fehlernachricht von BillPay für den Händler.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText2ans..255O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText2 enthält die detaillierte Fehlernachricht von BillPay für den Käufer.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText3n..6O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText3 enthält den detaillierten BillPay-Fehlercode.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

Result parameters for BillPay payments



BillPay with payment method control (PreScore)

BillPay‘s payment method control lets online merchants preselect BillPay payment methods in their online shop to be displayed to a specific customer. Customers only see the payment methods which apply to them, which leads to an increase in sales. For payment method control, the end customer identity and creditworthiness checks must take place before the payment method selection. The BillPay payment method control is thus an alternative to checking the end customer request after selecting a payment method. A merchant portal in the case of BillPay can work either with or without payment method control but not both at the same time.

For use of the payment method control the merchant must have a corresponding contract with BillPay and be enabled. The BillPay process is divided for this process into the prior payment method control (PreScore) and the subsequent creation of the BillPay payment which now requires fewer call-up parameters. The response to the reservation corresponds again to the declared normal proceedings declared above.

In order to execute the BillPay payment method control via server-to-server communication, please use the following URL:

billpay.aspx


Key

Format

CND

Description

Beschreibung

EventTokena2MToken for the call of the request: <PS> for PreScoreToken für den Aufruf des Requests: <PS> für PreScore

Language

a2

M

Language code according to ISO 639-1 (e.g. de for German)

Sprachkennzeichen nach ISO 639-1 (z.B. de für Deutsch)

NewCustomerans..5MDefines whether or not the purchaser is a new customer. Values: <YES>, <NO>, <GUEST>Definiert, ob der Käufer ein Neukunde ist. Werte: <YES>, <NO>, <GUEST>
DateOfBirthan10MCBirth date of the customer in the format YYYY-MM-DD (may not be transmitted in the case of BillPay B2B)Geburtsdatum des Kunden im Format JJJJ-MM-TT (darf bei BillPay B2B nicht übergeben werden)
IpAddrans15MCustomer´s IP address in IPv4 or IPv6 formatIP-Adresse des Kunden im Format IPv4 oder IPv6
CompanyOrPersona1OCDistinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2BUnterscheidung des Käufers nach Privatperson oder Firma. Werte: <F> für Firmen, <P> für Personen, Standardwert <P>. Pflicht bei BillPay B2B
BrowserSessionIDans..100OSessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)SessionID zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget)



Invoice dataRechnungsdaten
bdSalutationa..15M

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Anrede des Kunden auf der Rechnung. Zulässige Werte:

Männlich: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Weiblich: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

bdTitleans..20OTitle of the customer or contact person within the company on the invoice, e.g. Dr. or Prof.Titel des Kunden oder der Kontaktperson in der Firma auf der Rechnung, z.B. Dr. oder Prof.
bdFirstNameans..50MFirst name of customer or contact person in companyVorname des Kunden oder der Kontaktperson in der Firma
bdLastNameans..50MLast name of customer or contact person in companyNachname des Kunden oder der Kontaktperson in der Firma
bdStreeta..50MStreet name in the invoicing addressStraßenname der Rechnungsadresse
bdStreetNrans..5MStreet number of the invoicing addressHausnummer der Rechnungsadresse
bdStreet2a..50OAddress addition in the billing addressAdresszusatz der Rechnungsadresse
bdZipn5MPostcode in the invoicing addressPostleitzahl der Rechnungsadresse
bdCityans..50MTown/city of the invoicing addressOrt der Rechnungsadresse
bdCountryCodea3MCountry code in the billing address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.Ländercode der Rechnungsadresse dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT).
EMailans..50ME-mail address of the customer or contact person on the invoicing addressE-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift
Phoneans..15OC

Telephone number of the customer or contact person on the invoicing address

Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift

MobileNoans..50OMobile telephone number of the customer on the invoicing addressHandy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift



Delivery dataLieferdaten
UseBillingDataa3MIs the invoicing address to be used as the delivery address? Permissible: <Yes> or <No>. If <No>, parameters for the delivery address become obligatory. If <Yes>, no parameters are transferred for the delivery address.Soll die Rechnungsadresse als Lieferadresse genutzt werden? Zulässig: <Yes> oder <No>. Bei <No> werden Parameter zur Lieferadresse Pflicht. Bei <Yes> werden keine Parameter zur Lieferadresse übergeben.
sdSalutationa..15C

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Obligatory, if UseBillingData=No

Anrede des Kunden auf der Rechnung. Zulässige Werte:

Männlich: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Weiblich: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Pflicht, wenn UseBillingData=No

sdTitleans..20OTitle of the customer on the invoice, e.g. Dr. or Prof.Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof.
sdFirstNameans..50CObligatory, if UseBillingData=No: First name of customer or contact person in companyPflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma
sdLastNameans..50CObligatory, if UseBillingData=No: Last name of customer or contact person in companyPflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma
sdStreeta..50CObligatory, if UseBillingData=No: Street in the delivery addressPflicht, wenn UseBillingData=No: Straßenname der Lieferadresse
sdStreetNrans..5CObligatory, if UseBillingData=No: Street number of the delivery addressPflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse
sdStreet2a..50OAddress addition in the delivery addressAdresszusatz der Lieferadresse
sdZipn5CObligatory, if UseBillingData=No: Postcode in the delivery addressPflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse
sdCityans..50CObligatory, if UseBillingData=No: Town/city of the delivery addressPflicht, wenn UseBillingData=No: Ort der Lieferadresse
sdCountryCodea3CObligatory, if UseBillingData=No: Country code in the delivery address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.Pflicht, wenn UseBillingData=No: Ländercode der Lieferanschrift dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT).
sdPhoneans..15OTelephone number of the customer in the delivery addressTelefonnummer des Kunden in der Lieferanschrift
sdMobileNoans..50OMobile telephone number of the customer in the delivery addressHandy-Nummer des Kunden in der Lieferanschrift



Company dataFirmendaten
CompanyNameans..200CCompany name. Obligatory if CompanyOrPerson=FFirmenname. Pflicht, falls CompanyOrPerson=F
LegalForma..12C

Legal form of the company. Obligatory, if CompanyOrPerson=F

Values: <ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

Rechtsform des Unternehmens. Pflicht, wenn CompanyOrPerson=F

Werte:<ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

RegisterNumberans..20C

Register of Companies number/commercial register

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

Handelsregisternummer/Firmenbuch

Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft

HolderNameans..100C

Optional: Name of the firm owner

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

Optional: Name des Firmeninhabers

Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft

TaxNumberans..20C

VAT Reg. No.

Notice: The specification of the VAT Reg. No. increases the probability of a hit

Umsatzsteueridentifikationsnummer

Hinweis: Die Angabe der USt-ID erhöht die Trefferwahrscheinlichkeit




Article and order dataArtikel- und Bestelldaten
ArticleListans..768M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..
- Artikcle type, optional, Obligatory for BillPayAction 7/8/9; n1:
     0: Other (default value)

     1: Flight

     2: Luggage with flight

     3: Combination of articles with flight

     4: Combination of articles without flight

     5: Hotel

     6: Travel insurance

     7: Car rental
- Departure destination, optional, mandatory with article type 1-3; a..3
- Departure date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Arrival destination, optional, mandatory with article type 1-3; a..3
- Arrival date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Booking class, optional, mandatory with article type 1-3; a..2 (bc: Business class, fc: First class, co: Bus, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Round trip, ow: One-way, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Change of booking not possible, rf: Change of booking, chargeable, possible, fl: No change of booking fees, na: not available)

Note on the structure of the article list:

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

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

Warenkorb des Kunden mit folgenden Artikeldaten:

- Artikelnr., ans..20
- Anzahl, n..7
- Artikelname, ans..50
- Artikelbeschreibung, ans..50
- Artikelpreis netto in kleinster Währungseinheit, n..7
- Artikelpreis brutto in kleinster Währungseinheit, n..7
- Kategorie, ans..
- Subkategorie1, ans..
- Subkategorie2, ans..
- Artikeltyp, optional, Pflicht bei BillPayAction 7/8/9; n1:
•              0: Anderes (Defaultwert)

•              1: Flug

•              2: Gepäck mit Flug

•              3: Kombination aus Artikeln mit Flug

•              4: Kombination aus Artikeln ohne Flug

•              5: Hotel

•              6: Reiseversicherung

•              7: Autovermietung
- Abreiseort, optional, Pflicht bei Artikeltyp 1-3; a..3
- Abreisedatum, optional, Pflicht bei Artikeltyp 1-3; n8 im Format YYYYMMDD
- Ankunftsort, optional, Pflicht bei Artikeltyp 1-3; a..3
- Ankunftsdatum, optional, Pflicht bei Artikeltyp 1-3; n8 im Format YYYYMMDD
- Buchungsklasse, optional, Pflicht bei Artikeltyp 1-3; a..2 (bc: Business-Klasse, fc: Erste Klasse, co: Bus, na: nicht verfügbar)
- Routentyp, optional, Pflicht bei Artikeltyp 1-3; a..2 (rt: Rundreise, ow: Einweg, na: nicht verfügbar)
- Tickettyp, optional, Pflicht bei Artikeltyp 1-3; a..2 (nr: Umbuchung nicht möglich, rf: Umbuchung gegen Gebühr möglich, fl: keine Umbuchungsgebühren, na: nicht verfügbar)

Hinweis zum Aufbau der Artikelliste:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

Jeder Artikel wird als kompletter Artikeldatensatz übergeben:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

OrderDescans..768M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

Gesamter Warenkorb des Kunden einschließlich Bestellung, Gebühren und Rabatten mit folgenden Daten:

- Versandname (Name der Versandmethode), ans..50
- Versandkosten netto in kleinster Währungseinheit, n..7
- Versandkosten brutto in kleinster Währungseinheit, n..7
- Rabatt netto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Rabatt brutto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Gesamtpreis netto in kleinster Währungseinheit, n..7
- Gesamtpreis brutto in kleinster Währungseinheit, n..7

Hinweis zum Aufbau der Bestellinformation:

<;> trennt die Felder der Bestellinformation

Jede Bestellung wird als kompletter Datensatz übergeben.

Alle übergebenen Daten werden validiert, wobei die Summe der Einzelpositionen den Gesamtpreis ergeben muss. Dabei muss gelten:

Gesamtpreis brutto=Summe(Artikelanzahl x Artikelbruttopreis) + Versandkosten brutto – Rabatt brutto

Gesamtpreis=Summe(Artikelanzahl x Artikelnettopreis) + Versandkosten – Rabatt

Beispiel:

Versandname;Versandkosten;Versandkosten brutto;Rabatt;Rabatt brutto;Gesamtpreis;Gesamtpreis brutto

DHL Standard;336;400;1390;1654;22307;26546

OrderHistoryans..768O

Customer’s order history/order information from the last 20 orders with the following information:

- Historical order number., ans..20
- Date of order, format YYYYMMDD hh:mm:ss
- Total price in the smallest currency unit, n..7
- Currency according to ISO 4217
- Payment method of the order with the following values:

<0> Direct Debit, <1> Credit Card, <2> Advance Payment, <3> Cash on Delivery, <4> Paypal, <5> Online Transfer, <6> Invoice, <7> BillPay invoice, <100> Other.

- Status of the order with the following values:
<0> paid, <1> open, <2> reminder, <3> debt collection, <4> overpaid, <5> underpaid, <6> cancelled.

Note on the structure of the OrderHistory:

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

A max. of 20 data records may be transferred

Example: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

Bestellhistorie/Bestellinformation des Kunden der letzten 20 Bestellungen mit folgenden Informationen:

- Historische Bestellnr., ans..20
- Bestelldatum, Format YYYYMMDD hh:mm:ss
- Gesamtpreis in kleinster Währungseinheit, n..7
- Währung nach ISO 4217
- Zahlungsart der Bestellung mit folgenden Werten:

<0> Lastschrift, <1> Kreditkarte, <2> Vorkasse, <3> Nachnahme, <4> PayPal, <5> Sofort/giropay, <6> Rechnung, <7> BillPay-Rechnung, <100> Sonstige.

- Status der Bestellung mit folgenden Werten:
<0> bezahlt, <1> offen, <2> Mahnwesen, <3> Inkasso, <4> überbezahlt, <5> unterbezahlt, <6> geplatzt.

Hinweis zum Aufbau der OrderHistory:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

max. 20 Datensätze dürfen übergeben werden

Beispiel: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

CustomerClassificationn1O

Customer specification

0 – Customer has not yet ordered or has successfully completed payment for fewer than 2 orders

1 – Customer has already made successful payment for 2 or more orders

Kundenspezifikation

0 – Kunde hat noch nie bestellt oder weniger als 2 Bestellungen erfolgreich bezahlt

1 – Kunde hat bereits 2 oder mehr Bestellungen erfolgreich bezahlt

Limitn..12OC

Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro.

If CustomerClassification=0
- and no successful payment: Limit=0
- and one successful payment: Limit=2500


If CustomerClassification=1

Rule               Limit
1 € < x < 40 €         8000
40 € =< x < 75 €  15000
75 € =< x < 300 € x * 200
300 € =< x < 2000 €      (600 + (x-300) / 2) * 100
2000 € =< x           250000

Example: Payment history EUR 180 over 2 purchases:

Limit = 180*200 = 36000

Pflicht, wenn CustomerClassification übermittelt wird: Numerischer Wert Limit, basierend auf der positiven Bezahlerfahrung x in Euro.

Wenn CustomerClassification=0
- und keine erfolgreiche Zahlung: Limit=0
- und eine erfolgreiche Zahlung: Limit=2500


Wenn CustomerClassification=1

Regel                                     Limit
1 € < x < 40 €                         8000
40 € =< x < 75 €     15000
75 € =< x < 300 €   x * 200
300 € =< x < 2000 €               (600 + (x-300) / 2) * 100
2000 € =< x                            250000

Beispiel: Zahlungserfahrung 180 Euro in 2 Käufen:

Limit = 180*200 = 36000




Travel dataReisedaten
TripDataans..768OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten:

- Anzahl bereits gebuchter Reisen, n..3
- Gesamtbetrag bereits gebuchter Reisen in kleinster Währungseinheit, n..7
- Währung bereits gebuchter Reisen, a3

Hinweise zum Aufbau des Parameters TripData:
<;> trennt die Felder eines Datensatzes

Beispiel:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerListans..768OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten:

- Anrede, a..
- Vorname, ans..40
- Nachname, ans..40
- Geburtstag im Format YYYYMMDD, a8
- Mitgliedschaft, n1
•              0: nicht verfügbar (Standardwert)

•              1: Mitglied in einem Vielfliegerprogramm

•              2: Kein Mitglied in einem Vielfliegerprogramm

- MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0)

Hinweise zum Aufbau des Parameters TravelerList:
<;> trennt die Felder eines Datensatzes

Pro Reisendem muss ein kompletter Datensatz übergeben werden.

Beispiel:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for BillPay payment method control (PreScore)



Key

Format

CND

Description

Beschreibung

Status

a..50

M

AUTHORIZE_REQUEST or FAILED

AUTHORIZE_REQUEST oder FAILED

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant’s reference number. In case of updating the RefNr the new RefNr is returned to the merchant.

Referenznummer des Händlers. Im Falle einer Aktualisierung der RefNr bekommt Händler die neue RefNr zurück.




BillPay answer

BillPay-Antwort

BpStatusa..8MStatus of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurredStatus der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS>
BpTransactionIDans..50O

BillPay transaction number

Notice: BpTransactionID is returned only if BpStatus=APPROVED

BillPay-Transaktionsnummer

Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED

Streetans..50Ocorrected street of customerkorrigierte Straße des Kunden
StreetNrans..5Ocorrected street number of customerkorrigierte Hausnummer des Kunden
Zipans..5Ocorrected postcode of customerkorrigierte PLZ des Kunden
Cityans..50Ocorrected town/city of customerkorrigierter Wohnort des Kunden
Countrya3OCustomer’s corrected country code according to ISO3166 alpha-3korrigierter Ländercode des Kunden nach ISO3166 alpha-3
BrowserSessionIDans..100OSessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)SessionID zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget)
AllowedPayMethodsans..768OC

List of allowed payment methods (is returned only if BpStatus=APPROVED)

1 for INVOICE
2 for DIRECT_DEBIT
4 for PAYLATER (instalment payment)
8 for INVOICE_COLLATERAL_PROMISE
9 for DIRECT_DEBIT_COLLATERAL_PROMISE
7 for PAYLATER_COLLATERAL_PROMIS


Customer group: PRIVATE for B2C; BUSINESS for B2B Todo

<;>separates fields within a data record
<+> separates data records

Example: <ID>;< Name>,<Customer group>+<ID>;< Name>;<Customer group>+…

Liste erlaubter Zahlarten (wird nur zurückgegeben, wenn BpStatus=APPROVED)

1 für INVOICE (Rechnungskauf)
2 für DIRECT_DEBIT (Lastschrift)
4 für PAYLATER (Ratenkauf)
8 für INVOICE_COLLATERAL_PROMISE (Rechnungskauf mit Schuldbeitritt)
9 für DIRECT_DEBIT_COLLATERAL_PROMISE (Lastschrift mit Schuldbeitritt)
7 für PAYLATER_COLLATERAL_PROMIS (Ratenkauf mit Schuldbeitritt)


Kundengruppe: PRIVATE für B2C; BUSINESS für B2B Todo

<;> trennt die Werte eines Datensatzes
<+> trennt die Datensätze

Beispiel: <ID>;< Bezeichnung>,<Kundengruppe>+<ID>;< Bezeichnung>;<Kundengruppe>+…

ValidationErrorsans..1024O

Is returned in the case of one or more validation errors. Contains following data:

-     error field
-     error code. Value is always > 1
-     Customer error notification
-     Detailed merchant error notification
<;> separates the fields of a data set
<+> separates data records

Example: <error field>; <error code>; <error message customer>; <error message merchant>+etc.

Wird im Falle eines oder mehrerer Validierungsfehler zurückgeliefert. Enthält folgende Daten:

-              Fehlerfeld
-              Fehlercode. Wert ist immer > 1
-              Fehlernachricht für den Kunden
-              Detaillierte Fehlernachricht für den Händler
<;> trennt die Felder eines Datensatzes
<+> trennt die Datensätze

Beispiel: <Fehlerfeld>;<Fehlercode>;<Fehlernachricht Kunde>;<Fehlernachricht Händler>+ …




BillPay response in case of errorBillPay-Antwort bei Fehlern
ErrorText1ans..255O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText1 enthält die detaillierte Fehlernachricht von BillPay für den Händler.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText2ans..255O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText2 enthält die detaillierte Fehlernachricht von BillPay für den Käufer.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText3n..6O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText3 enthält den detaillierten BillPay-Fehlercode.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

Result parameters for BillPay payments methods control


To create and reserve the payment the second access requires just a few additional parameters depending on the payment method.

Notice: As soon as the customer changes its personal data or shopping basket, the payment method control must be resent. The previously implemented payment method control is no longer valid.


To generate a BillPay payment via a Server-to-Server connection, please use the following URL:

billpay.aspx


Key

Format

CND

Description

Beschreibung

BillPayActionn1M

Defines the method of payment used.

<1> for invoice purchase, <2> for direct debit, <4> for PayLater, <7> for PayLater with assumption of debt, <8> for invoice purchase with assumption of debt, <9> for direct debit with assumption of debt.

Notice: Only permitted payment methods may be used. See return parameter AllowedPayMethods in the response to the payment method control.

Definiert, welche Zahlungsart verwendet wird.

<1> für Rechnungskauf, <2> für Lastschrift, <4> für PayLater, <7> für PayLater mit Schuldbeitritt, <8> für Rechnungskauf mit Schuldbeitritt, <9> für Lastschrift mit Schuldbeitritt.

Hinweis: Es dürfen nur erlaubte Zahlungsarten verwendet werden. Siehe Rückgabeparameter AllowedPayMethods in der Response der Zahlartensteuerung.

ActivationDelayn..3OC

Mandatory for BillPayAction = 7, 8 or 9 (assumption of debt)

Number of days until fulfilment of service (e.g. start of journey)

Pflicht bei BillPayAction = 7, 8 oder 9 (Schuldbeitritt)

Anzahl der Tage bis zur Wahrnehmung der Dienstleistung (z.B. Reiseantritt)

GtcValuea..3MDefines whether or not the customer has confirmed BillPay’s terms and conditions. Values: <YES> or <NO>Definiert, ob der Kunde die AGB von BillPay bestätigt hat. Werte: <YES> oder <NO>
DateOfBirthan10MCBirth date of the customer in the format YYYY-MM-DD (may not be transmitted in the case of BillPay B2B)Geburtsdatum des Kunden im Format JJJJ-MM-TT (darf bei BillPay B2B nicht übergeben werden)
AccOwnerans..50OC

Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater)

First name and last name of the account holder (purchaser)

Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater):

Vor- und Zuname des Kontoinhabers (Käufer)

IBANans..34OC

Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater)

Customer's IBAN

Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater):

IBAN des Kunden

BICans..11OC

Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater)

Customer’s BIC

Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater):

BIC des Kunden

BpBaseAmountn..7OC

Obligatory if BillPayAction=4 (PayLater): gross amount to be financed (total price + interest charge + transaction charge)

The values come from the BillPay JavaScript-Snippet.

Pflicht, wenn BillPayAction=4 (PayLater): zu finanzierender Bruttobetrag (Gesamtpreis + Zinsaufschlag + Transaktionsgebühr)

Die Werte kommen aus dem BillPay JavaScript-Snippet.

BpRateCountn..2OC

Mandatory if BillPayAction=4 (PayLater): Number of monthly instalments selected by purchaser

The values come from the BillPay JavaScript-Snippet.

Pflicht, wenn BillPayAction=4 (PayLater): Anzahl der vom Käufer gewählten Monatsraten

Die Werte kommen aus dem BillPay JavaScript-Snippet.

URLBackans..256OC

Mandatory if BillPayAction=4 (PayLater): URL to which the customer is routed back after the down payment. Please use a reference within this URL in order to allocate the payment later.

The parameter "URLBack" can be sent

  • either as plain parameter (unencrypted) (compatibility mode)
  • or be part of encrypted payment request parameters (preferred mode)

Pflicht, wenn BillPayAction=4 (PayLater): URL, auf die der Kunde nach der Anzahlung zurückgeleitet wird. Verwenden Sie in der URL am besten eine Referenz, um die Zahlung entsprechend zuordnen zu können.

Der Parameter "URLBack" kann

  • sowohl unverschlüsselt übermittelt werden (Kompabilitätsmodus)
  • als auch in den verschlüsselten Übergabeparametern (bevorzugte Variante)
URLNotifyans..256OC

Mandatory if BillPayAction=4 (PayLater) and no URLNotify for PayLater ist stored at :

Complete URL, which calls up  in order to notify the shop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

This URL is callad only if the customer was forwarded to the gateway for down payment, because in this case the response from gateway is delayed.

Pflicht, wenn BillPayAction=4 (PayLater) und keine URLNotify für PayLater bei  hinterlegt ist:

URL, die das  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.

Die URL wird nur aufgerufen, wenn der Kunde zum Anzahlungsgateway weitergeleitet wurde, da in diesem Fall die Antwort vom Gateway zeitverzögert gesendet wird.




Travel dataReisedaten
TripDataans..768OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten:

- Anzahl bereits gebuchter Reisen, n..3
- Gesamtbetrag bereits gebuchter Reisen in kleinster Währungseinheit, n..7
- Währung bereits gebuchter Reisen, a3

Hinweise zum Aufbau des Parameters TripData:
<;> trennt die Felder eines Datensatzes

Beispiel:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerListans..768OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten:

- Anrede, a..
- Vorname, ans..40
- Nachname, ans..40
- Geburtstag im Format YYYYMMDD, a8
- Mitgliedschaft, n1
•              0: nicht verfügbar (Standardwert)

•              1: Mitglied in einem Vielfliegerprogramm

•              2: Kein Mitglied in einem Vielfliegerprogramm

- MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0)

Hinweise zum Aufbau des Parameters TravelerList:
<;> trennt die Felder eines Datensatzes

Pro Reisendem muss ein kompletter Datensatz übergeben werden.

Beispiel:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for BillPay payment after payment methods control


The response parameters correspond to the parameters of general process which are explained above.



PayLater via BillPay

This chapter describes how to process a PayLater payment via BillPay. PayLater is an extension of the Billpay-connection. Further functions and general parameters are described in the general documentation of Billpay.

To make a payment with PayLater via BillPay, please use the following URL:

billpay.aspx


Key

Format

CND

Description

Beschreibung

Language

a2

M

Language code according to ISO 639-1 (e.g. de for German)

Sprachkennzeichen nach ISO 639-1 (z.B. de für Deutsch)

NewCustomerans..5MDefines whether or not the purchaser is a new customer. Values: <YES>, <NO>, <GUEST>Definiert, ob der Käufer ein Neukunde ist. Werte: <YES>, <NO>, <GUEST>
BillPayActionn1M

Defines the method of payment used. Values:

<1> for invoice purchase
<2> for direct debit
<4> for PayLater
<7> for PayLater with assumption of debt
<8> for invoice purchase with assumption of debt
<9> for direct debit with assumption of debt

Definiert, welche Zahlungsart verwendet wird. Werte:

<1> für Rechnungskauf
<2> für Lastschrift
<4> für PayLater
<7> für PayLater mit Schuldbeitritt
<8> für Rechnung mit Schuldbeitritt
<9> für Lastschrift mit Schuldbeitritt

GtcValuea..3MDefines whether or not the customer has confirmed BillPay’s terms and conditions. Values: <YES> or <NO>Definiert, ob der Kunde die AGB von BillPay bestätigt hat. Werte: <YES> oder <NO>
DateOfBirthan10OCBirth date of the customer in the format YYYY-MM-DD (may not be transmitted in the case of BillPay B2B)Geburtsdatum des Kunden im Format JJJJ-MM-TT (darf bei BillPay B2B nicht übergeben werden)
IpAddrans15MCustomer´s IP address in IPv4 or IPv6 formatIP-Adresse des Kunden im Format IPv4 oder IPv6
ActivationDelayn..3OC

Mandatory for BillPayAction = 7, 8 or 9 (assumption of debt)

Number of days until fulfilment of service (e.g. start of journey)

Pflicht bei BillPayAction = 7, 8 oder 9 (Schuldbeitritt)

Anzahl der Tage bis zur Wahrnehmung der Dienstleistung (z.B. Reiseantritt)

CompanyOrPersona1OCDistinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2BUnterscheidung des Käufers nach Privatperson oder Firma. Werte: <F> für Firmen, <P> für Personen, Standardwert <P>. Pflicht bei BillPay B2B
BrowserSessionIDans..100OSessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)SessionID zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget)



Invoice dataRechnungsdaten
bdSalutationa..15OC

Obligatory if CompanyOrPerson=P: Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Pflicht, wenn CompanyOrPerson=P: Anrede des Kunden auf der Rechnung. Zulässige Werte:

Männlich: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Weiblich: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

bdTitleans..20OTitle of the customer or contact person within the company on the invoice, e.g. Dr. or Prof.Titel des Kunden oder der Kontaktperson in der Firma auf der Rechnung, z.B. Dr. oder Prof.
bdFirstNameans..50MFirst name of customer or contact person in companyVorname des Kunden oder der Kontaktperson in der Firma
bdLastNameans..50MLast name of customer or contact person in companyNachname des Kunden oder der Kontaktperson in der Firma
bdStreeta..50MStreet name in the invoicing addressStraßenname der Rechnungsadresse
bdStreetNrans..5MStreet number of the invoicing addressHausnummer der Rechnungsadresse
bdStreet2a..50OAddress addition in the billing addressAdresszusatz der Rechnungsadresse
bdZipn5MPostcode in the invoicing addressPostleitzahl der Rechnungsadresse
bdCityans..50MTown/city of the invoicing addressOrt der Rechnungsadresse
bdCountryCodea3MCountry code in the billing address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.Ländercode der Rechnungsadresse dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT).
EMailans..50ME-mail address of the customer or contact person on the invoicing addressE-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift
Phoneans..15M

Telephone number of the customer or contact person on the invoicing address

Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift

MobileNoans..50OMobile telephone number of the customer on the invoicing addressHandy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift



Delivery dataLieferdaten
UseBillingDataa3MIs the invoicing address to be used as the delivery address? Permissible: <Yes> or <No>. If <No>, parameters for the delivery address become obligatory. If <Yes>, no parameters are transferred for the delivery address.Soll die Rechnungsadresse als Lieferadresse genutzt werden? Zulässig: <Yes> oder <No>. Bei <No> werden Parameter zur Lieferadresse Pflicht. Bei <Yes> werden keine Parameter zur Lieferadresse übergeben.
sdSalutationa..15OC

Obligatory, if UseBillingData=No: Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Pflicht, wenn UseBillingData=No: Anrede des Kunden auf der Rechnung. Zulässige Werte:

Männlich: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Weiblich: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

sdTitleans..20OTitle of the customer on the invoice, e.g. Dr. or Prof.Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof.
sdFirstNameans..50CObligatory, if UseBillingData=No: First name of customer or contact person in companyPflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma
sdLastNameans..50CObligatory, if UseBillingData=No: Last name of customer or contact person in companyPflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma
sdStreeta..50CObligatory, if UseBillingData=No: Street in the delivery addressPflicht, wenn UseBillingData=No: Straßenname der Lieferadresse
sdStreetNrans..5CObligatory, if UseBillingData=No: Street number of the delivery addressPflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse
sdStreet2a..50OAddress addition in the delivery addressAdresszusatz der Lieferadresse
sdZipn5CObligatory, if UseBillingData=No: Postcode in the delivery addressPflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse
sdCityans..50CObligatory, if UseBillingData=No: Town/city of the delivery addressPflicht, wenn UseBillingData=No: Ort der Lieferadresse
sdCountryCodea3CObligatory, if UseBillingData=No: Country code in the delivery address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.Pflicht, wenn UseBillingData=No: Ländercode der Lieferanschrift dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT).
sdPhoneans..15OTelephone number of the customer in the delivery addressTelefonnummer des Kunden in der Lieferanschrift
sdMobileNoans..50OMobile telephone number of the customer in the delivery addressHandy-Nummer des Kunden in der Lieferanschrift



Company dataFirmendaten
CompanyNameans..200CCompany name. Obligatory if CompanyOrPerson=FFirmenname. Pflicht, falls CompanyOrPerson=F
LegalForma..12C

Legal form of the company. Obligatory, if CompanyOrPerson=F

Values: <ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

Rechtsform des Unternehmens. Pflicht, wenn CompanyOrPerson=F

Werte:<ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

RegisterNumberans..20C

Register of Companies number/commercial register

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

Handelsregisternummer/Firmenbuch

Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft

HolderNameans..100C

Optional: Name of the firm owner

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

Optional: Name des Firmeninhabers

Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft

TaxNumberans..20C

VAT Reg. No.

Notice: The specification of the VAT Reg. No. increases the probability of a hit

Umsatzsteueridentifikationsnummer

Hinweis: Die Angabe der USt-ID erhöht die Trefferwahrscheinlichkeit




Article and order dataArtikel- und Bestelldaten
ArticleListans..768M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..
- Artikcle type, optional, Obligatory for BillPayAction 7/8/9; n1:
     0: Other (default value)

     1: Flight

     2: Luggage with flight

     3: Combination of articles with flight

     4: Combination of articles without flight

     5: Hotel

     6: Travel insurance

     7: Car rental
- Departure destination, optional, mandatory with article type 1-3; a..3
- Departure date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Arrival destination, optional, mandatory with article type 1-3; a..3
- Arrival date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Booking class, optional, mandatory with article type 1-3; a..2 (bc: Business class, fc: First class, co: Bus, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Round trip, ow: One-way, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Change of booking not possible, rf: Change of booking, chargeable, possible, fl: No change of booking fees, na: not available)

Note on the structure of the article list:

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

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

Warenkorb des Kunden mit folgenden Artikeldaten:

- Artikelnr., ans..20
- Anzahl, n..7
- Artikelname, ans..50
- Artikelbeschreibung, ans..50
- Artikelpreis netto in kleinster Währungseinheit, n..7
- Artikelpreis brutto in kleinster Währungseinheit, n..7
- Kategorie, ans..
- Subkategorie1, ans..
- Subkategorie2, ans..
- Artikeltyp, optional, Pflicht bei BillPayAction 7/8/9; n1:
•              0: Anderes (Defaultwert)

•              1: Flug

•              2: Gepäck mit Flug

•              3: Kombination aus Artikeln mit Flug

•              4: Kombination aus Artikeln ohne Flug

•              5: Hotel

•              6: Reiseversicherung

•              7: Autovermietung
- Abreiseort, optional, Pflicht bei Artikeltyp 1-3; a..3
- Abreisedatum, optional, Pflicht bei Artikeltyp 1-3; n8 im Format YYYYMMDD
- Ankunftsort, optional, Pflicht bei Artikeltyp 1-3; a..3
- Ankunftsdatum, optional, Pflicht bei Artikeltyp 1-3; n8 im Format YYYYMMDD
- Buchungsklasse, optional, Pflicht bei Artikeltyp 1-3; a..2 (bc: Business-Klasse, fc: Erste Klasse, co: Bus, na: nicht verfügbar)
- Routentyp, optional, Pflicht bei Artikeltyp 1-3; a..2 (rt: Rundreise, ow: Einweg, na: nicht verfügbar)
- Tickettyp, optional, Pflicht bei Artikeltyp 1-3; a..2 (nr: Umbuchung nicht möglich, rf: Umbuchung gegen Gebühr möglich, fl: keine Umbuchungsgebühren, na: nicht verfügbar)

Hinweis zum Aufbau der Artikelliste:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

Jeder Artikel wird als kompletter Artikeldatensatz übergeben:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1; subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

OrderDescans..768M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

Gesamter Warenkorb des Kunden einschließlich Bestellung, Gebühren und Rabatten mit folgenden Daten:

- Versandname (Name der Versandmethode), ans..50
- Versandkosten netto in kleinster Währungseinheit, n..7
- Versandkosten brutto in kleinster Währungseinheit, n..7
- Rabatt netto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Rabatt brutto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Gesamtpreis netto in kleinster Währungseinheit, n..7
- Gesamtpreis brutto in kleinster Währungseinheit, n..7

Hinweis zum Aufbau der Bestellinformation:

<;> trennt die Felder der Bestellinformation

Jede Bestellung wird als kompletter Datensatz übergeben.

Alle übergebenen Daten werden validiert, wobei die Summe der Einzelpositionen den Gesamtpreis ergeben muss. Dabei muss gelten:

Gesamtpreis brutto=Summe(Artikelanzahl x Artikelbruttopreis) + Versandkosten brutto – Rabatt brutto

Gesamtpreis=Summe(Artikelanzahl x Artikelnettopreis) + Versandkosten – Rabatt

Beispiel:

Versandname;Versandkosten;Versandkosten brutto;Rabatt;Rabatt brutto;Gesamtpreis;Gesamtpreis brutto

DHL Standard;336;400;1390;1654;22307;26546

OrderHistoryans..768O

Customer’s order history/order information from the last 20 orders with the following information:

- Historical order number., ans..20
- Date of order, format YYYYMMDD hh:mm:ss
- Total price in the smallest currency unit, n..7
- Currency according to ISO 4217
- Payment method of the order with the following values:

<0> Direct Debit, <1> Credit Card, <2> Advance Payment, <3> Cash on Delivery, <4> Paypal, <5> Online Transfer, <6> Invoice, <7> BillPay invoice, <100> Other.

- Status of the order with the following values:
<0> paid, <1> open, <2> reminder, <3> debt collection, <4> overpaid, <5> underpaid, <6> cancelled.

Note on the structure of the OrderHistory:

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

A max. of 20 data records may be transferred

Example: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

Bestellhistorie/Bestellinformation des Kunden der letzten 20 Bestellungen mit folgenden Informationen:

- Historische Bestellnr., ans..20
- Bestelldatum, Format YYYYMMDD hh:mm:ss
- Gesamtpreis in kleinster Währungseinheit, n..7
- Währung nach ISO 4217
- Zahlungsart der Bestellung mit folgenden Werten:

<0> Lastschrift, <1> Kreditkarte, <2> Vorkasse, <3> Nachnahme, <4> PayPal, <5> Sofort/giropay, <6> Rechnung, <7> BillPay-Rechnung, <100> Sonstige.

- Status der Bestellung mit folgenden Werten:
<0> bezahlt, <1> offen, <2> Mahnwesen, <3> Inkasso, <4> überbezahlt, <5> unterbezahlt, <6> geplatzt.

Hinweis zum Aufbau der OrderHistory:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

max. 20 Datensätze dürfen übergeben werden

Beispiel: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

CustomerClassificationn1O

Customer specification

0 – Customer has not yet ordered or has successfully completed payment for fewer than 2 orders

1 – Customer has already made successful payment for 2 or more orders

Kundenspezifikation

0 – Kunde hat noch nie bestellt oder weniger als 2 Bestellungen erfolgreich bezahlt

1 – Kunde hat bereits 2 oder mehr Bestellungen erfolgreich bezahlt

Limitn..12OC

Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro.

If CustomerClassification=0
- and no successful payment: Limit=0
- and one successful payment: Limit=2500


If CustomerClassification=1

Rule               Limit
1 € < x < 40 €         8000
40 € =< x < 75 €  15000
75 € =< x < 300 € x * 200
300 € =< x < 2000 €      (600 + (x-300) / 2) * 100
2000 € =< x           250000

Example: Payment history EUR 180 over 2 purchases:

Limit = 180*200 = 36000

Pflicht, wenn CustomerClassification übermittelt wird: Numerischer Wert Limit, basierend auf der positiven Bezahlerfahrung x in Euro.

Wenn CustomerClassification=0
- und keine erfolgreiche Zahlung: Limit=0
- und eine erfolgreiche Zahlung: Limit=2500


Wenn CustomerClassification=1

Regel                                     Limit
1 € < x < 40 €                         8000
40 € =< x < 75 €     15000
75 € =< x < 300 €   x * 200
300 € =< x < 2000 €               (600 + (x-300) / 2) * 100
2000 € =< x                            250000

Beispiel: Zahlungserfahrung 180 Euro in 2 Käufen:

Limit = 180*200 = 36000




Bank dataBankdaten
AccOwnerans..50M

First name and surname of the account holder (purchaser)

Vor- und Zuname des Kontoinhabers (Käufers)

IBANans..34M

Customer's IBAN

IBAN des Kunden

BICan..11M

Customer’s BIC

BIC des Kunden




in case of BillPay hire purchasebei Billpay-Ratenkauf
BpBaseAmountn..7MRe financing gross amount (total price + interest + transaction fee)Zu finanzierender Bruttobetrag (Gesamtpreis + Zinsaufschlag + Transaktionsgebühr)
BpRateCountn..2M

Number of monthly instalments selected by purchaser

Notice: BpRateCount is to be used together with PayID and BillPayAction for a subsequent call.

Anzahl der vom Käufer gewählten Monatsraten

Hinweis: BpRateCount ist zusammen mit PayID und BillPayAction für einen Folgeaufruf zu verwenden.

URLBackans..256M

URL to which the customer is routed back after the down payment. Please use a reference within this URL in order to allocate the payment later.

The parameter "URLBack" can be sent

  • either as plain parameter (unencrypted) (compatibility mode)
  • or be part of encrypted payment request parameters (preferred mode)

URL, auf die der Kunde nach der Anzahlung zurückgeleitet wird. Verwenden Sie in der URL am besten eine Referenz, um die Zahlung entsprechend zuordnen zu können.

Der Parameter "URLBack" kann

  • sowohl unverschlüsselt übermittelt werden (Kompabilitätsmodus)
  • als auch in den verschlüsselten Übergabeparametern (bevorzugte Variante)
URLNotifyans..256MC

Mandatory if no URLNotify for PayLater ist stored at :

Complete URL, which calls up  in order to notify the shop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

This URL is callad only if the customer was forwarded to the gateway for down payment, because in this case the response from gateway is delayed.

Pflicht, wenn keine URLNotify für PayLater bei  hinterlegt ist:

URL, die das  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.

Die URL wird nur aufgerufen, wenn der Kunde zum Anzahlungsgateway weitergeleitet wurde, da in diesem Fall die Antwort vom Gateway zeitverzögert gesendet wird.




Travel dataReisedaten
TripDataans..768OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten:

- Anzahl bereits gebuchter Reisen, n..3
- Gesamtbetrag bereits gebuchter Reisen in kleinster Währungseinheit, n..7
- Währung bereits gebuchter Reisen, a3

Hinweise zum Aufbau des Parameters TripData:
<;> trennt die Felder eines Datensatzes

Beispiel:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerListans..768OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten:

- Anrede, a..
- Vorname, ans..40
- Nachname, ans..40
- Geburtstag im Format YYYYMMDD, a8
- Mitgliedschaft, n1
•              0: nicht verfügbar (Standardwert)

•              1: Mitglied in einem Vielfliegerprogramm

•              2: Kein Mitglied in einem Vielfliegerprogramm

- MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0)

Hinweise zum Aufbau des Parameters TravelerList:
<;> trennt die Felder eines Datensatzes

Pro Reisendem muss ein kompletter Datensatz übergeben werden.

Beispiel:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for PayLater via BillPay



Key

Format

CND

Description

Beschreibung

Status

a..50

M

OK, FAILED or AUTHORIZE_REQUEST if a down payment is needed

OK, FAILED oder AUTHORIZE_REQUEST bei einer nötigen Anzahlung

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant’s reference number. In case of updating the RefNr the new RefNr is returned to the merchant.

Referenznummer des Händlers. Im Falle einer Aktualisierung der RefNr bekommt Händler die neue RefNr zurück.

BpStatusa..8MStatus of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED>, <PRE_APPROVED> (in case of a necessary down payment) or <NOSTATUS> if errors occurredStatus der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED>, <PRE_APPROVED> (im Falle einer nötigen Anzahlung) oder bei Fehlern <NOSTATUS>
BpTransactionIDans..50O

BillPay transaction number

Notice: BpTransactionID is returned only if BpStatus=APPROVED

BillPay-Transaktionsnummer

Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED




Response from PayLaterAntwort von PayLater
BpConditionsListans..768C

is returned only if BpStatus=APPROVED Values for calculation of the instalment plan:

- num_inst: Number of monthly partial amounts to be paid by the customer
- duration: Term of instalment plan
- fee_percent: Percentage of PayLater fee
- fee_total: Total sum of PayLater fee
- pre_payment: Amount paid
- total_amount: Total amount of PayLater order
- eff_anual: eff. annual interest rate in percent
- nominal: Annual nominal interest rate in percent

<;>separates fields within a financing data record

Example: <num_inst>;<duration>;<fee_percent>;<fee_total>;<pre_payment>;<total_amount>;<eff_anual>;<nominal>

wird nur zurückgegeben, wenn BpStatus=APPROVED: Werte für die Berechnung des Ratenplans:

- num_inst: Anzahl der durch den Kunden zu zahlenden monatlichen Teilbeträge
- duration: Laufzeit des Ratenplans
- fee_percent: Prozentuale Angabe der PayLater-Gebühr
- fee_total: Gesamtsumme der erhobenen PayLater-Gebühr
- pre_payment: angezahlter Betrag
- total_amount: Gesamtbetrag der PayLater-Bestellung
- eff_anual: eff. Jahreszins in Prozent
- nominal: Jährlicher Nominalzins in Prozent

<;> trennt Felder innerhalb eines Finanzierungsdatensatzes

Beispiel: <num_inst>;<duration>;<fee_percent>;<fee_total>;<pre_payment>;<total_amount>;<eff_anual>;<nominal>

BpPaymentPlanans..768C

is returned only if BpStatus=APPROVED List with monthly instalments and due date and amount of instalment

-     Value of instalments payable in the smallest currency unit “instl”

-     Date of expected receipt “date”

-     Type of instalment “type”

<;> separates the instalment and date of a data record
<+> separates monthly instalments

Example: „instl1“; „date1“; „type1“+ „instl2“; „date2“; „type2“ + „instl3“…

wird nur zurückgegeben, wenn BpStatus=APPROVED: Liste der monatlichen Raten inkl. Einzugsdatum und Höhe der Rate

-              Wert fällige Rate in kleinster Währungseinheit „instl“

-              Datum des voraussichtlichen Einzugs „date“

-              Typ des Rate „type“

<;> trennt Rate und Datum eines Datensatzes
<+> trennt monatliche Raten

Beispiel: „instl1“; „date1“; „type1“+ „instl2“; „date2“; „type2“ + „instl3“…

PrePaymentn..12CIs returned only if BpStatus=PRE_APPROVED Amount of prepayment to be payed by the customerWird nur zurückgegeben, wenn BpStatus=PRE_APPROVED: Vom Kunden zu leistender Anzahlungsbetrag
BpLink1ans..768CIs returned only if BpStatus=PRE_APPROVED URL for forwarding to the prepayment partner. This value is URL-encoded und must be URL-decoded.Wird nur zurückgegeben, wenn BpStatus=PRE_APPROVED: URL für Weiterleitung zum Anzahlungspartner. Dieser Wert ist URL-Encoded und muss entsprechend URL-Decoded werden.
BpLink2ans..768CIs returned only if BpStatus=PRE_APPROVED URL for the updated instalment plan including the amount of prepayment. This value is URL-encoded und must be URL-decoded.Wird nur zurückgegeben, wenn BpStatus= PRE_APPROVED: URL zum aktualisierten Ratenplan inklusive Anzahlungsbetrag. Dieser Wert ist URL-Encoded und muss entsprechend URL-Decoded werden.
Campaignans..768C

Is returned only if BpStatus=PRE_APPROVED

Campaign information

- type of campaign. This describes the shifting of the payment date (e.g. 14 days or 7 days) “type”

- Text displayed on the page before transfer to payment partner “display_text”

- Path to a promotional image depending on the campaign “display_image_url”

<;> separates the fields of the campaign information

Example: „type“; „display_text“; „display_image_url“

Wird nur zurückgegeben, wenn BpStatus= PRE_APPROVED:

Kampagneninformationen

- Art der Kampagne. Diese beschreibt die Verschiebung des Zahlungsziels (z.B. 14 Tage oder 7 Tage) „type“

- Ausformulierter Text zur Anzeige auf der Seite vor der Weiterleitung zum Anzahlungspartner „display_text“

- Pfad zu einem Promotion-Bild entsprechend der Kampagne „display_image_url“

<;> trennt die Felder der Kampagneninformationen

Beispiel: „type“; „display_text“; „display_image_url“




Corrected address dataKorrigierte Adressdaten
Streetans..50OCorrected street of customerKorrigierte Straße des Kunden
StreetNrans..5OCorrected street number of customerKorrigierte Hausnummer des Kunden
Zipans..5OCorrected postcode of customerKorrigierte PLZ des Kunden
Cityans..50OCorrected town/city of customerKorrigierter Wohnort des Kunden
Countrya3OCustomer’s corrected country code according to ISO3166 alpha-3Korrigierter Ländercode des Kunden nach ISO3166 alpha-3



Response in case of errorAntwort bei Fehlern
ErrorText1ans..255O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText1 enthält die detaillierte Fehlernachricht von BillPay für den Händler.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText2ans..255O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText2 enthält die detaillierte Fehlernachricht von BillPay für den Käufer.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText3n..6O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText3 enthält den detaillierten BillPay-Fehlercode.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

Result parameters for PayLater via BillPay



Capture & partial capture via socket connection

Captures are possible via a Server-to-Server connection. Additionally the merchant can full or partly activate BillPay reservations and in this way set the date of payment for the customer. If the merchant transfers a new reference number, the reference number of the reservation will be updated and then the invoice is activated. To carry out a Capture via a Server-to-Server connection, please use the following URL:

capture.aspx


Key

Format

CND

Description

Beschreibung

RefNr

ns..30

M

Unique reference number which appears on your printed card account or in the EPA-file (Electronic Payment Advice). Format must be mutually agreed beforehand with ! For EVO Payments International Customers: compulsory field for unique number.

The RefNr will be updated, if another RefNr is submitted than for the reservation.

Eindeutige Referenznummer, die auf Ihrer gedruckten Kartenabrechnung oder in der EPA-Datei (Electronic Payment Advice) erscheint. Das Format muss zuvor mit  abgestimmt werden! Für Kunden von EVO Payments International: Pflichtfeld für eindeutige Nummer.

Die RefNr wird aktualisiert, wenn beim Aufruf eine andere RefNr als bei der Reservierung übergeben wird.

Key

Format

CND

Description

Beschreibung

InvoiceNrans..30COnly for BillPay partial activation: unique invoice numberNur bei BillPay-Teilaktivierung: eindeutige Rechnungsnummer
Delayn..3ONumber of days to delay the due dateAnzahl der Tage, um die das Zahlungsziel verschoben wird
ArticleListans..768M

BillPay partial activation only:

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7

Note on the structure of the article list:

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

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+…

Nur bei BillPay-Teilaktivierung:

Warenkorb des Kunden mit folgenden Artikeldaten:

- Artikelnr., ans..20
- Anzahl, n..7
- Artikelname, ans..50
- Artikelbeschreibung, ans..50
- Artikelpreis netto in kleinster Währungseinheit, n..7
- Artikelpreis brutto in kleinster Währungseinheit, n..7

Hinweis zum Aufbau der Artikelliste:

<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

Jeder Artikel wird als kompletter Artikeldatensatz übergeben:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+…

OrderDescans..768M

BillPay partial activation only:

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross
Total price gross=sum(article number x article net price) + shipping costs – discount

Example: Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

Nur bei BillPay-Teilaktivierung:

Gesamter Warenkorb des Kunden einschließlich Bestellung, Gebühren und Rabatten mit folgenden Daten:

- Versandname (Name der Versandmethode), ans..50
- Versandkosten netto in kleinster Währungseinheit, n..7
- Versandkosten brutto in kleinster Währungseinheit, n..7
- Rabatt netto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Rabatt brutto (incl. aller Rabatte, Coupons und sonstigen Positionen) in kleinster Währungseinheit, n..7
- Gesamtpreis netto in kleinster Währungseinheit, n..7
- Gesamtpreis brutto in kleinster Währungseinheit, n..7

Hinweis zum Aufbau der Bestellinformation:

<;> trennt die Felder der Bestellinformation

Jede Bestellung wird als kompletter Datensatz übergeben.

Alle übergebenen Daten werden validiert, wobei die Summe der Einzelpositionen den Gesamtpreis ergeben muss. Dabei muss gelten:

Gesamtpreis brutto=Summe(Artikelanzahl x Artikelbruttopreis) + Versandkosten brutto – Rabatt brutto
Gesamtpreis=Summe(Artikelanzahl x Artikelnettopreis) + Versandkosten – Rabatt

Beispiel: Versandname;Versandkosten;Versandkosten brutto;Rabatt;Rabatt brutto;Gesamtpreis;Gesamtpreis brutto

DHL Standard;336;400;1390;1654;22307;26546

Parameters for the capture of BillPay payments



Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Merchant’s reference number. In case of updating the RefNr the new RefNr is returned to the merchant.

Referenznummer des Händlers. Im Falle einer Aktualisierung der RefNr bekommt Händler die neue RefNr zurück.

InvoiceStatusa..10MStatus of activation request: Indicates whether reservation has been activated or not. Return values: „Activated“ or „Not Active“Status der Aktivierungsanfrage: zeigt an, ob Reservierung aktiviert wurde oder nicht. Rückgabewerte: „Activated“ oder „Not Active“
InvoiceNrans..30CBillPay partial activation only: Unique invoice number for partial activationNur bei BillPay-Teilaktivierung: Eindeutige Rechnungsnummer für Teilaktivierung



BillPay bank accountBillPay Bankverbindung
BpAccOwnerans..255MAccount holder for the receivables (usually “BillPay GmbH”)Kontoinhaber für die Forderung (i.d.R. „BillPay GmbH“)
IBANans..34MBillPay-IBAN for the receivables (can vary per order!)BillPay-IBAN für die Forderung (kann pro Bestellung variieren!)
BICan..11MBillPay-BIC for the receivablesBillPay-BIC für die Forderung
BpBankans..255MName of the bank for the receivablesName der Bank für die Forderung
BpInvoiceRefans..255MPurposeVerwendungszweck
BpInvoiceDaten8MCustomer's due dateZahlungsziel des Kunden



in case if BillPay hire purchasebei BillPay-Ratenkauf
BpPaymentPlanans..768M

Instalment plan selected by the buyer with information

- RateNr: number of the instalment
- RateAmount: instalment amount
- DueDate: due date of the instalment

<;>separates fields within a data record
<+> separates different data records

Example: <Rate1>;<RateAmount>;<DueDate>+ <Rate_n>;<RateAmount_n>;<DueDate_n>+ etc.

Vom Käufer gewählter Ratenplan mit den Angaben

- RateNr: Nummer der Rate
- RateAmount: Betrag der Rate
- DueDate: Fälligkeitsdatum der Rate

<;> trennt Felder innerhalb eines Datensatzes
<+> trennt unterschiedliche Datensätze

Beispiel: <Rate1>;<RateAmount>;<DueDate> + <Rate_n>;<RateAmount_n>;<DueDate_n> +…




BillPay Response in case of errorBillPay-Antwort bei Fehlern
ErrorText1ans..255O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText1 enthält die detaillierte Fehlernachricht von BillPay für den Händler.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText2ans..255O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText2 enthält die detaillierte Fehlernachricht von BillPay für den Käufer.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText3n..6O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText3 enthält den detaillierten BillPay-Fehlercode.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

Response parameters for the capture of BillPay payments



Reversal of BillPay payments

Reversals are possible via a Server-to-Server connection. BillPay can cancel both reservations and activations wherein there must be differentiation between full and partial cancellations. In order to reverse a BillPay payment, please use the following URL:

reverse.aspx


Key

Format

CND

Description

Beschreibung

NetRebaten..7O

Value by which the discount is to be increased or reduced (net value).

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the .

Wert, um den der Rabatt erhöht bzw. reduziert werden soll (Nettowert).

Hinweis: Dieser Parameter wird nur im Falle einer Teilstornierung ausgewertet. NetRebate/GrRebate nicht zusammen mit shRebate/shRebateGr verarbeiten. Bitte getrennte Anfragen an das  stellen.

GrRebaten..7O

Value by which the discount is to be increased or reduced (gross value).

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the .

Wert, um den der Rabatt erhöht bzw. reduziert werden soll (Bruttowert).

Hinweis: Dieser Parameter wird nur im Falle einer Teilstornierung ausgewertet. NetRebate/GrRebate nicht zusammen mit shRebate/shRebateGr verarbeiten. Bitte getrennte Anfragen an das  stellen.

shRebaten..7O

Rebate on net shipping costs.

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the .

Reduzierung der Liefergebühren (Nettowert).

Hinweis: Dieser Parameter wird nur im Falle einer Teilstornierung ausgewertet. NetRebate/GrRebate nicht zusammen mit shRebate/shRebateGr verarbeiten. Bitte getrennte Anfragen an das  stellen.

shRebateGrn..7O

Rebate on gross shipping costs.

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the .

Reduzierung der Liefergebühren (Bruttowert).

Hinweis: Dieser Parameter wird nur im Falle einer Teilstornierung ausgewertet. NetRebate/GrRebate nicht zusammen mit shRebate/shRebateGr verarbeiten. Bitte getrennte Anfragen an das  stellen.

ArticleListans..768O

Article list with data of the articles to be cancelled. The full ArticleList does not need to be transmitted; only the ArticleID (ans..20) and articlequantity (n..7) fields:

Note on the structure of the article list:
<;> separates the fields of an article data set
<+> separates the article data sets

Example: articleid;articlequantity+ articleid;articlequantity+…

Notice: This parameter is only used for partial reversals.

Artikelliste mit Daten der zu stornierenden Artikel. Es muss nicht die komplette ArticleList übergeben werden, sondern nur die Felder ArticleID (ans..20) und articlequantity (n..7):

Hinweis zum Aufbau der Artikelliste:
<;> trennt die Felder eines Artikeldatensatzes
<+> trennt die Artikeldatensätze

Beispiel: articleid;articlequantity+ articleid;articlequantity+…

Hinweis: Dieser Parameter wird nur bei einer Teilstornierung ausgewertet.

Reasona11O

Indicates that cancellation refers to articles that have not yet been activated. Only necessary after partial activation.

Reason=RESERVATION

Gibt an, dass sich Stornierung auf noch nicht aktivierte Artikel bezieht. Nur nötig nach Teilaktivierung.

Reason=RESERVATION

Parameters for the reversal of BillPay payments



Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number. When updating the reference number the new RefNr is returned to the merchant.

Eindeutige Referenznummer. Bei Aktualisierung der Referenznummer erhält der Händler die neue RefNr zurück.




Response in case of partial reversal for hire purchaseAntwort bei Teilstornierung bei Ratenkauf
BpConditionsListans..C

New calculated data for hire purchase after partial reversal.

- Number of monthly instalments “term”, n..7
- Value of shopping cart, “base” n..7
- Gross order value “cart”, n..7
- Financing interest charge “surcharge”, n..7
- Gross total value “total”, n..7
- Monthly charge % “interest”, n..2
- eff. annual interest rate % “anual”, n..4
- BillPay fee “fee”, n..7

All amounts in the smallest currency unit (e.g. EUR Cent)

<;> separates fields of a hire purchase data record  
<+> separates different hire purchase conditions

Example: <term>;<base>;<cart>; <surcharge>;<total>;<interest>;<anual>;<fee>+…

Neu berechnete Kalkulationsdaten für Ratenkauf bei Teilstornierung.

- Anzahl Monatsraten „term“, n..7
- Wert des Warenkorbs „base“, n..7
- Bruttobestellwert „cart“, n..7
- Finanzierungszinsaufschlag „surcharge“, n..7
- Bruttogesamtwert „total“, n..7
- Monatsaufschlag % „interest“, n..2
- eff. Jahreszins % „anual“, n..4
- BillPay-Gebühr „fee“, n..7

Alle Beträge in kleinster Währungseinheit, z.B. EUR Cent.

<;> trennt Felder eines Finanzierungsdatensatzes
<+> trennt verschiedene Finanzierungskonditionen

Beispiel: <term>;<base>;<cart>; <surcharge>;<total>;<interest>;<anual>;<fee>+…

BpPaymentPlanans..C

New calculated rate plans for the financing.

- RateNr: number of the instalment
- RateAmount: instalment amount
- DueDate: due date of the instalment

<;>separates fields within a data record
<+> separates different data records

Example: <Rate1>;<RateAmount>;<DueDate>+ <Rate_n>;<RateAmount_n>;<DueDate_n>+ etc.

Notice: If partial cancellation is carried out on a purchase by instalment reservation, the new instalment plan will have NO due dates!

Neu berechnete Ratenpläne der Finanzierung.

- RateNr: Nummer der Rate
- RateAmount: Betrag der Rate
- DueDate: Fälligkeitsdatum der Rate

<;> trennt Felder innerhalb eines Datensatzes
<+> trennt unterschiedliche Datensätze

Beispiel: <Rate1>;<RateAmount>;<DueDate> + <Rate_n>;<RateAmount_n>;<DueDate_n> +…

Hinweis: Wird die Teilstornierung auf eine Ratenkauf-Reservierung durchgeführt, so enthält der neue Ratenplan KEINE Fälligkeitsdaten!




Response in case of errorAntwort bei Fehlern
ErrorText1ans..255O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText1 enthält die detaillierte Fehlernachricht von BillPay für den Händler.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText2ans..255O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText2 enthält die detaillierte Fehlernachricht von BillPay für den Käufer.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

ErrorText3n..6O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with .

ErrorText3 enthält den detaillierten BillPay-Fehlercode.

Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den .

Result parameters for reversals of BillPay payments



Batch processing via the interface

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

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

Action

Version

Description

Beschreibung

Capture

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)
Reverse1.0 / 2.0Standard version without return of parameter CodeStandardversion ohne Rückgabe von Parameter Code

1.x / 2x.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 BillPay payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>
BillPay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
BillPay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

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

Key

Format

CND

Description

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, BillPay for BillPay

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

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Reverse (Storno)

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Unique reference number

Eindeutige Referenznummer

Description of fields within the record for Batch files

 

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

HEAD,<MerchantID>,<Date>,<Version>
BillPay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
BillPay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>

Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction: Capture, Reverse

Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung), Reverse (Storno)

Description of result parameters within the record for Batch files