Generische Parameter für alle XML Requests

Einige Parameter müssen für alle XML Requests als Pflichtparameter gesetzt werden, um z.B. die API Versionen zu kennzeichnen und sich als BillPay Partner zu authentifizieren.

Parameter Pflicht Format Beschreibung
mid + N...6 ID des Händlers
pid + N...6 ID des Portals
bpsecure + N...6 Hinterlegter Sicherheitscode für das Portal (muss als MD5-Hash übergeben werden)
api_version + AN..10 Version der Schnittstelle

Request

XML Header

<?xml version="1.0" encoding="UTF-8"?>
<data api_version="1.5.10">
<default_params mid="2" pid="3" bpsecure="0d48732f425b6df88c58244d6882369e" />
<!-- weitere, Request-spezifische Daten -->
</data>

Response

Generische Parameter für alle XML Responses

Mit jeder XML-Service-Response werden durch BillPay die folgenden Parameter zurückgegeben.

Parameter Pflicht Format Beschreibung
error_code + N...6 Fehlercode. Standardwert ist "0" (kein Fehler)
merchant_message - AN...255 Detaillierte Fehlernachricht für den Händler
customer_message - AN...255 Fehlernachricht für den Kunden

Hinweis: Im Produktivmodus sind jeweils die Fehlermeldungen für den Kunden im Frontend sichtbar anzuzeigen. Die Händlerfehlermeldung enthält in einigen Fällen detailliertere Ausgaben, die nicht für den Kunden bestimmt sind.

Bitte beachten Sie, dass sich API Fehlermeldungen für Kunden und Händler ändern bzw. das neue Fehlercodes und Fehlermeldungen jederzeit hinzugefügt werden können.

<?xml version="1.0" encoding="UTF-8"?>
<data api_version="1.5.10" customer_message="" merchant_message="" error_code="0">
</data>