Der Request "Capture" schließt die zuvor mit dem "preauthorize" Request eröffnete Bestellung ab, vorausgesetzt diese wurde nicht im "Auto-Capture-Modus" (capturerequestnecessary
="0") durchgeführt. Aus juristischer Sicht wird mit erfolgreichem Senden des Capture-Requests die Forderung, die sich aus der Bestellung gegenüber dem Kunden ergibt BillPay abgetreten.
Request
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="1234"
pid="5678"
bpsecure="25d55ad283aa400af464c76d713c07ad"/>
Capture Params Knoten
Attribut | Typ | Werte | Details | |
---|---|---|---|---|
bptid | + | String | AN..50 | Eindeutige BillPay Transaktionsnummer (erhalten aus der "Preauthorize"-Response) |
carttotalgross | + | Int | N..7 | Bruttowert der Bestellung in kleinster Währungseinheit (1,00 EUR = 100) |
currency | + | String | Vorgabe ISO4217 | Dreistelliger Währungscode für die Bestellung (z.B. "EUR") |
reference | + | String | AN..40 | Eindeutige Bestellnummer beim Händler (erlaubte Zeichen: 0-9, a-z, A-Z, ., -, _, /) |
customerid | - | String | AN..20 | Eindeutige Kundennummer beim Händler (erlaubte Zeichen: 0-9, a-z, A-Z, ., -, _, /) |
<capture_params bptid="1aa2fb2d-2b78-4393-bf06-be0012dda337" carttotalgross="3390" currency="EUR" reference="Bestellnummer123" customerid="Kunde123" />
Vollständiges XML-Beispiel
<?xml version="1.0" encoding="UTF-8" ?>
<data api_version="1.5.18">
<default_params mid="1234" pid="5678" bpsecure="25d55ad283aa400af464c76d713c07ad">
</default_params>
<capture_params bptid="1aa2fb2d-2b78-4393-bf06-be0012dda337" carttotalgross="3390" currency="EUR" reference="Bestellnummer123" customerid="Kunde123" />
</capture_params>
</data>
Response
Mit der "Capture"-Response wird im Fall der Zahlart Kauf auf Rechnung & Ratenkauf Schweiz die Bankverbindung übertragen, auf die die Zahlung durch den Kunden zu leisten ist. Die Bankverbindung sollte idealerweise schon auf der Bestellbestätigung / der Bestätigungsseite im Shop aufgeführt werden.
Für PayLater und Lastschrift spielen diese Felder keine Rolle und können ignoriert werden.
Attribut | Pflicht | Typ | Werte | Details |
---|---|---|---|---|
account_holder | + | String | AN..255 | Kontoinhaber für die Forderung |
account_number | + | String | AN..40 | BillPay IBAN für die Forderung |
bank_code | + | String | AN..16 | BillPay BIC für die Forderung |
bank_name | + | String | AN..255 | Name der BillPay Bank für die Forderung |
invoice_reference | + | String | AN..255 | Verwendungszweck für die Forderung |
<invoice_bank_account
account_holder="BillPay GmbH"
account_number="DE07312312312312312"
bank_code="BELADEBEXXX"
bank_name="Sparkasse Berlin"
invoice_reference="BP555666777/9999"/>