1.0.1
1.0.1 veraltet
PaymentItem BookingData - veraltet!
Der Parameter PaymentItem BookingData ist zugunsten des Parameters PaymentItem abgekündigt und somit veraltet. Der neue Parameter PaymentItem fasst die beiden alten Parameter PaymentItem Reference und PaymentItem Bookingdata zusammen.
Onlinedienste, die auf der Basis von XZuFi 2.2 parametrisiert werden und ein Paar von Parametern PaymentItem Reference und PaymentItem Bookingdata erwarten, sollten ohne Probleme weiterhin korrekt arbeiten. Eine möglicherweise vorhandene Unterstützung für die komfortable Pflege der Parameter kann aber in den Redaktionssystemen zurückgebaut werden. Mit der Migration zu XZuFi 2.3 können diese Onlinedienste weiter betrieben werden, wenn die Parameter als individuelle Parameter behandelt werden. Eine Migration der beiden veralteten Parameter zum neuen Parameter PaymentItem wird aber im Zuge der Migration XZuFi 2.2 - 2.3 dringend empfohlen.
Die Bezahldienst-bezogenen Parameter dürfen ggf. nur in revisionssicheren Systemen und/oder unter Einhaltung eines Vier-Augen-Prinzips oder anderen Regelungen gepflegt werden. Eine Prüfung, ob diese Restriktionen bestehen und wenn ja, für welche Parameter sie gelten, steht noch aus.
Die Standardisierung dieser Parameter steht bis zur Klärung dieser Frage noch aus.
| Fachliche Kategorie | Technische Kategorie |
|---|---|
| Bezahldienst-bezogener Parameter | XZuFi-basierte Standard-Parameter mit direktem Onlinedienst-Bezug |
Fachliche Bedeutung
Die Bezahldienste brauchen teilweise detaillierte Informationen über Titel, Kapitel, Kostenstellen oder sonstige Daten. Die paymentItems, die der Onlinedienst im Zuge des Bezahlvorgangs an den Bezahldienst meldet, enthalten diese Informationen im Element BookingData der API Request-Nachricht.
Wertemenge
Liste von Namens-Schlüssel/Wert-Paaren. In XZuFi muss diese Liste in einer einzigen Zeichenkette codiert abgelegt werden. Für diese Codierung existiert keine Standardisierung, aber eine Best Practice – siehe unten.
Verortung im Datenmodell
Siehe Abschnitt Verortung von generischen XZuFi-basierten Standard-Parametern mit direktem Onlinedienst-Bezug im PVOG Datenmodell.
Der Namens-Schlüssel ist "efa.payment.bookingdata".
In einem Szenario, in dem ein Onlinedienst mehrere verschiedene Elemente der Dienstleistung bezahlen lassen muss, müssen auch mehrere Parameter PaymentItem Bookingdata angegeben werden. Es ist daher vorgesehen, dass es mehrere Elemente mit demselben Namens-Schlüssel gibt.
Codebeispiel XZuFi 2.2
<xzufi:onlinedienst xmlns:p3="http://www.w3.org/2001/XMLSchema-instance"
p3:type="xzufi:OnlinedienstErweitert">
<xzufi:parameter>
<xzufi:parameterName>efa.payment.bookingdata</xzufi:parameterName>
<xzufi:parameterWert>{"001": {"haushaltstelle": "1234", "objektnummer": "0815", "href": "AlphaBetaGamma"}}</xzufi:parameterWert>
</xzufi:parameter>
<xzufi:parameter>
<xzufi:parameterName>efa.payment.bookingdata</xzufi:parameterName>
<xzufi:parameterWert>{"002": {"HKRMandantenCode": 12, "Haushaltsstelle": 42, "Objektnummer": 123}}</xzufi:parameterWert>
</xzufi:parameter>
</xzufi:onlinedienst>
Ermittlungsmöglichkeit PVOG API
Siehe Abschnitt Ermittlung von generischen XZuFi-basierten Standard-Parametern mit direktem Onlinedienst-Bezug mit Hilfe der PVOG-API.
Der Namens-Schlüssel ist "efa.payment.bookingdata".
Ermittlungsmöglichkeit FIT-Connect Routing API
(Der Parameter kann nicht über die FIT-Connect Routing-API ermittelt werden.)
Ermittlungsmöglichkeit DVDV API
(Der Parameter kann nicht über das DVDV-API ermittelt werden.)
Best Practices
Zu den Herausforderungen mit PaymentItem-spezifischen Parametern siehe Abschnitt Herausforderungen mit PaymentItem-spezifischen Parametern.
Zur Encodierung von der BookingData Namens-Schlüssel/Wert-Paar-Liste siehe Enkodierung einer Liste von Namens-Schlüssel/Wert-Paaren in einer Zeichenkette