BillPay Techdocs
Navbar

BillPay Offline Lösung

Die Integration von BillPay in Ihr Call-Center-System ist fast identisch, mit der in Ihren Online-Kanal. Es gibt aber darüberhinaus noch ein paar Punkte, die bei den Call-Center und POS (Point of Sale) Lösungen beachtet werden müssen.

Call Center Agents

Es ist wichtig, dass der Endkunde über die BillPay Bezahlmethoden und der damit einhergehende Identitäts- und Bonitätsprüfung aufgeklärt wird. Folgender Text muss in der Call-Center-GUI angezeigt werden.

Ratenkauf/PayLater

Beim Ratenkauf ist es gesetzliche Bestimmung, dass der Endkunde den Ratenvertrag und die ESI (Europäische Standard Informationen) vor Abschluß der Bestellung zur Kenntnis genommen hat.

  • Für Call-Center- /Telefon-Bestellungen müssen dem Endkunden die oben genannten Dokumente zugänglich gemacht werden (z.B. via E-Mail), vom Endkunden zur Kenntniss genommen und bestätigt werden; bevor die Bestellung abgeschlossen wird.
  • Für Point-of-Sale orders (POS), bei denen der Endkunde physisch anwesend ist, muss der Ratenvertrag (PayLater) vom Endkunden unterschrieben werden, nachdem er die ESI zur Kenntniss genommen hat und bevor die Bestellung bei BillPay final angelegt wird.

Die oben genannten Anforderungen, erfordern deshalb für alle Call-Center/Telefon und Point-of-Sale (POS) Bestellungen einen two-step order creation Prozess - preauthorize Request mit manualcapture = “1” gefolgt von einem capture Request.

BillPay stellt die Dokumente (Ratenvertrag und ESI) via Document Service zur Verfügung.

Dieser Service verwendet eine BasicAuthentication, um die Authentifizierung sicherzustellen. Die benötigten Zugangsdaten müssen im Request-Header mitgesendet werden und beinhalten folgende Daten:

Username: Die Portal ID für diesen Request

getDocument

Lädt ein Dokument runter (oder “streamt” ein PDF-Dokument), welches durch folgende Parameter definiert wird.

/getDocument?type=[document type]&transactionId=[transaction ID]&download=[download]&paymentMethod=[payment method] /getDocument?type=[document type]&orderReference=[oreder reference]

URLs

Test System: https://test-resources.billpay.de/getDocument?
Live System: https://resources.billpay.de/getDocument?

Parameter Beschreibung Beispiele Pflicht?
type Document type pdf_standard_eupdf_contract Pflicht
transactionId Order transaction ID (UUID Format) 7ec8977f-7cc8-4848-988f-30d8d9a6eeaa ENTWEDER transactionId ODER orderReference ist Pflicht
orderReference merchant_order_id 100411544
download Boolean, um Dokument zu “streamen”, alternativ enthält die Response einen absoluten Download-Pfad true / false Optional (default=true)
paymentMethod Die Zahlart, welche die Forderungen haben wird. Dies wird benötigt, wenn prozessual die Dokumente vor Abschluss der Bestellung (bei BillPay) gebraucht werden. UNKNOWN
PAYLATER
PAYLATER_COLLATERAL_PROMISE
Optional. Beim Fehlen dieser Angabe und die Bestellung hat noch keine Zahlart (PreScore) wird kein Dokument zurückgeliefert.
rateCount Die Ratenanzahl für PreScore-Bestellungen und den gewählten Ratenplan in dem ESI-PDF korrekt darzustellen integer optional, (Pflicht für PreScore Bestellungen)

Response

Die download Get-Variable ist “true”:

  • Success: Die Datei wird im Output-Stream zur Verfügung gestellt, mit “content-type” (application/pdf).
  • Failure: Download fehlgeschlagen. Response enthält absoluten Download-Pfad.

Die download Get-Variable ist “false”:

{
    "status": 0,
    "message" : "Success",
    "localPath" : "/data/spool/mypdf.pdf"
}

sendDocument

Erstellt einen Event bei BillPay, der eine E-Mail an den Endkunden auslöst. Gesteuert durch folgende Parameter.

/sendDocument?mediaType=email&type=[document type]&transactionId=[transaction ID]&paymentMethod=[payment method]

URLs

Test System: https://test-resources.billpay.de/sendDocument?
Live System: https://resources.billpay.de/sendDocument?

Parameter Beschreibung Beispiele Pflicht?
mediaType Verwendetes Medium EMAIL Pflicht
type Document type pdf_standard_eu Pflicht
transactionId Order transaction ID (UUID format) 7ec8977f-7cc8-4848-988f-30d8d9a6eeaa ENTWEDER transactionId ODER orderReference ist Pflicht
orderReference merchant_order_id 100411544
paymentMethod Die Zahlart, welche die Forderungen haben wird. Dies wird benötigt, wenn prozessual die Dokumente vor Abschluss der Bestellung (bei BillPay) gebraucht werden. UNKNOWN
PAYLATER
PAYLATER_COLLATERAL_PROMISE
Optional. Beim Fehlen dieser Angabe und die Bestellung hat noch keine Zahlart (PreScore) wird kein Dokument zurückgeliefert.
rateCount Die Ratenanzahl für PreScore-Bestellungen und den gewählten Ratenplan in dem ESI-PDF korrekt darzustellen integer optional, (Pflicht für preScore Bestellungen)

Response

{
    "status": 0,
    "message" : "Success",
    "localPath" : null
}

Version history

[2.2.0] - 2017-10-04

The version 2.2.0 is not fully backwards compatible to 2.1.0

Added - Request: getOrderDetails.xsd

  • Response: getOrderDetails.xsd

  • Request: prescore.xsd

    • attribute expecteddaystillshipping

Changed - Request: shiftDueDate.xsd - changed attribute newduedate from type date to the name shiftdatesby from the type integer in the range 1 to 90

[2.1.0] - 2017-06-19

The version 2.1.0 is not fully backwards compatible to 2.0.0

Changed - Request: preauthorize.xsd - Request: prescore.xsd - allowed values from attribute historicaltripcurrency changed from char to enum

  • Response: invoiceCreated.xsd
    • element name has been changed from “invoice_numbers” to “assigned_invoice_number”. Only the invoice_number node for the currently activated suborder is returned.

[2.0.0] - 2017-07-03

Added - Notificatons: asyncCapture.xsd

  • Request: cancel.xsd
  • Request: capture.xsd
  • Request: editCartContent.xsd
  • Request: getBillPayBankData.xsd
  • Request: invoiceCreated.xsd
  • Request: partialCancel.xsd
  • Request: preauthorize.xsd
  • Request: prescore.xsd
  • Request: reportCustomerPayment.xsd
  • Request: shiftDueDate.xsd
  • Request: updateOrder.xsd

  • Response: cancel.xsd

  • Response: capture.xsd

  • Response: editCartContent.xsd

  • Response: getBillPayBankData.xsd

  • Response: invoiceCreated.xsd

  • Response: partialCancel.xsd

  • Response: preauthorize.xsd

  • Response: prescore.xsd

  • Response: reportCustomerPayment.xsd

  • Response: shiftDueDate.xsd

  • Response: updateOrder.xsd

Should you have any questions relating to this manual and/or integrating BillPay payment methods, please feel free to contact us via support@billpay.de.