BillPay TechDocs

An Entwickler Einleitung

Thursday, September 7, 2017 6:16 AM

XML Schnittstelle

Jeder XML-Service-Request besteht aus einem XML-Dokument, welches mittels HTTP POST-Request an eine für den jeweiligen Request eindeutige Service-URL gesendet werden muss. Als Antwort auf einen XML-Service-Request liefert die XML-Schnittstelle eine XML-Service-Response. Jede XML-Service-Response besteht wiederum aus einem XML-Dokument, welches immer mindestens einen Fehlercode und Fehlermeldungen für Händler und Kunden beinhaltet. Nur wenn eine XML-Service-Response mit dem Fehlercode „0“ vorliegt, kann die Aktion als gültig betrachtet werden. Andernfalls liefert die XML-Schnittstelle detaillierte Fehlermeldungen zurück.

Die übergebenen XML-Daten an die XML-Schnittstelle müssen als UTF-8 codiert sein. Ebenso werden die XML-Antworten in UTF-8 codiert zurückgegeben.

Das Schema der XML-Service-Requests beruht auf der extensiven Nutzung von XML-Attributen. Bitte vergewissern Sie sich, dass reservierte Zeichen in den Attributwerten entsprechend des XML-Standards durch Escape-Sequenzen ersetzt werden:

Reserviertes Zeichen Escape-Sequenz
& &
" "
' '
< &lt;
> &gt;

Webservice URL

Jede URL für einen der XML-Services wird aus einer Basis-URL gefolgt von einem Bezeichner für den jeweiligen Service gebildet.

Basis URLs

Achtung: Die XML-Schnittstelle funktioniert nur über das HTTPS Protokoll. Anfragen über HTTP werden nicht akzeptiert.

Übersicht: Frontend XML-Service-Requests

"Klassisches Scoring"

XML-Service Bedeutung Zeitpunkt des Aufrufs Service-URL Pflicht Backoffice Rückgabe
Autorisierung Prüfung des Kunden auf Identität bzw. Bonität Bestellprozess; nach der Auswahl der Zahlungsart [Basis-URL]/preauthorize Ja Nein Status der Prüfung und ggf. korrigierte Adresse

"Aktive Zahlartensteuerung"

XML-Service Bedeutung Zeitpunkt des Aufrufs Service-URL Pflicht Backoffice Rückgabe
Vorautorisierung (aktive Steuerung der Zahlarten) Prüfung des Kunden auf Identität bzw. Bonität Bestellprozess; vor der Auswahl der Zahlungsart [Basis-URL]/prescore Ja Nein Für den Kunden autorisierte BillPay-Zahlungsarten
Autorisierung (Abschluss im Auto-Capture Modus) Prüfung des Kunden auf Identität bzw. Bonität Bestellprozess; nach der Auswahl der Zahlungsart [Basis-URL]/preauthorize Ja Nein Status der Prüfung und ggf. korrigierte Adresse

Übersicht: Backend XML-Service-Requests

XML-Service Bedeutung Zeitpunkt des Aufrufs Service-URL Pflicht Backoffice Rückgabe
Aktivierung Rechnung: Starten des Zahlungsziels (20 bzw. 30 Tage); Lastschrift/PayLater: Initiierung des Bankeinzugs Bei Erstellung der Rechnung. Wird i.d.R. im Backend durch eine Aktion oder einen Job ausgelöst. [Basis-URL]/invoiceCreated Ja JA Rechnung: BillPay-Kontodaten und Zahlungsziel als Zeitstempel; Lastschrift: -
Vollstornierung Stornierung der gesamten Bestellung Wird i.d.R. im Backend durch eine Aktion / einen Job ausgelöst. [Basis-URL]/cancel Nein Ja -
Warenkorbänderung Änderung des Warenkorbinhalts oder der Liefergebühren bzw. Rabatte der Bestellung Wird i.d.R. durch Gutschrift, Teilstornierung oder Änderung der Bestellung ausgelöst. [Basis-UrL]/editCartContent Nein Nein -
Aktualisierung Aktualisierung der Bestell-ID. Falls Erfassung vor Anlegen der Bestellung geschieht und die Bestell-ID zu diesem Zeitpunkt noch nicht feststeht. Bestellprozess; nach Anlegen der Bestellung im Shop [Basis-URL]/updateOrder Nein Nein -
BillPay Bankdaten abholen Nur Rechnungskauf Abholen der Bankverbindung von BillPay zur Anzeige auf der Rechnung Wird aus dem Backend heraus gesendet, falls das Abgreifen der Bankdaten von der Capture- oder InvoiceCreated-Response nicht möglich ist. [Basis-URL]/getBillPayBankData Nein Nein Bankverbindung von BillPay und Zahlungszeil für die Rechnung.
Geldeingang beim Händler Nur Rechnungskauf: Händler meldet BillPay, dass ein Kunde auf das Konto des Händlers überwiesen hat Aus dem Backend, falls Kunde auf das Konto des Händlers überweist. [Basis-URL]/reportCustomerPayment Nein Ja -