- Created by writer, last modified by bnp-admin on 02. Apr 2024
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.
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. |
Type | Mixed payment methods |
Further information can be found at the webpage of BillPay (http://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 go to the following URL:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by . Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | Format | CND | Description |
---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit). |
Key | Format | CND | Description |
---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: Currency table |
Key | Format | CND | Description |
---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
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) |
NewCustomer | ans..5 | M | Defines 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> |
BillPayAction | n1 | M | Defines the method of payment used. Values: <1> for invoice purchase | Definiert, welche Zahlungsart verwendet wird. Werte: <1> für Rechnungskauf |
GtcValue | a..3 | M | Defines 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> |
DateOfBirth | an10 | MC | Birth 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) |
IpAddr | ans15 | M | Customer´s IP address in IPv4 or IPv6 format | IP-Adresse des Kunden im Format IPv4 oder IPv6 |
ActivationDelay | n..3 | OC | 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) |
CompanyOrPerson | a1 | OC | Distinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2B | Unterscheidung des Käufers nach Privatperson oder Firma. Werte: <F> für Firmen, <P> für Personen, Standardwert <P>. Pflicht bei BillPay B2B |
BrowserSessionID | ans..100 | O | SessionID 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 data | Rechnungsdaten | |||
bdSalutation | a..15 | M | 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 |
bdTitle | ans..20 | O | Title 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. |
bdFirstName | ans..50 | M | First name of customer or contact person in company | Vorname des Kunden oder der Kontaktperson in der Firma |
bdLastName | ans..50 | M | Last name of customer or contact person in company | Nachname des Kunden oder der Kontaktperson in der Firma |
bdStreet | a..50 | M | Street name in the invoicing address | Straßenname der Rechnungsadresse |
bdStreetNr | ans..5 | M | Street number of the invoicing address | Hausnummer der Rechnungsadresse |
bdStreet2 | a..50 | O | Address addition in the billing address | Adresszusatz der Rechnungsadresse |
bdZip | n5 | M | Postcode in the invoicing address | Postleitzahl der Rechnungsadresse |
bdCity | ans..50 | M | Town/city of the invoicing address | Ort der Rechnungsadresse |
bdCountryCode | a3 | M | Country 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). |
ans..50 | M | E-mail address of the customer or contact person on the invoicing address | E-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift | |
Phone | ans..15 | OC | 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. |
MobileNo | ans..50 | O | Mobile telephone number of the customer on the invoicing address | Handy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift |
Delivery data | Lieferdaten | |||
UseBillingData | a3 | M | Is 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. |
sdSalutation | a..15 | C | 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 |
sdTitle | ans..20 | O | Title of the customer on the invoice, e.g. Dr. or Prof. | Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof. |
sdFirstName | ans..50 | C | Obligatory, if UseBillingData=No: First name of customer or contact person in company | Pflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma |
sdLastName | ans..50 | C | Obligatory, if UseBillingData=No: Last name of customer or contact person in company | Pflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma |
sdStreet | a..50 | C | Obligatory, if UseBillingData=No: Street in the delivery address | Pflicht, wenn UseBillingData=No: Straßenname der Lieferadresse |
sdStreetNr | ans..5 | C | Obligatory, if UseBillingData=No: Street number of the delivery address | Pflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse |
sdStreet2 | a..50 | O | Address addition in the delivery address | Adresszusatz der Lieferadresse |
sdZip | n5 | C | Obligatory, if UseBillingData=No: Postcode in the delivery address | Pflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse |
sdCity | ans..50 | C | Obligatory, if UseBillingData=No: Town/city of the delivery address | Pflicht, wenn UseBillingData=No: Ort der Lieferadresse |
sdCountryCode | a3 | C | Obligatory, 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). |
sdPhone | ans..15 | O | Telephone number of the customer in the delivery address | Telefonnummer des Kunden in der Lieferanschrift |
sdMobileNo | ans..50 | O | Mobile telephone number of the customer in the delivery address | Handy-Nummer des Kunden in der Lieferanschrift |
Company data | Firmendaten | |||
CompanyName | ans..200 | C | Company name. Obligatory if CompanyOrPerson=F | Firmenname. Pflicht, falls CompanyOrPerson=F |
LegalForm | a..12 | C | 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>. |
RegisterNumber | ans..20 | C | 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 |
HolderName | ans..100 | C | 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 |
TaxNumber | ans..20 | C | 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 data | Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | Customer’s shopping cart with the following article data: - Article no., ans..20 • 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 Note on the structure of the article list: <;> separates the fields of an article data set 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 • 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 Hinweis zum Aufbau der Artikelliste: <;> trennt die Felder eines Artikeldatensatzes 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 +… |
OrderDesc | ans..768 | M | Customer’s complete shopping cart including order, fees and discount with the following data: - Shipping name (name of shipping method), ans..50 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 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 |
OrderHistory | ans..768 | O | Customer’s order history/order information from the last 20 orders with the following information: - Historical order number., ans..20 <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: Note on the structure of the OrderHistory: <;> separates the fields of an article data set 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 <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: Hinweis zum Aufbau der OrderHistory: <;> trennt die Felder eines Artikeldatensatzes max. 20 Datensätze dürfen übergeben werden Beispiel: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+… |
CustomerClassification | n1 | O | 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 |
Limit | n..12 | OC | Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro. If CustomerClassification=0 If CustomerClassification=1 Rule Limit 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 Wenn CustomerClassification=1 Regel Limit Beispiel: Zahlungserfahrung 180 Euro in 2 Käufen: Limit = 180*200 = 36000 |
Bank data | Bankdaten | |||
AccOwner | ans..50 | M | 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) |
IBAN | ans..34 | M | 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) |
BIC | an..11 | OC | 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 purchase | bei Billpay-Ratenkauf | |||
BpBaseAmount | n..7 | C | 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. |
BpRateCount | n..2 | C | 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 data | Reisedaten | |||
TripData | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data: - Number of trips already posted, n..3 Hints on structure of parameter TripData: Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten: - Anzahl bereits gebuchter Reisen, n..3 Hinweise zum Aufbau des Parameters TripData: Beispiel: |
TravelerList | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data: - Salutation, a.. • 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: A complete data record must be transferred per traveller. Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten: - Anrede, a.. • 1: Mitglied in einem Vielfliegerprogramm • 2: Kein Mitglied in einem Vielfliegerprogramm - MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0) Hinweise zum Aufbau des Parameters TravelerList: Pro Reisendem muss ein kompletter Datensatz übergeben werden. Beispiel: |
Parameters for BillPay payments
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Key | Format | CND | Description |
---|---|---|---|
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Key | Format | CND | Description |
---|---|---|---|
Code | n8 | M | Error code according to Response Codes (A4 Response codes) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..30 | O | Unique reference number for accounting | Eindeutige Referenznummer für die Buchhaltung |
BpTransactionID | ans..50 | C | BillPay transaction number Notice: BpTransactionID is returned only if BpStatus=APPROVED | BillPay-Transaktionsnummer Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED |
BpStatus | a..8 | M | Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurred | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS> |
Corrected address data | Korrigierte Adressdaten | |||
Street | ans..50 | O | corrected street of customer | korrigierte Straße des Kunden |
StreetNr | ans..5 | O | corrected street number of customer | korrigierte Hausnummer des Kunden |
Zip | ans..5 | O | corrected postcode of customer | korrigierte PLZ des Kunden |
City | ans..50 | O | corrected town/city of customer | korrigierter Wohnort des Kunden |
Country | a3 | O | Customer’s corrected country code according to ISO3166 alpha-3 | korrigierter Ländercode des Kunden nach ISO3166 alpha-3 |
virtual BillPay bank details | virtuelle BillPay-Bankverbindung | |||
BpAccOwner | ans..255 | C | 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 |
IBAN | ans..34 | C | 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 |
BIC | an..11 | C | 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 |
BpBank | ans..255 | C | 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 |
BpInvoiceRef | ans..255 | C | 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 purchase | Rückgabe bei Ratenkauf | |||
BpConditionsList | ans..768 | M | BillPay conditions for instalment payment - Number of monthly instalments “term”, n..7 All amounts in the smallest currency unit (e.g. EUR Cent) <;> separates fields of a hire purchase data record Example: „term“;„base“;„cart“;„surcharge“;„total“; „interest“;„anual“;„fee“+… | BillPay-Konditionen für Ratenzahlung - Anzahl Monatsraten „term“, n..7 Alle Beträge in kleinster Währungseinheit, z.B. EUR Cent. <;> trennt Felder eines Finanzierungsdatensatzes Beispiel: „term“;„base“;„cart“;„surcharge“;„total“; „inte-rest“;„anual“;„fee“+… |
BpPaymentPlan | ans..768 | M | BillPay instalment plans with the following data: - Number of monthly instalments “term”, n..2 <;> separates fields of a data record in the instalment plan Example: „term“;„due1“;„due2“;„due_n“+ „term“;„due1“;„due2“;„due_n“+ | BillPay-Ratenpläne mit folgenden Daten: - Anzahl Monatsraten „term“, n..2 <;> trennt Felder eines Datensatzes im Ratenplan Beispiel: „term“;„due1“;„due2“;„due_n“+ „term“;„due1“;„due2“;„due_n“+ |
BpLink1 | ans..768 | M | Link to BillPay terms and condition for hire purchase which is to be displayed | zu zeigender Link zu BillPay-AGBs für Ratenkauf |
BpLink2 | ans..768 | M | Link to BillPay data protection regulations which is to be displayed | zu zeigender Link zu Datenschutzbestimmungen von BillPay |
BpLink3 | ans..768 | M | Link to BillPay terms of payment which is to be displayed | zu zeigender Link zu BillPay-Zahlungsbedingungen |
BpInfo1 | ans.. | 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. |
BpInfo2 | ans.. | 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 error | Rückgabe im Fehlerfall | |||
ErrorText1 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText2 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText3 | n..6 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ValidationErrors | ans..1024 | O | in case of one or more validation errors with following data: - error field <;> separates fields within a validation error Example: <error field>; <error code>; <error message customer>; <error message merchant>+etc. | bei einem oder mehreren Validierungsfehlern mit folgenden Daten: - Fehlerfeld <;> trennt Felder in einem 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.
Enter the following URL to change the shopping cart associated with a payment previously initialised with BillPay:
The following table describes the transfer parameters to be encrypted:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by . Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit). |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Article and order data | Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | Customer’s shopping cart with the following article data: - Article no., ans..20 Note on the structure of the article list: <;> separates the fields of an article data set 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 Hinweis zum Aufbau der Artikelliste: <;> trennt die Felder eines Artikeldatensatzes 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+… |
OrderDesc | ans..768 | M | Customer’s complete shopping cart including order, fees and discount with the following data: - Shipping name (name of shipping method), ans..50 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 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 |
EventToken | a2 | M | Abbreviation of the action to be done: Presently only CO (Change order) possible | Abkürzung der auszuführenden Aktion: Derzeit nur CO (Change order) möglich |
Parameters for subsequent change of shopping cart with BillPay payments
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Key | Format | CND | Description |
---|---|---|---|
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Key | Format | CND | Description |
---|---|---|---|
Code | n8 | M | Error code according to Response Codes (A4 Response codes) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..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. |
BpTransactionID | ans..50 | C | BillPay transaction number | BillPay-Transaktionsnummer |
BpStatus | a..8 | M | Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurred | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS> |
Response in case of hire purchase | Rückgabe bei Ratenkauf | |||
BpConditionsList | ans..768 | M | BillPay conditions for instalment payment - term: Number of monthly instalments, 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 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> |
BpPaymentPlan | ans..768 | M | Instalment plan selected by the buyer: - RateNr: number 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 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 Hinweis: Hier wird der Ratenplan für die bereits gewählte Anzahl an Monatsraten ausgegeben. <;> trennt Felder innerhalb eines Datensatzes Beispiel: <Rate1>;<RateAmount>;<DueDate> + <Rate_n>;<RateAmount_n>;<DueDate_n> +… Hinweis: Falls die Bestellung nicht aktiviert wurde, ist DueDate leer. |
Response in case of error | Rückgabe im Fehlerfall | |||
ErrorText1 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText2 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText3 | n..6 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
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 go to the following URL:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by . Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | Format | CND | Description |
---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit). |
Key | Format | CND | Description |
---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: Currency table |
Key | Format | CND | Description |
---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
---|---|---|---|
UserData | ans..1024 | O | If specified at request, forwards the parameter with the payment result to the shop. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
EventToken | a2 | M | Token for the call of the request: <PS> for PreScore | Token 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) |
NewCustomer | ans..5 | M | Defines 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> |
DateOfBirth | an10 | MC | Birth 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) |
IpAddr | ans15 | M | Customer´s IP address in IPv4 or IPv6 format | IP-Adresse des Kunden im Format IPv4 oder IPv6 |
CompanyOrPerson | a1 | OC | Distinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2B | Unterscheidung des Käufers nach Privatperson oder Firma. Werte: <F> für Firmen, <P> für Personen, Standardwert <P>. Pflicht bei BillPay B2B |
BrowserSessionID | ans..100 | O | SessionID 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 data | Rechnungsdaten | |||
bdSalutation | a..15 | M | 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 |
bdTitle | ans..20 | O | Title 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. |
bdFirstName | ans..50 | M | First name of customer or contact person in company | Vorname des Kunden oder der Kontaktperson in der Firma |
bdLastName | ans..50 | M | Last name of customer or contact person in company | Nachname des Kunden oder der Kontaktperson in der Firma |
bdStreet | a..50 | M | Street name in the invoicing address | Straßenname der Rechnungsadresse |
bdStreetNr | ans..5 | M | Street number of the invoicing address | Hausnummer der Rechnungsadresse |
bdStreet2 | a..50 | O | Address addition in the billing address | Adresszusatz der Rechnungsadresse |
bdZip | n5 | M | Postcode in the invoicing address | Postleitzahl der Rechnungsadresse |
bdCity | ans..50 | M | Town/city of the invoicing address | Ort der Rechnungsadresse |
bdCountryCode | a3 | M | Country 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). |
ans..50 | M | E-mail address of the customer or contact person on the invoicing address | E-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift | |
Phone | ans..15 | OC | Telephone number of the customer or contact person on the invoicing address | Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift |
MobileNo | ans..50 | O | Mobile telephone number of the customer on the invoicing address | Handy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift |
Delivery data | Lieferdaten | |||
UseBillingData | a3 | M | Is 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. |
sdSalutation | a..15 | C | 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 |
sdTitle | ans..20 | O | Title of the customer on the invoice, e.g. Dr. or Prof. | Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof. |
sdFirstName | ans..50 | C | Obligatory, if UseBillingData=No: First name of customer or contact person in company | Pflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma |
sdLastName | ans..50 | C | Obligatory, if UseBillingData=No: Last name of customer or contact person in company | Pflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma |
sdStreet | a..50 | C | Obligatory, if UseBillingData=No: Street in the delivery address | Pflicht, wenn UseBillingData=No: Straßenname der Lieferadresse |
sdStreetNr | ans..5 | C | Obligatory, if UseBillingData=No: Street number of the delivery address | Pflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse |
sdStreet2 | a..50 | O | Address addition in the delivery address | Adresszusatz der Lieferadresse |
sdZip | n5 | C | Obligatory, if UseBillingData=No: Postcode in the delivery address | Pflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse |
sdCity | ans..50 | C | Obligatory, if UseBillingData=No: Town/city of the delivery address | Pflicht, wenn UseBillingData=No: Ort der Lieferadresse |
sdCountryCode | a3 | C | Obligatory, 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). |
sdPhone | ans..15 | O | Telephone number of the customer in the delivery address | Telefonnummer des Kunden in der Lieferanschrift |
sdMobileNo | ans..50 | O | Mobile telephone number of the customer in the delivery address | Handy-Nummer des Kunden in der Lieferanschrift |
Company data | Firmendaten | |||
CompanyName | ans..200 | C | Company name. Obligatory if CompanyOrPerson=F | Firmenname. Pflicht, falls CompanyOrPerson=F |
LegalForm | a..12 | C | 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>. |
RegisterNumber | ans..20 | C | 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 |
HolderName | ans..100 | C | 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 |
TaxNumber | ans..20 | C | 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 data | Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | Customer’s shopping cart with the following article data: - Article no., ans..20 • 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 Note on the structure of the article list: <;> separates the fields of an article data set 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 • 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 Hinweis zum Aufbau der Artikelliste: <;> trennt die Felder eines Artikeldatensatzes 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 +… |
OrderDesc | ans..768 | M | Customer’s complete shopping cart including order, fees and discount with the following data: - Shipping name (name of shipping method), ans..50 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 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 |
OrderHistory | ans..768 | O | Customer’s order history/order information from the last 20 orders with the following information: - Historical order number., ans..20 <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: Note on the structure of the OrderHistory: <;> separates the fields of an article data set 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 <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: Hinweis zum Aufbau der OrderHistory: <;> trennt die Felder eines Artikeldatensatzes max. 20 Datensätze dürfen übergeben werden Beispiel: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+… |
CustomerClassification | n1 | O | 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 |
Limit | n..12 | OC | Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro. If CustomerClassification=0 If CustomerClassification=1 Rule Limit 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 Wenn CustomerClassification=1 Regel Limit Beispiel: Zahlungserfahrung 180 Euro in 2 Käufen: Limit = 180*200 = 36000 |
Travel data | Reisedaten | |||
TripData | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data: - Number of trips already posted, n..3 Hints on structure of parameter TripData: Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten: - Anzahl bereits gebuchter Reisen, n..3 Hinweise zum Aufbau des Parameters TripData: Beispiel: |
TravelerList | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data: - Salutation, a.. • 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: A complete data record must be transferred per traveller. Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten: - Anrede, a.. • 1: Mitglied in einem Vielfliegerprogramm • 2: Kein Mitglied in einem Vielfliegerprogramm - MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0) Hinweise zum Aufbau des Parameters TravelerList: Pro Reisendem muss ein kompletter Datensatz übergeben werden. Beispiel: |
Parameters for BillPay payment method control (PreScore)
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Status | a..50 | M | AUTHORIZE_REQUEST or FAILED | AUTHORIZE_REQUEST oder FAILED |
Key | Format | CND | Description |
---|---|---|---|
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Key | Format | CND | Description |
---|---|---|---|
Code | n8 | M | Error code according to Response Codes (A4 Response codes) |
Key | Format | CND | Description |
---|---|---|---|
UserData | ans..1024 | O | If specified at request, forwards the parameter with the payment result to the shop. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..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 | |||
BpStatus | a..8 | M | Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurred | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS> |
BpTransactionID | ans..50 | O | BillPay transaction number Notice: BpTransactionID is returned only if BpStatus=APPROVED | BillPay-Transaktionsnummer Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED |
Street | ans..50 | O | corrected street of customer | korrigierte Straße des Kunden |
StreetNr | ans..5 | O | corrected street number of customer | korrigierte Hausnummer des Kunden |
Zip | ans..5 | O | corrected postcode of customer | korrigierte PLZ des Kunden |
City | ans..50 | O | corrected town/city of customer | korrigierter Wohnort des Kunden |
Country | a3 | O | Customer’s corrected country code according to ISO3166 alpha-3 | korrigierter Ländercode des Kunden nach ISO3166 alpha-3 |
BrowserSessionID | ans..100 | O | SessionID 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) |
AllowedPayMethods | ans..768 | OC | List of allowed payment methods (is returned only if BpStatus=APPROVED) 1 for INVOICE Customer group: PRIVATE for B2C; BUSINESS for B2B Todo <;>separates fields within a data record Example: <ID>;< Name>,<Customer group>+<ID>;< Name>;<Customer group>+… | Liste erlaubter Zahlarten (wird nur zurückgegeben, wenn BpStatus=APPROVED) 1 für INVOICE (Rechnungskauf) Kundengruppe: PRIVATE für B2C; BUSINESS für B2B Todo <;> trennt die Werte eines Datensatzes Beispiel: <ID>;< Bezeichnung>,<Kundengruppe>+<ID>;< Bezeichnung>;<Kundengruppe>+… |
ValidationErrors | ans..1024 | O | Is returned in the case of one or more validation errors. Contains following data: - error field 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 Beispiel: <Fehlerfeld>;<Fehlercode>;<Fehlernachricht Kunde>;<Fehlernachricht Händler>+ … |
BillPay response in case of error | BillPay-Antwort bei Fehlern | |||
ErrorText1 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText2 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText3 | n..6 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
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, call the following URL:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by . Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
---|---|---|---|
UserData | ans..1024 | O | If specified at request, forwards the parameter with the payment result to the shop. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
BillPayAction | n1 | M | 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. |
ActivationDelay | n..3 | OC | 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) |
GtcValue | a..3 | M | Defines 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> |
DateOfBirth | an10 | MC | Birth 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) |
AccOwner | ans..50 | OC | 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) |
IBAN | ans..34 | OC | Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater) Customer's IBAN | Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater): IBAN des Kunden |
BIC | ans..11 | OC | Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater) Customer’s BIC | Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater): BIC des Kunden |
BpBaseAmount | n..7 | OC | 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. |
BpRateCount | n..2 | OC | 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. |
URLBack | ans..256 | OC | 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
| 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
|
URLNotify | ans..256 | OC | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro hinterlegt ist: URL, die das The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro 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 data | Reisedaten | |||
TripData | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data: - Number of trips already posted, n..3 Hints on structure of parameter TripData: Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten: - Anzahl bereits gebuchter Reisen, n..3 Hinweise zum Aufbau des Parameters TripData: Beispiel: |
TravelerList | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data: - Salutation, a.. • 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: A complete data record must be transferred per traveller. Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten: - Anrede, a.. • 1: Mitglied in einem Vielfliegerprogramm • 2: Kein Mitglied in einem Vielfliegerprogramm - MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0) Hinweise zum Aufbau des Parameters TravelerList: Pro Reisendem muss ein kompletter Datensatz übergeben werden. Beispiel: |
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, go to the following URL:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by . Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ns..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | Format | CND | Description |
---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit). |
Key | Format | CND | Description |
---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: Currency table |
Key | Format | CND | Description |
---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
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) |
NewCustomer | ans..5 | M | Defines 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> |
BillPayAction | n1 | M | Defines the method of payment used. Values: <1> for invoice purchase | Definiert, welche Zahlungsart verwendet wird. Werte: <1> für Rechnungskauf |
GtcValue | a..3 | M | Defines 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> |
DateOfBirth | an10 | OC | Birth 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) |
IpAddr | ans15 | M | Customer´s IP address in IPv4 or IPv6 format | IP-Adresse des Kunden im Format IPv4 oder IPv6 |
ActivationDelay | n..3 | OC | 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) |
CompanyOrPerson | a1 | OC | Distinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2B | Unterscheidung des Käufers nach Privatperson oder Firma. Werte: <F> für Firmen, <P> für Personen, Standardwert <P>. Pflicht bei BillPay B2B |
BrowserSessionID | ans..100 | O | SessionID 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 data | Rechnungsdaten | |||
bdSalutation | a..15 | OC | 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 |
bdTitle | ans..20 | O | Title 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. |
bdFirstName | ans..50 | M | First name of customer or contact person in company | Vorname des Kunden oder der Kontaktperson in der Firma |
bdLastName | ans..50 | M | Last name of customer or contact person in company | Nachname des Kunden oder der Kontaktperson in der Firma |
bdStreet | a..50 | M | Street name in the invoicing address | Straßenname der Rechnungsadresse |
bdStreetNr | ans..5 | M | Street number of the invoicing address | Hausnummer der Rechnungsadresse |
bdStreet2 | a..50 | O | Address addition in the billing address | Adresszusatz der Rechnungsadresse |
bdZip | n5 | M | Postcode in the invoicing address | Postleitzahl der Rechnungsadresse |
bdCity | ans..50 | M | Town/city of the invoicing address | Ort der Rechnungsadresse |
bdCountryCode | a3 | M | Country 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). |
ans..50 | M | E-mail address of the customer or contact person on the invoicing address | E-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift | |
Phone | ans..15 | M | Telephone number of the customer or contact person on the invoicing address | Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift |
MobileNo | ans..50 | O | Mobile telephone number of the customer on the invoicing address | Handy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift |
Delivery data | Lieferdaten | |||
UseBillingData | a3 | M | Is 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. |
sdSalutation | a..15 | OC | 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 |
sdTitle | ans..20 | O | Title of the customer on the invoice, e.g. Dr. or Prof. | Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof. |
sdFirstName | ans..50 | C | Obligatory, if UseBillingData=No: First name of customer or contact person in company | Pflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma |
sdLastName | ans..50 | C | Obligatory, if UseBillingData=No: Last name of customer or contact person in company | Pflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma |
sdStreet | a..50 | C | Obligatory, if UseBillingData=No: Street in the delivery address | Pflicht, wenn UseBillingData=No: Straßenname der Lieferadresse |
sdStreetNr | ans..5 | C | Obligatory, if UseBillingData=No: Street number of the delivery address | Pflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse |
sdStreet2 | a..50 | O | Address addition in the delivery address | Adresszusatz der Lieferadresse |
sdZip | n5 | C | Obligatory, if UseBillingData=No: Postcode in the delivery address | Pflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse |
sdCity | ans..50 | C | Obligatory, if UseBillingData=No: Town/city of the delivery address | Pflicht, wenn UseBillingData=No: Ort der Lieferadresse |
sdCountryCode | a3 | C | Obligatory, 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). |
sdPhone | ans..15 | O | Telephone number of the customer in the delivery address | Telefonnummer des Kunden in der Lieferanschrift |
sdMobileNo | ans..50 | O | Mobile telephone number of the customer in the delivery address | Handy-Nummer des Kunden in der Lieferanschrift |
Company data | Firmendaten | |||
CompanyName | ans..200 | C | Company name. Obligatory if CompanyOrPerson=F | Firmenname. Pflicht, falls CompanyOrPerson=F |
LegalForm | a..12 | C | 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>. |
RegisterNumber | ans..20 | C | 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 |
HolderName | ans..100 | C | 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 |
TaxNumber | ans..20 | C | 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 data | Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | Customer’s shopping cart with the following article data: - Article no., ans..20 • 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 Note on the structure of the article list: <;> separates the fields of an article data set 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 • 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 Hinweis zum Aufbau der Artikelliste: <;> trennt die Felder eines Artikeldatensatzes 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 +… |
OrderDesc | ans..768 | M | Customer’s complete shopping cart including order, fees and discount with the following data: - Shipping name (name of shipping method), ans..50 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 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 |
OrderHistory | ans..768 | O | Customer’s order history/order information from the last 20 orders with the following information: - Historical order number., ans..20 <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: Note on the structure of the OrderHistory: <;> separates the fields of an article data set 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 <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: Hinweis zum Aufbau der OrderHistory: <;> trennt die Felder eines Artikeldatensatzes max. 20 Datensätze dürfen übergeben werden Beispiel: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+… |
CustomerClassification | n1 | O | 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 |
Limit | n..12 | OC | Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro. If CustomerClassification=0 If CustomerClassification=1 Rule Limit 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 Wenn CustomerClassification=1 Regel Limit Beispiel: Zahlungserfahrung 180 Euro in 2 Käufen: Limit = 180*200 = 36000 |
Bank data | Bankdaten | |||
AccOwner | ans..50 | M | First name and surname of the account holder (purchaser) | Vor- und Zuname des Kontoinhabers (Käufers) |
IBAN | ans..34 | M | Customer's IBAN | IBAN des Kunden |
BIC | an..11 | M | Customer’s BIC | BIC des Kunden |
in case of BillPay hire purchase | bei Billpay-Ratenkauf | |||
BpBaseAmount | n..7 | M | Re financing gross amount (total price + interest + transaction fee) | Zu finanzierender Bruttobetrag (Gesamtpreis + Zinsaufschlag + Transaktionsgebühr) |
BpRateCount | n..2 | M | 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. |
URLBack | ans..256 | M | 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
| 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
|
URLNotify | ans..256 | MC | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro hinterlegt ist: URL, die das The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro 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 data | Reisedaten | |||
TripData | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data: - Number of trips already posted, n..3 Hints on structure of parameter TripData: Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Reiseinformationen des Kunden mit folgenden Daten: - Anzahl bereits gebuchter Reisen, n..3 Hinweise zum Aufbau des Parameters TripData: Beispiel: |
TravelerList | ans..768 | OC | Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data: - Salutation, a.. • 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: A complete data record must be transferred per traveller. Example: | Pflicht, wenn ArticleList/ArticleType 1-3: Liste der Reisenden mit folgenden Daten: - Anrede, a.. • 1: Mitglied in einem Vielfliegerprogramm • 2: Kein Mitglied in einem Vielfliegerprogramm - MitgliedsID im Vielfliegerprogramm, ans..50 (Standard: 0) Hinweise zum Aufbau des Parameters TravelerList: Pro Reisendem muss ein kompletter Datensatz übergeben werden. Beispiel: |
Parameters for PayLater via BillPay
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
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 |
---|---|---|---|
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Key | Format | CND | Description |
---|---|---|---|
Code | n8 | M | Error code according to Response Codes (A4 Response codes) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..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. |
BpStatus | a..8 | M | Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED>, <PRE_APPROVED> (in case of a necessary down payment) or <NOSTATUS> if errors occurred | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED>, <PRE_APPROVED> (im Falle einer nötigen Anzahlung) oder bei Fehlern <NOSTATUS> |
BpTransactionID | ans..50 | O | BillPay transaction number Notice: BpTransactionID is returned only if BpStatus=APPROVED | BillPay-Transaktionsnummer Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED |
Response from PayLater | Antwort von PayLater | |||
BpConditionsList | ans..768 | C | 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 <;>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 <;> trennt Felder innerhalb eines Finanzierungsdatensatzes Beispiel: <num_inst>;<duration>;<fee_percent>;<fee_total>;<pre_payment>;<total_amount>;<eff_anual>;<nominal> |
BpPaymentPlan | ans..768 | C | 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 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 Beispiel: „instl1“; „date1“; „type1“+ „instl2“; „date2“; „type2“ + „instl3“… |
PrePayment | n..12 | C | Is returned only if BpStatus=PRE_APPROVED Amount of prepayment to be payed by the customer | Wird nur zurückgegeben, wenn BpStatus=PRE_APPROVED: Vom Kunden zu leistender Anzahlungsbetrag |
BpLink1 | ans..768 | C | Is 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. |
BpLink2 | ans..768 | C | Is 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. |
Campaign | ans..768 | C | 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 data | Korrigierte Adressdaten | |||
Street | ans..50 | O | Corrected street of customer | Korrigierte Straße des Kunden |
StreetNr | ans..5 | O | Corrected street number of customer | Korrigierte Hausnummer des Kunden |
Zip | ans..5 | O | Corrected postcode of customer | Korrigierte PLZ des Kunden |
City | ans..50 | O | Corrected town/city of customer | Korrigierter Wohnort des Kunden |
Country | a3 | O | Customer’s corrected country code according to ISO3166 alpha-3 | Korrigierter Ländercode des Kunden nach ISO3166 alpha-3 |
Response in case of error | Antwort bei Fehlern | |||
ErrorText1 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText2 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText3 | n..6 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
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:
The following tables describe the transfer parameters and return values which are exchanged via the socket connection.
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by . Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro abgestimmt werden! Für Kunden von EVO Payments International: Pflichtfeld für eindeutige Nummer. Die RefNr aktualisiert, wenn beim Aufruf eine andere RefNr als bei der Reservierung übergeben wird. |
Key | Format | CND | Description |
---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit). |
Key | Format | CND | Description |
---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: Currency table |
Key | Format | CND | Description |
---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
---|---|---|---|
ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
InvoiceNr | ans..30 | C | Only for BillPay partial activation: unique invoice number | Nur bei BillPay-Teilaktivierung: eindeutige Rechnungsnummer |
Delay | n..3 | O | Number of days to delay the due date | Anzahl der Tage, um die das Zahlungsziel verschoben wird |
ArticleList | ans..768 | M | BillPay partial activation only: Customer’s shopping cart with the following article data: - Article no., ans..20 Note on the structure of the article list: <;> separates the fields of an article data set 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 Hinweis zum Aufbau der Artikelliste: <;> trennt die Felder eines Artikeldatensatzes Jeder Artikel wird als kompletter Artikeldatensatz übergeben: articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+ articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+… |
OrderDesc | ans..768 | M | 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 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 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 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 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
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Key | Format | CND | Description |
---|---|---|---|
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Key | Format | CND | Description |
---|---|---|---|
Code | n8 | M | Error code according to Response Codes (A4 Response codes) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..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. |
InvoiceStatus | a..10 | M | Status 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“ |
InvoiceNr | ans..30 | C | BillPay partial activation only: Unique invoice number for partial activation | Nur bei BillPay-Teilaktivierung: Eindeutige Rechnungsnummer für Teilaktivierung |
BillPay bank account | BillPay Bankverbindung | |||
BpAccOwner | ans..255 | M | Account holder for the receivables (usually “BillPay GmbH”) | Kontoinhaber für die Forderung (i.d.R. „BillPay GmbH“) |
IBAN | ans..34 | M | BillPay-IBAN for the receivables (can vary per order!) | BillPay-IBAN für die Forderung (kann pro Bestellung variieren!) |
BIC | an..11 | M | BillPay-BIC for the receivables | BillPay-BIC für die Forderung |
BpBank | ans..255 | M | Name of the bank for the receivables | Name der Bank für die Forderung |
BpInvoiceRef | ans..255 | M | Purpose | Verwendungszweck |
BpInvoiceDate | n8 | M | Customer's due date | Zahlungsziel des Kunden |
in case if BillPay hire purchase | bei BillPay-Ratenkauf | |||
BpPaymentPlan | ans..768 | M | Instalment plan selected by the buyer with information - RateNr: number of the instalment <;>separates fields within a data record Example: <Rate1>;<RateAmount>;<DueDate>+ <Rate_n>;<RateAmount_n>;<DueDate_n>+ etc. | Vom Käufer gewählter Ratenplan mit den Angaben - RateNr: Nummer der Rate <;> trennt Felder innerhalb eines Datensatzes Beispiel: <Rate1>;<RateAmount>;<DueDate> + <Rate_n>;<RateAmount_n>;<DueDate_n> +… |
BillPay Response in case of error | BillPay-Antwort bei Fehlern | |||
ErrorText1 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText2 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText3 | n..6 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
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:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by . Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit). |
Key | Format | CND | Description |
---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: Currency table |
Key | Format | CND | Description |
---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
---|---|---|---|
ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
NetRebate | n..7 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro stellen. |
GrRebate | n..7 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro stellen. |
shRebate | n..7 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro stellen. |
shRebateGr | n..7 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro stellen. |
ArticleList | ans..768 | O | 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: 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: Beispiel: articleid;articlequantity+ articleid;articlequantity+… Hinweis: Dieser Parameter wird nur bei einer Teilstornierung ausgewertet. |
Reason | a11 | O | 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
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description |
---|---|---|---|
ans..30 | M | MerchantID, assigned by |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
---|---|---|---|
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Key | Format | CND | Description |
---|---|---|---|
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Key | Format | CND | Description |
---|---|---|---|
Code | n8 | M | Error code according to Response Codes (A4 Response codes) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..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 purchase | Antwort bei Teilstornierung bei Ratenkauf | |||
BpConditionsList | ans.. | C | New calculated data for hire purchase after partial reversal. - Number of monthly instalments “term”, n..7 All amounts in the smallest currency unit (e.g. EUR Cent) <;> separates fields of a hire purchase data record Example: <term>;<base>;<cart>; <surcharge>;<total>;<interest>;<anual>;<fee>+… | Neu berechnete Kalkulationsdaten für Ratenkauf bei Teilstornierung. - Anzahl Monatsraten „term“, n..7 Alle Beträge in kleinster Währungseinheit, z.B. EUR Cent. <;> trennt Felder eines Finanzierungsdatensatzes Beispiel: <term>;<base>;<cart>; <surcharge>;<total>;<interest>;<anual>;<fee>+… |
BpPaymentPlan | ans.. | C | New calculated rate plans for the financing. - RateNr: number of the instalment <;>separates fields within a data record 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 <;> trennt Felder innerhalb eines Datensatzes 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 error | Antwort bei Fehlern | |||
ErrorText1 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText2 | ans..255 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
ErrorText3 | n..6 | O | 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 The page DE:Wording was not found -- Please check/update the page name used in the MultiExcerpt-Include macro. |
Result parameters for reversals of BillPay payments
Batch processing via the interface
Basic information about using Batch files and about their structure you can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing a 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:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
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) | |
Reverse | 1.0 / 2.0 | Standard version without return of parameter Code | Standardversion 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>
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
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 |
---|---|---|---|
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , if you want to capture amounts <100 (smallest currency unit). |
Key | Format | CND | Description |
---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: Currency table |
Key | Format | CND | Description |
---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..30 | O | Unique reference number | Eindeutige Referenznummer |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for this transaction |
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>
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
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) |
Key | Format | CND | Description |
---|---|---|---|
PayID | an32 | M | ID assigned by for this transaction |
Key | Format | CND | Description |
---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Key | Format | CND | Description |
---|---|---|---|
Code | n8 | M | Error code according to Response Codes (A4 Response codes) |
Description of result parameters within the record for Batch files