PaymentRequest

requestIdstringrequired
Die Request-ID wird vom Online-Dienst vergeben und vom Bezahldienst abgelegt.
Possible values: non-empty and <= 36 characters, Value must match regular expression ^[\w\d-]+$
Example: XYZ12345-2021
requestTimestampdate-timerequired

Zeitstempel des Online-Antrags / Payment-Requests.

currencystringrequired
Im ersten Schritt ist hier nur 'EUR' vorgesehen. Perspektivisch sollte hier die entsprechende ISO-Norm referenziert werden.
Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[\w]+$
Example: EUR
grosAmountdoublerequired
Der Gesamtbetrag dient dem Bezahldienst zur Validierung der einzelnen Positionen.
Possible values: <= 999999
Example: 30
purposestring
Verwendungszweck / Buchungstext der Payment Transaction.
Possible values: <= 27 characters, Value must match regular expression ^[\w\d\s-]+$
Example: Antrag fuer Antragsformular
descriptionstring
Die Beschreibung des Payment Requests. Kann auf der Paypage / PSP Seite angezeigt werden.
Possible values: <= 250 characters, Value must match regular expression ^[\w\d\s-,\.\u00C0-\u017F]+$
Example: Anträge für Antragsformulare
redirectUrlurirequired
Rücksprung-URL vom Bezahldienst zum Online-Dienst. Der Status (Erfolg / Abbruch) muss über die Statusabfrage (GET) abgefragt werden.
Possible values: non-empty and <= 2082 characters
Example: https://efa-od-xy.de/sdfsdfsdf/success?sid=DSYXD1234FSD

items

object[]

required

Possible values: >= 1, <= 99

Array [

idstringrequired

ID der Position vom Online-Dienst vergeben

Possible values: non-empty and <= 36 characters, Value must match regular expression ^[\w\d-]+$

Example: 01

referencestringrequired

Eine fachliche Referenz auf den "Artikel" bzw. den Inhalt der Position.

Possible values: non-empty and <= 36 characters, Value must match regular expression ^[\w\d-]+$

Example: XYZ22113

descriptionstring

Beschreibung der Position vom Online-Dienst zur Verwendung z. B. auf der Pay-Page.

Possible values: non-empty and <= 250 characters, Value must match regular expression ^[\w\d\s-,\.\u00C0-\u017F]+$

Example: XYZ22113-01 - Antrag auf Erteilung eines Antragsformulars

taxRatedoublerequired

Steuersatz als Prozentbetrag

Possible values: <= 100

Example: 19

quantityint64required

Possible values: >= 1 and <= 999999

Example: 3

totalNetAmountdoublerequired

Nettobetrag der Position

Possible values: <= 999999

Example: 25.2

totalTaxAmountdoublerequired

Steuerbetrag der Position

Possible values: <= 999999

Example: 4.8

singleNetAmountdoublerequired

Nettobetrag der Position

Possible values: <= 999999

Example: 8.4

singleTaxAmountdoublerequired

Steuerbetrag der Position

Possible values: <= 999999

Example: 1.6

bookingData

object

Container für Key-Value-Paare für zusätzliche Informationen für die Verbuchung im Bezahldienst oder nachgelagerten Systemen

property name*string

]

requestor

object

namestringrequired

Familienname des Bezahlers

Possible values: non-empty and <= 250 characters, Value must match regular expression ^[\w\d\s-,\.\u00C0-\u017F]+$

Example: Mustermann

firstNamestringrequired

Vorname(n) des Bezahlers

Possible values: non-empty and <= 250 characters, Value must match regular expression ^[\w\d\s-,\.\u00C0-\u017F]+$

Example: Max

genderstring

Geschlecht des Bezahlers: (M)ale=Männlich, (F)emale=Weiblich, (D)iverse=Divers

Possible values: [M, F, D]

isOrganizationboolean

Wahr für Organisationen / juristische Personen, Falsch für 'natürliche' Antragsteller

Example: true

organizationNamestring

Soll nur existieren, wenn isOrganization == true

Possible values: non-empty and <= 250 characters, Value must match regular expression ^[\w\d\s-,\.\u00C0-\u017F]+$

Example: Bundesministerium der Finanzen

address

object

required

streetstring

Strasse

Possible values: non-empty and <= 250 characters, Value must match regular expression ^[\w\d\s-,\.\u00C0-\u017F]+$

Example: Wilhelmstraße

houseNumberstring

Hausnummer

Possible values: <= 20 characters, Value must match regular expression ^[\w\d-]+$

Example: 97

addressLinestring[]

Zum Abbilden von Internationalen Adressen werden generische "Adresszeilen" verwendet und nicht "Straße / Hausnummer".

Possible values: <= 9

Example: ["Dienstsitz Berlin","Postanschrift: 11016 Berlin"]

postalCodestring

Postleitzahl

Possible values: >= 5 characters and <= 5 characters, Value must match regular expression ^[\d]+$

Example: 10117

citystring

Stadt

Possible values: non-empty and <= 250 characters, Value must match regular expression ^[\w\d\s-,\u00C0-\u017F]+$

Example: Berlin

countrystring

ISO 3166-1, Alpha-2 code, zwei Großbuchstaben

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[\w]+$

Example: DE