InvoiceCreated Request
Der "invoiceCreated"-Request wird genutzt um das Zahlungsziel des Kunden bei BillPay zu starten. (z.B. Rechnungskauf: 20 oder 30 Tage) Dieser Vorgang wird "Aktivierung der Forderung" genannt, und muss für jede Bestellung immer unmittelbar vor der Rechnungsstellung bzw. dem Versand der Ware abgesendet werden. Erst nach dem Erhalt einer fehlerfreien Antwort auf diesen Request stehen alle notwendigen Daten zur Verfügung, die auf der Kundenrechnung angezeigt werden müssen. Für die Zahlarten Lastschrift und PayLater wird durch diesen Request das Einzugsdatum des Bestellwerts bzw. der Raten festgelegt.
Request
XML Header
<?xml version="1.0" encoding="UTF-8"?>
Data Knoten
Attribut | Pflicht | Werte | Details |
---|---|---|---|
version | + | wird vom Bibliothek festgelegt | Versionsnummer der genutzten API |
<data api_version="1.5.11">
<!-- Request Daten -->
</data>
Default Params Knoten (Händler Zugangsdaten)
Attribut | Pflicht | Werte | Details |
---|---|---|---|
mid | + | N..4 | Ihre Händler Id |
pid | + | N..4 | Ihre domainspezifische Portal Id |
bpsecure | + | String | MD5 Hash des geheimen Passwort |
<default_params
mid="4441"
pid="6021"
bpsecure="25d55ad283aa400af464c76d713c07ad"/>
Invoice Params Knoten
Attribut | Pflicht | Werte | Details |
---|---|---|---|
carttotalgross | + | N..7 | Aktueller Bruttogesamtwert der Bestellung in kleinster Währungseinheit (1,00 EUR = 100) |
currency | + | Vorgabe ISO 4217 | Dreistelliger Währungscode (z.B. "EUR") |
reference | + | AN..40 | Eindeutige Bestellnummer beim Händler (erlaubte Zeichen: 0-9,a-z,A-Z,.,-,_,/) |
delayindays | + | N..7 | Anzahl Tage, um die sich das Zahlungsziel zusätzlich zu den 20/30 Tagen verzögern soll. (z.B. bei verspäteter Lieferung / erwarteter Verzögerung der Lieferung) |
is_partial | + | 0/1 | 0: Versand der gesamten Bestellung 1: Teilversand der Bestellung |
invoice_number | (bei Teil-Akt.) | AN..40 | Die Rechnungsnummer für die Teillieferung |
article_data | (bei Teil-Akt.) | Knoten | |
articleid | (bei Teil-Akt.) | AN..20 | Eindeutige Artikel-ID für die Warenkorbposition* |
articlequantity | (bei Teil-Akt.) | N..7 | Menge des Artikels im Warenkorb |
articlename | (bei Teil-Akt.) | AN..50 | Name des Artikels |
articleprice | (bei Teil-Akt.) | N..7 | Nettopreis des Artikels in kleinster Währungseinheit (1,00 EUR = 100) |
articlepricegross | (bei Teil-Akt.) | N..7 | Bruttopreis des Artikels in kleinster Währungseinheit (1,00 EUR = 100) |
*Hinweis: Standardmäßig ist nur die Aktivierung der gesamten Bestellung möglich. Die teilweise Aktivierung bedarf des "is_partial" Parameters und muss separat durch BillPay freigeschaltet werden.
Die Teillieferung ist nur für die folgenden Zahlarten möglich:
Zahlart ID | Zahlart |
---|---|
1 | Rechnung |
2 | Lastschrift |
<invoice_params
carttotalgross="43000"
currency="EUR"
reference="1773673332"
delayindays="0" />
Vollständiges XML-Beispiel (volle Aktivierung)
<?xml version="1.0" encoding="UTF-8"?>
<data api_version="1.5.11">
<default_params mid="4441" pid="6021" bpsecure="25d55ad283aa400af464c76d713c07ad" />
<invoice_params carttotalgross="43000" currency="EUR" reference="1773673332" delayindays="0" />
</data>
Vollständiges XML-Beispiel (Teilaktivierung: Artikel #1234)
<?xml version="1.0" encoding="UTF-8"?><data api_version="1.5.18">
<default_params mid="4441" pid="6021" bpsecure="25d55ad283aa400af464c76d713c07ad" />
<invoice_params carttotalgross="23000" currency="EUR" reference="1773673332" delayindays="0" is_partial="1" invoice_number="INV1108049850" shippingname="Express Versand" shippingprice="840" shippingpricegross="1000" rebate="1681" rebategross="2000" carttotalprice="19327" />
<article_data>
<article articleid="1234" articlequantity="2" articlename="Shirt" articleprice="10084" articlepricegross="12000" />
</article_data>
</data>
Response
Mit der "InvoiceCreated"-Response wird im Fall der Zahlarten "Rechnung" & "Ratenkauf Schweiz" die Bankverbindung übertragen, auf die die Zahlung durch den Kunden zu leisten ist. Diese Bankverbindung, sowie das zusätzlich übertragene Fälligkeitsdatum für die Zahlung muss auf der Rechnung des Kunden (z.B. in der Warensendung enthalten oder per E-Mail zugestellt) angedruckt werden.
Für PayLater und Lastschrift spielen diese Felder keine Rolle und können ignoriert werden. Es ist ein statischer Text anzudrucken, welcher durch Ihren Ansprechpartner bei BillPay bereitgestellt wird.
Attribut | Pflicht | Werte | Details |
---|---|---|---|
account_holder | + | AN..255 | Kontoinhaber für die Forderung |
account_number | + | AN..40 | BillPay IBAN für die Forderung |
bank_code | + | AN..16 | BillPay BIC für die Forderung |
bank_name | + | AN..255 | Name der BillPay Bank für die Forderung |
invoice_reference | + | AN..255 | Verwendungszweck für die Forderung |
invoice_duedate | + | N..8 | Zahlungsziel des Kunden im Format JJJJMMTT |
activation_performed | + | 0/1 | 1: Die Forderung wurde mit diesem Request aktiviert 0: Die Forderung war bereits aktiviert; der Request liefert lediglich die Bankdaten zurück. |
<?xml version="1.0" encoding="UTF-8" ?>
<data api_version="1.5.11"
customer_message=""
error_code="0"
merchant_message="">
<invoice_bank_account
account_holder="BillPay GmbH"
account_number="DE1200TEST333222110000492152"
activation_performed="1"
bank_code="TESTBIC0001"
bank_name="BillPay Test Bank"
invoice_duedate="20160324"
invoice_reference="BP1773673332/3042"/>
</data>