PaymentRequest

requestId stringrequired

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

Die Request-ID wird vom Online-Dienst vergeben und vom Bezahldienst abgelegt.

requestTimestamp date-timerequired

Zeitstempel des Online-Antrags / Payment-Requests.

currency stringrequired

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

Im ersten Schritt ist hier nur 'EUR' vorgesehen. Perspektivisch sollte hier die entsprechende ISO-Norm referenziert werden.

grosAmount doublerequired

Possible values: <= 999999

Der Gesamtbetrag dient dem Bezahldienst zur Validierung der einzelnen Positionen.

purpose string

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

Verwendungszweck / Buchungstext der Payment Transaction.

description string

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

Die Beschreibung des Payment Requests. Kann auf der Paypage / PSP Seite angezeigt werden.

redirectUrl urirequired

Possible values: non-empty and <= 2082 characters

Rücksprung-URL vom Bezahldienst zum Online-Dienst. Der Status (Erfolg / Abbruch) muss über die Statusabfrage (GET) abgefragt werden.

items

object[]

required

Possible values: >= 1, <= 99

Array [

id stringrequired

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

ID der Position vom Online-Dienst vergeben

reference stringrequired

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

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

description string

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

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

taxRate doublerequired

Possible values: <= 100

Steuersatz als Prozentbetrag

quantity int64required

Possible values: >= 1 and <= 999999

totalNetAmount doublerequired

Possible values: <= 999999

Nettobetrag der Position

totalTaxAmount doublerequired

Possible values: <= 999999

Steuerbetrag der Position

singleNetAmount doublerequired

Possible values: <= 999999

Nettobetrag der Position

singleTaxAmount doublerequired

Possible values: <= 999999

Steuerbetrag der Position

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

name stringrequired

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

Familienname des Bezahlers

firstName stringrequired

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

Vorname(n) des Bezahlers

gender string

Possible values: [M, F, D]

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

isOrganization boolean

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

organizationName string

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

Soll nur existieren, wenn isOrganization == true

address

object

required

street string

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

Strasse

houseNumber string

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

Hausnummer

addressLine string[]

Possible values: <= 9

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

postalCode string

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

Postleitzahl

city string

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

Stadt

country string

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

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