Über BillPay
Allgemeines zu BillPay
Bei BillPay verschicken Sie als Händler die Rechnung mit dem Logo und der Kontoverbindung von BillPay. Der Dienstleister zahlt Ihnen den Rechnungsbetrag aus und kümmert sich anschließend um das komplette nachgelagerte Debitorenmanagement.
Weitere Informationen finden Sie auch auf der Webseite von BillPay (http://www.billpay.de).
Hinweis: Zur einfacheren Integration in den Shop des Händlers gibt es von BillPay ein Javascript-Widget zur Darstellung der BillPay-Zahlungsarten im Checkout-Prozess, das eingebunden werden muss. Eine Dokumentation des Widgets findet sich online auf der Webseite https://techdocs.billpay.de/de/An_Entwickler/JavaScript-Widget.html.
Diagramm zum Prozessablauf
BillPay Prozessablauf inklusive Zahlartensteuerung PreScore (oberhalb der mittleren Linie)
Paygate-Schnittstelle
Datenformate: a alphabetisch as alphabetisch mit Sonderzeichen n numerisch an alphanumerisch ans alphanumerisch mit Sonderzeichen ns numerisch mit Sonderzeichen bool Bool’scher Ausdruck (true oder false) 3 feste Länge mit 3 Stellen/Zeichen ..3 variable Länge mit maximal 3 Stellen/Zeichen enum Aufzählung erlaubter Werte dttm ISODateTime (JJJJ-MM-TTThh:mm:ss) Abkürzungen: CND Bedingung (condition) M Pflicht (mandatory) O optional C bedingt (conditional) Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.Definitionen
Format Beschreibung Abkürzung Beschreibung Kommentar Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist
Aufruf der Schnittstelle für BillPay-Rechnungskauf
Dieses Kapitel beschreibt, wie Sie eine BillPay-Zahlung initialisieren. Nach erfolgreicher Initialisierung können Sie BillPay-Zahlungen bei Lieferung buchen. Zusätzlich können Sie BillPay-Reservierungen teilweise aktivieren und so das Zahlungsziel für den Kunden setzen. Auch eine nachträgliche Änderung des Warenkorbs ist über dieselbe Schnittstelle möglich und hier im Anschluss beschrieben. Ebenso wird die Stornierung einer BillPay-Zahlung hier nachfolgend erklärt.
Um eine Zahlung mit BillPay über eine Server-zu-Server-Verbindung auszuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die zu verschlüsselnden Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
Amount | n..10 | M | Gesamtbetrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Nur EUR und CHF zulässig. |
MAC | an64 | O | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Language | a2 | M | Sprachkennzeichen nach ISO 639-1 (z.B. de für Deutsch) |
NewCustomer | ans..5 | M | Definiert, ob der Käufer ein Neukunde ist. Werte: <YES>, <NO>, <GUEST> |
BillPayAction | n1 | M | Definiert, welche Zahlungsart verwendet wird. Werte: <1> für Rechnungskauf |
GtcValue | a..3 | M | Definiert, ob der Kunde die AGB von BillPay bestätigt hat. Werte: <YES> oder <NO> |
DateOfBirth | an10 | MC | Geburtsdatum des Kunden im Format JJJJ-MM-TT (darf bei BillPay B2B nicht übergeben werden) |
IpAddr | ans15 | M | IP-Adresse des Kunden im Format IPv4 oder IPv6 |
ActivationDelay | n..3 | OC | Pflicht bei BillPayAction = 7, 8 oder 9 (Schuldbeitritt) Anzahl der Tage bis zur Wahrnehmung der Dienstleistung (z.B. Reiseantritt) |
CompanyOrPerson | a1 | OC | 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 zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget) |
Rechnungsdaten | |||
bdSalutation | a..15 | M | 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 | Titel des Kunden oder der Kontaktperson in der Firma auf der Rechnung, z.B. Dr. oder Prof. |
bdFirstName | ans..50 | M | Vorname des Kunden oder der Kontaktperson in der Firma |
bdLastName | ans..50 | M | Nachname des Kunden oder der Kontaktperson in der Firma |
bdStreet | a..50 | M | Straßenname der Rechnungsadresse |
bdStreetNr | ans..5 | M | Hausnummer der Rechnungsadresse |
bdStreet2 | a..50 | O | Adresszusatz der Rechnungsadresse |
bdZip | n5 | M | Postleitzahl der Rechnungsadresse |
bdCity | ans..50 | M | Ort der Rechnungsadresse |
bdCountryCode | a3 | M | Ländercode der Rechnungsadresse dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT). |
ans..50 | M | E-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift | |
Phone | ans..15 | OC | Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift. Bei Ratenkauf (BillPayAction=3) ist der Parameter Pflicht. |
MobileNo | ans..50 | O | Handy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift |
Lieferdaten | |||
UseBillingData | a3 | M | 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 | 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 | Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof. |
sdFirstName | ans..50 | C | Pflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma |
sdLastName | ans..50 | C | Pflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma |
sdStreet | a..50 | C | Pflicht, wenn UseBillingData=No: Straßenname der Lieferadresse |
sdStreetNr | ans..5 | C | Pflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse |
sdStreet2 | a..50 | O | Adresszusatz der Lieferadresse |
sdZip | n5 | C | Pflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse |
sdCity | ans..50 | C | Pflicht, wenn UseBillingData=No: Ort der Lieferadresse |
sdCountryCode | a3 | C | Pflicht, wenn UseBillingData=No: Ländercode der Lieferanschrift dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT). |
sdPhone | ans..15 | O | Telefonnummer des Kunden in der Lieferanschrift |
sdMobileNo | ans..50 | O | Handy-Nummer des Kunden in der Lieferanschrift |
Firmendaten | |||
CompanyName | ans..200 | C | Firmenname. Pflicht, falls CompanyOrPerson=F |
LegalForm | a..12 | C | 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 | Handelsregisternummer/Firmenbuch Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft |
HolderName | ans..100 | C | Optional: Name des Firmeninhabers Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft |
TaxNumber | ans..20 | C | Umsatzsteueridentifikationsnummer Hinweis: Die Angabe der USt-ID erhöht die Trefferwahrscheinlichkeit |
Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | 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 | 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 | 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 | 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 | 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 |
Bankdaten | |||
AccOwner | ans..50 | M | Vor- und Zuname des Kontoinhabers (Käufers) Hinweis: Pflichtparameter, wenn BillPayAction=2 (ELV) oder 3 (Ratenzahlung) |
IBAN | ans..34 | M | IBAN des Kunden Hinweis: Pflichtparameter, wenn BillPayAction=2 (ELV) oder 3 (Ratenzahlung) |
BIC | an..11 | OC | BIC des Kunden Hinweis: Pflichtparameter, wenn BillPayAction=2 (ELV) oder 3 (Ratenzahlung) |
bei BillPay-Ratenkauf | |||
BpBaseAmount | n..7 | C | 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 | 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 |
Reisedaten | |||
TripData | ans..768 | OC | 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 | 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: |
Parameter für BillPay-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihr System zurückgibt:
Parameter | Format | CND | Beschreibung | |
---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird | |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien | |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..64 | M | Transaktionsnummer des Händlers | |
Status | a..50 | M | OK oder FAILED | |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
RefNr | ans..30 | O | Eindeutige Referenznummer für die Buchhaltung | |
BpTransactionID | ans..50 | C | BillPay-Transaktionsnummer Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED | |
BpStatus | a..8 | M | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS> | |
korrigierte Adressdaten | ||||
Street | ans..50 | O | korrigierte Straße des Kunden | |
StreetNr | ans..5 | O | korrigierte Hausnummer des Kunden | |
Zip | ans..5 | O | korrigierte PLZ des Kunden | |
City | ans..50 | O | korrigierter Wohnort des Kunden | |
Country | a3 | O | korrigierter Ländercode des Kunden nach ISO3166 alpha-3 | |
virtuelle BillPay-Bankverbindung | ||||
BpAccOwner | ans..255 | C | Kontoinhaber für die Forderung (i.d.R. „BillPay GmbH“) Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED | |
IBAN | ans..34 | C | BillPay-IBAN für die Forderung Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED | |
BIC | an..11 | C | BillPay-BIC für die Forderung Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED | |
BpBank | ans..255 | C | Name der Bank für die Forderung Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED | |
BpInvoiceRef | ans..255 | C | Verwendungszweck (enthält RefNr) Hinweis: wird nur zurückgegeben, wenn BpStatus=APPROVED | |
Rückgabe bei Ratenkauf | ||||
BpConditionsList | ans..768 | M | 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-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 | zu zeigender Link zu BillPay-AGBs für Ratenkauf | |
BpLink2 | ans..768 | M | zu zeigender Link zu Datenschutzbestimmungen von BillPay | |
BpLink3 | ans..768 | M | zu zeigender Link zu BillPay-Zahlungsbedingungen | |
BpInfo1 | ans.. | MC | 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-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. | |
Rückgabe im Fehlerfall | ||||
ErrorText1 | ans..255 | O | 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 Computop Support. | |
ErrorText2 | ans..255 | O | 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 Computop Support. | |
ErrorText3 | n..6 | O | 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 Computop Support. | |
ValidationErrors | ans..1024 | O | bei einem oder mehreren Validierungsfehlern mit folgenden Daten: - Fehlerfeld <;> trennt Felder in einem Validierungsfehler Beispiel: <Fehlerfeld>;<Fehlercode>;<Fehlernachricht Kunde>;<Fehlernachricht Händler>+ … |
Antwort-Parameter für BillPay-Zahlungen
Nachträgliche Warenkorbänderung
Der Inhalt eines Warenkorbs kann nachträglich bei Retouren oder zusätzlichen Artikeln noch geändert werden. Dabei wird der alte Warenkorb komplett ersetzt, Adresse, Referenznummern, Währung, Zahlart und Ratenanzahl bleiben jedoch erhalten. Bei gleichem oder geringerem Warenkorbwert wird die Änderung stets akzeptiert. Bei einer Erhöhung des Bestellwertes wird eine erneute Autorisierung versucht. Nur im Erfolgsfall gilt dann der neue Warenkorb, sonst bleibt der bisherige bestehen. Bei einer Warenkorbänderung einer bereits aktivierten Bestellung informiert BillPay den Kunden über den geänderten Forderungsbetrag.
Um den zugehörigen Warenkorb einer mit BillPay zuvor initialisierten Zahlung zu ändern, rufen Sie folgende URL auf:
Die folgende Tabelle beschreibt die zu verschlüsselnden Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
Amount | n..10 | M | Gesamtbetrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | 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 | 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 | Abkürzung der auszuführenden Aktion: Derzeit nur CO (Change order) möglich |
Parameter für nachträgliche Warenkorbänderung bei BillPay-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort sendet:
Parameter | Format | CND | Beschreibung | |
---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird | |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien | |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..64 | M | Transaktionsnummer des Händlers | |
Status | a..30 | M | OK oder FAILED | |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
RefNr | ans..30 | O | Eindeutige Referenznummer für die Buchhaltung. Wird nur zurückgegeben, wenn bereits eine RefNr zugeordnet war. | |
BrTransactionID | ans..50 | M | BillPay-Transaktionsnummer | |
BpStatus | a..8 | M | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS> | |
Rückgabe bei Ratenkauf | ||||
BpConditionsList | ans..768 | M | 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 | 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. | |
Rückgabe im Fehlerfall | ||||
ErrorText1 | ans..255 | O | ErrorText1 enthält die detaillierte Fehlernachricht von BillPay. Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den Computop Support. | |
ErrorText2 | ans..255 | O | 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 Computop Support. | |
ErrorText3 | n..6 | O | 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 Computop Support. |
Ergebnis-Parameter für BillPay-Zahlungen
BillPay mit Zahlartensteuerung (PreScore)
Mit der Zahlartensteuerung von BillPay können Onlinehändler in ihrem Onlineshop eine Vorauswahl der BillPay-Zahlarten treffen, die einem bestimmten Kunden angezeigt werden. So sieht der Kunde nur die für ihn zulässigen Zahlarten, wodurch die Konversionsrate steigt. Für die Zahlartensteuerung muss die Prüfung des Endkunden auf Identität und Bonität bereits vor Auswahl der Zahlart erfolgen. Die BillPay-Zahlartensteuerung ist damit eine Alternative zur Prüfung der Endkundenanfrage nach Auswahl einer Zahlungsart. Ein Händlerportal bei BillPay kann entweder mit Zahlartensteuerung oder ohne Zahlartensteuerung arbeiten, aber nicht beides zur gleichen Zeit.
Zur Nutzung der Zahlartensteuerung muss der Händler einen entsprechenden Vertrag mit BillPay haben und dafür freigeschaltet sein. Für diesen Ablauf teilt sich der BillPay-Vorgang in die vorangestellte Zahlartensteuerung (PreScore) sowie die folgende Anlage der BillPay-Zahlung, die jetzt mit weniger Aufrufparametern auskommt. Die Antwort auf die Reservierung entspricht wieder dem oben erklärten normalen Ablauf.
Um die Zahlartensteuerung von BillPay über eine Server-zu-Server-Verbindung auszuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
Amount | n..10 | M | Gesamtbetrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217 |
MAC | an64 | O | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate den Parameter mit dem Zahlungsergebnis an den Shop. |
EventToken | a2 | M | Token für den Aufruf des Requests: <PS> für PreScore |
Language | a2 | M | Sprachkennzeichen nach ISO 639-1 (z.B. de für Deutsch) |
NewCustomer | ans..5 | M | Definiert, ob der Käufer ein Neukunde ist. Werte: <YES>, <NO>, <GUEST> |
IpAddr | ans15 | M | IP-Adresse des Kunden im Format IPv4 oder IPv6 |
CompanyOrPerson | a1 | OC | Unterscheidung des Käufers nach Privatperson oder Firma. Werte: <F> für Firmen, <P> für Personen, Standardwert <P>. Pflicht bei BillPay B2B |
DateOfBirth | an10 | OC | Geburtsdatum des Kunden im Format JJJJ-MM-TT (darf bei BillPay B2B nicht übergeben werden) |
BrowserSessionID | ans..100 | O | SessionID zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget) |
Rechnungsdaten | |||
bdSalutation | a..15 | M | 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 | Titel des Kunden oder der Kontaktperson in der Firma auf der Rechnung, z.B. Dr. oder Prof. |
bdFirstName | ans..50 | M | Vorname des Kunden oder der Kontaktperson in der Firma |
bdLastName | ans..50 | M | Nachname des Kunden oder der Kontaktperson in der Firma |
bdStreet | a..50 | M | Straßenname der Rechnungsadresse |
bdStreetNr | ans..5 | M | Hausnummer der Rechnungsadresse |
bdStreet2 | a..50 | O | Adresszusatz der Rechnungsadresse |
bdZip | n5 | M | Postleitzahl der Rechnungsadresse |
bdCity | ans..50 | M | Ort der Rechnungsadresse |
bdCountryCode | a3 | M | Ländercode der Rechnungsadresse dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT). |
ans..50 | M | E-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift | |
Phone | ans..15 | O | Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift. |
MobileNo | ans..50 | O | Handy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift |
Lieferdaten | |||
UseBillingData | a3 | M | 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 | 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 | Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof. |
sdFirstName | ans..50 | C | Pflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma |
sdLastName | ans..50 | C | Pflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma |
sdStreet | a..50 | C | Pflicht, wenn UseBillingData=No: Straßenname der Lieferadresse |
sdStreetNr | ans..5 | C | Pflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse |
sdStreet2 | a..50 | O | Adresszusatz der Lieferadresse |
sdZip | n5 | C | Pflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse |
sdCity | ans..50 | C | Pflicht, wenn UseBillingData=No: Ort der Lieferadresse |
sdCountryCode | a3 | C | Pflicht, wenn UseBillingData=No: Ländercode der Lieferanschrift dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT). |
sdPhone | ans..15 | O | Telefonnummer des Kunden in der Lieferanschrift |
sdMobileNo | ans..50 | O | Handy-Nummer des Kunden in der Lieferanschrift |
Firmendaten | |||
CompanyName | ans..200 | C | Firmenname. Pflicht, falls CompanyOrPerson=F |
LegalForm | a..12 | C | 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 | Handelsregisternummer/Firmenbuch Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft |
HolderName | ans..100 | C | Optional: Name des Firmeninhabers Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft |
TaxNumber | ans..20 | C | Umsatzsteueridentifikationsnummer Hinweis: Die Angabe der USt-ID erhöht die Trefferwahrscheinlichkeit |
Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | 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 | 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 | 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 | 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 | 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 |
Reisedaten | |||
TripData | ans..768 | OC | 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 | 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: |
Parameter für BillPay-Zahlartensteuerung (PreScore)
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für die einzelne Transaktion der Zahlung |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | AUTHORIZE_REQUEST oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Referenznummer des Händlers. Im Falle einer Aktualisierung der RefNr bekommt Händler die neue RefNr zurück. |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate den Parameter mit dem Zahlungsergebnis an den Shop. |
BillPay-Antwort | |||
BpStatus | a..8 | M | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED> oder bei Fehlern <NOSTATUS> |
BpTransactionID | ans..50 | O | BillPay-Transaktionsnummer Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED |
Street | ans..50 | O | Korrigierte Straße des Kunden |
StreetNr | ans..15 | O | Korrigierte Hausnummer des Kunden |
Zip | ans..5 | O | Korrigierte PLZ des Kunden |
City | ans..50 | O | Korrigierter Ort des Kunden |
Country | a3 | O | Korrigierter Ländercode des Kunden nach ISO3166 alpha-3 |
BrowserSessionID | ans..100 | O | SessionID zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget) |
AllowedPayMethods | ans..768 | OC | 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 | Wird im Falle eines oder mehrerer Validierungsfehler zurückgeliefert. Enthält folgende Daten: - Fehlerfeld Beispiel: <Fehlerfeld>;<Fehlercode>;<Fehlernachricht Kunde>;<Fehlernachricht Händler>+ … |
BillPay-Antwort bei Fehlern | |||
ErrorText1 | ans..255 | O | 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 ist. Bitte kontaktieren Sie dazu den Computop Support. |
ErrorText2 | ans..255 | O | 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 Computop Support. |
ErrorText3 | n..6 | O | 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 Computop Support. |
Antwort-Parameter für BillPay-Zahlartensteuerung
Zum Anlagen und Reservieren der Zahlung sind im zweiten Aufruf je nach Zahlart nur noch wenige zusätzliche Parameter erforderlich.
Hinweis: Sobald der Kunde seine personenbezogenen Daten oder den Warenkorb ändert, muss die Zahlartensteuerung erneut gesendet werden. Die vorher ausgeführte Zahlartensteuerung ist nicht mehr gültig.
Um die BillPay-Zahlung über eine Server-zu-Server-Verbindung anzulegen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung von Batch-Dateien |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
MAC | an64 | O | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate den Parameter mit dem Zahlungsergebnis an den Shop. |
BillPayAction | n1 | M | 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 | Pflicht bei BillPayAction = 7, 8 oder 9 (Schuldbeitritt) Anzahl der Tage bis zur Wahrnehmung der Dienstleistung (z.B. Reiseantritt) |
DateOfBirth | an10 | OC | Pflicht, falls noch nicht in der Zahlartensteuerungs-Anfrage übermittelt: Geburtsdatum des Kunden im Format JJJJ-MM-TT (darf bei BillPay B2B nicht übergeben werden) |
GtcValue | a..3 | M | Definiert, ob der Kunde die AGB von BillPay bestätigt hat. Werte: <YES> oder <NO> |
AccOwner | ans..50 | OC | Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater): Vor- und Zuname des Kontoinhabers (Käufer) |
IBAN | ans..34 | OC | Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater): IBAN des Kunden |
BIC | an..11 | OC | Pflicht, wenn BillPayAction=2 (Lastschrift) oder 4 (PayLater): BIC des Kunden |
BpBaseAmount | n..7 | OC | Pflicht, wenn BillPayAction=4 (PayLater): zu finanzierender Bruttobetrag (Gesamtpreis + Zinsaufschlag + Transaktionsgebühr) Die Werte kommen aus dem BillPay JavaScript-Snippet. |
BpRateCount | n..2 | OC | 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 | 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 | Pflicht, wenn BillPayAction=4 (PayLater) und keine URLNotify für PayLater bei Computop hinterlegt ist: URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData. Die URL wird nur aufgerufen, wenn der Kunde zum Anzahlungsgateway weitergeleitet wurde, da in diesem Fall die Antwort vom Gateway zeitverzögert gesendet wird. |
Reisedaten | |||
TripData | ans..768 | OC | 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 | 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: |
Parameter für BillPay-Zahlung nach Zahlartensteuerung
Die Antwort-Parameter entsprechen nun dem oben erläuterten allgemeinen Ablauf.
PayLater über BillPay
Dieses Kapitel beschreibt, wie Sie eine PayLater-Zahlung über BillPay abwickeln. PayLater ist eine Erweiterung der BillPay-Anbindung. Weitere Funktionen und allgemeine Parameter sind in der allgemeinen BillPay-Dokumentation beschrieben.
Um PayLater-Zahlung über BillPay durchzuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
Amount | n..10 | M | Gesamtbetrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217 |
MAC | an64 | O | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Language | a2 | M | Sprachkennzeichen nach ISO 639-1 (z.B. de für Deutsch) |
NewCustomer | ans..5 | M | Definiert, ob der Käufer ein Neukunde ist. Werte: <YES>, <NO>, <GUEST> |
BillPayAction | n1 | M | Definiert, welche Zahlungsart verwendet wird. Werte: <1> für Rechnungskauf |
GtcValue | a..3 | M | Definiert, ob der Kunde die AGB von BillPay bestätigt hat. Werte: <YES> oder <NO> |
DateOfBirth | an10 | OC | Geburtsdatum des Kunden im Format JJJJ-MM-TT (Pflicht, wenn CompanyOrPerson=F) |
IpAddr | ans15 | M | IP-Adresse des Kunden im Format IPv4 oder IPv6 |
ActivationDelay | n..3 | OC | Pflicht bei BillPayAction = 7, 8 oder 9 (Schuldbeitritt) Anzahl der Tage bis zur Wahrnehmung der Dienstleistung (z.B. Reiseantritt) |
CompanyOrPerson | a1 | OC | 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 zur Betrugsidentifizierung (muss gleich sein mit der SessionID aus dem JavaScript-Widget) |
Rechnungsdaten | |||
bdSalutation | a..15 | OC | 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 | Titel des Kunden oder der Kontaktperson in der Firma auf der Rechnung, z.B. Dr. oder Prof. |
bdFirstName | ans..50 | M | Vorname des Kunden oder der Kontaktperson in der Firma |
bdLastName | ans..50 | M | Nachname des Kunden oder der Kontaktperson in der Firma |
bdStreet | a..50 | M | Straßenname der Rechnungsadresse |
bdStreetNr | ans..5 | M | Hausnummer der Rechnungsadresse |
bdStreet2 | a..50 | O | Adresszusatz der Rechnungsadresse |
bdZip | n5 | M | Postleitzahl der Rechnungsadresse |
bdCity | ans..50 | M | Ort der Rechnungsadresse |
bdCountryCode | a3 | M | Ländercode der Rechnungsadresse dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT). |
ans..50 | M | E-Mail-Adresse des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift | |
Phone | ans..15 | M | Telefonnummer des Kunden oder der Kontaktperson in der Firma in der Rechnungsanschrift. |
MobileNo | ans..50 | O | Handy-Nummer des Kunden oder der Kontaktperson in der Rechnungsanschrift |
Lieferdaten | |||
UseBillingData | a3 | M | 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 | 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 Pflicht, wenn UseBillingData=No |
sdTitle | ans..20 | O | Titel des Kunden auf der Rechnung, z.B. Dr. oder Prof. |
sdFirstName | ans..50 | OC | Pflicht, wenn UseBillingData=No: Vorname des Kunden oder der Kontaktperson in der Firma |
sdLastName | ans..50 | OC | Pflicht, wenn UseBillingData=No: Nachname des Kunden oder der Kontaktperson in der Firma |
sdStreet | a..50 | OC | Pflicht, wenn UseBillingData=No: Straßenname der Lieferadresse |
sdStreetNr | ans..5 | OC | Pflicht, wenn UseBillingData=No: Hausnummer der Lieferadresse |
sdStreet2 | a..50 | OO | Adresszusatz der Lieferadresse |
sdZip | n5 | OC | Pflicht, wenn UseBillingData=No: Postleitzahl der Lieferadresse |
sdCity | ans..50 | OC | Pflicht, wenn UseBillingData=No: Ort der Lieferadresse |
sdCountryCode | a3 | OC | Pflicht, wenn UseBillingData=No: Ländercode der Lieferanschrift dreistellig. Erlaubt sind derzeit Deutschland (DEU), Schweiz (CHE) und Österreich (AUT). |
sdPhone | ans..15 | O | Telefonnummer des Kunden in der Lieferanschrift |
sdMobileNo | ans..50 | O | Handy-Nummer des Kunden in der Lieferanschrift |
Firmendaten | |||
CompanyName | ans..200 | C | Pflicht, falls CompanyOrPerson=F: Firmenname |
LegalForm | a..12 | C | Pflicht, wenn CompanyOrPerson=F: Rechtsform des Unternehmens. 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 | Handelsregisternummer/Firmenbuch Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft |
HolderName | ans..100 | C | Name des Firmeninhabers Pflicht, wenn CompanyOrPerson=F und bestimmte Kombination von LegalForm und bdCountryCode zutrifft |
TaxNumber | ans..20 | C | Umsatzsteueridentifikationsnummer Hinweis: Die Angabe der USt-ID erhöht die Trefferwahrscheinlichkeit |
Artikel- und Bestelldaten | |||
ArticleList | ans..768 | M | 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 | 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 | 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 | 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 | 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 |
Bankdaten | |||
AccOwner | ans..50 | M | Vor- und Zuname des Kontoinhabers (Käufers) |
IBAN | ans..34 | M | IBAN des Kunden |
BIC | an..11 | M | BIC des Kunden |
bei Ratenkauf | |||
BpBaseAmount | n..7 | M | zu finanzierender Bruttobetrag (Gesamtpreis + Zinsaufschlag + Transaktionsgebühr) |
BpRateCount | n..2 | M | 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, 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 | Pflicht, wenn keine URLNotify für PayLater bei Computop hinterlegt ist: URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData. Die URL wird nur aufgerufen, wenn der Kunde zum Anzahlungsgateway weitergeleitet wurde, da in diesem Fall die Antwort vom Gateway zeitverzögert gesendet wird. |
Reisedaten | |||
TripData | ans..768 | OC | 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 | 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: |
Parameter für PayLater über BillPay
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für die einzelne Transaktion der Zahlung |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK, FAILED oder AUTHORIZE_REQUEST bei einer nötigen Anzahlung |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Referenznummer des Händlers. Im Falle einer Aktualisierung der RefNr bekommt Händler die neue RefNr zurück. |
BpTransactionID | ans..50 | M | BillPay-Transaktionsnummer Hinweis: BpTransactionID wird nur zurückgegeben, wenn BpStatus=APPROVED |
BpStatus | a..8 | M | Status der BillPay Identitäts- und Bonitätsprüfung. Werte: <APPROVED>, <DENIED>, <PRE_APPROVED> (im Falle einer nötigen Anzahlung) oder bei Fehlern <NOSTATUS> |
Antwort von PayLater | |||
BpConditionsList | ans..768 | C | 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 | 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 | wird nur zurückgegeben, wenn BpStatus=PRE_APPROVED: Vom Kunden zu leistender Anzahlungsbetrag |
BpLink1 | ans..768 | C | 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 | 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 | 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“ |
korrigierte Adressdaten | |||
Street | ans..50 | O | Korrigierte Straße des Kunden |
StreetNr | ans..15 | O | Korrigierte Hausnummer des Kunden |
Zip | ans..5 | O | Korrigierte PLZ des Kunden |
City | ans..50 | O | Korrigierter Ort des Kunden |
Country | a3 | O | Korrigierter Ländercode des Kunden nach ISO3166 alpha-3 |
Antwort bei Fehlern | |||
ErrorText1 | ans..255 | O | 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 ist. Bitte kontaktieren Sie dazu den Computop Support. |
ErrorText2 | ans..255 | O | 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 Computop Support. |
ErrorText3 | n..6 | O | 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 Computop Support. |
Antwort-Parameter für PayLater über BillPay
Buchung & Teilbuchung über Socket-Verbindung
Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Der Händler kann eine BillPay-Reservierung vollständig oder teilweise aktivieren und so das Zahlungsziel für den Kunden setzen. Übergibt der Händler dabei eine neue Referenznummer, so wird die Referenznummer der Reservierung erst aktualisiert und danach erfolgt die Aktivierung der Rechnung. Um eine Buchung (Capture) über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
Die folgenden Tabellen beschreiben die Übergabeparameter und Rückgabewerte, die über die Socket-Verbindung ausgetauscht werden.
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
TransID | ans..64 | M | Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217. Nur EUR und CHF zulässig. |
RefNr | ans..30 | M | Eindeutige Referenznummer, die auf Ihrer gedruckten Kartenabrechnung oder in der EPA-Datei (Electronic Payment Advice) erscheint. Das Format muss zuvor mit Computop 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. |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
InvoiceNr | ans..30 | C | Nur bei BillPay-Teilaktivierung: eindeutige Rechnungsnummer |
Delay | n..3 | O | Anzahl der Tage, um die das Zahlungsziel verschoben wird |
ArticleList | ans..768 | C | 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 | C | 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 |
Parameter für Buchung von BillPay-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für die einzelne Transaktion der Zahlung |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | M | Referenznummer des Händlers. Im Falle einer Aktualisierung der RefNr bekommt Händler die neue RefNr zurück. |
InvoiceStatus | a..10 | M | Status der Aktivierungsanfrage: zeigt an, ob Reservierung aktiviert wurde oder nicht. Rückgabewerte: „Activated“ oder „Not Active“ |
InvoiceNr | ans..30 | C | Nur bei BillPay-Teilaktivierung: Eindeutige Rechnungsnummer für Teilaktivierung |
BillPay Bankverbindung | |||
BpAccOwner | ans..255 | M | Kontoinhaber für die Forderung (i.d.R. „BillPay GmbH“) |
IBAN | ans..34 | M | BillPay-IBAN für die Forderung (kann pro Bestellung variieren!) |
BIC | an..11 | M | BillPay-BIC für die Forderung |
BpBank | ans..255 | M | Name der Bank für die Forderung |
BpInvoiceRef | ans..255 | M | Verwendungszweck |
BpInvoiceDate | n8 | M | Zahlungsziel des Kunden |
bei BillPay-Ratenkauf | |||
BpPaymentPlan | ans..768 | M | 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-Antwort bei Fehlern | |||
ErrorText1 | ans..255 | O | 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 ist. Bitte kontaktieren Sie dazu den Computop Support. |
ErrorText2 | ans..255 | O | 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 Computop Support. |
ErrorText3 | n..6 | O | 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 Computop Support. |
Antwort-Parameter für Buchung von BillPay-Zahlungen
Storno von BillPay-Zahlungen
Stornierungen sind über eine Server-zu-Server-Kommunikation möglich. Bei BillPay können sowohl Reservierungen als auch Aktivierungen storniert werden, wobei zwischen Voll- und Teilstornierungen zu unterscheiden ist. Um eine BillPay-Zahlung zu stornieren, verwenden Sie bitte die folgende URL:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgenden Tabellen beschreiben die Übergabeparameter und Rückgabewerte, die über die Socket-Verbindung ausgetauscht werden:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die zu stornierende Transaktion |
TransID | ans..64 | M | ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a..3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217. Nur EUR und CHF zulässig. |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
NetRebate | n..7 | O | 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 Paygate stellen. |
GrRebate | n..7 | O | 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 Paygate stellen. |
shRebate | n..7 | O | 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 Paygate stellen. |
shRebateGr | n..7 | O | 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 Paygate stellen. |
ArticleList | ans..768 | O | 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 | gibt an, dass sich Stornierung auf noch nicht aktivierte Artikel bezieht. Nur nötig nach Teilaktivierung. Reason=RESERVATION |
Parameter für Storno von BillPay-Zahlungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung | |
---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird | |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien | |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..64 | M | Transaktionsnummer des Händlers | |
Status | a..30 | M | OK oder FAILED | |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
RefNr | ans..30 | M | Eindeutige Referenznummer. Bei Aktualisierung der Referenznummer erhält der Händler die neue RefNr zurück. | |
Antwort bei Teilstornierung bei Ratenkauf | ||||
BpConditionsList | ans.. | C | 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 | 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! | |
Antwort im Fehlerfall | ||||
ErrorText1 | ans..255 | O | ErrorText1 enthält die detaillierte Fehlernachricht von BillPay. Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den Computop Support. | |
ErrorText2 | ans..255 | O | ErrorText2 enthält die detaillierte Fehlernachricht von BillPay. Hinweis: Wird im Fehlerfall zusätzlich an den Händler zurückgegeben, wenn dies entsprechend konfiguriert wurde. Bitte kontaktieren Sie dazu den Computop Support. | |
ErrorText3 | n6 | O | 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 Computop Support. |
Ergebnis-Parameter für Storno von BillPay-Zahlungen
Batch-Nutzung der Schnittstelle
Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.
Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer BillPay-Zahlung übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.
Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:
Aktion | Version | Beschreibung |
---|---|---|
Capture | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
Reverse | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2x. | mit RefNr (gilt für alle Versionen außer 1.0) |
Beschreibung der möglichen Batch-Versionen
Der Aufbau für eine BillPay-Zahlung in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> BillPay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> BillPay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount> |
Beispiel für Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Type | a..11 | M | HEAD für Header, FOOT für Footer, BillPay für BillPay |
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Reverse (Storno) |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | O | eindeutige Referenznummer |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
Beschreibung der Felder im Datensatz von Batch-Dateien
Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> BillPay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> BillPay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter, werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung), Reverse (Storno) |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
Status | a..50 | M | OK oder FAILED |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien