Zum Hauptinhalt springen
Version: Next (in Entwicklung)

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-]+$

Example: XYZ12345-2021
requestTimestampstring<date-time>required

Zeitstempel des Online-Antrags / Payment-Requests.

Example: 2025-10-06T14:32:00.711+02:00
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
grossAmountnumber<double>required

Der Gesamtbetrag dient dem Bezahldienst zur Validierung der einzelnen Positionen.

Possible values: > 0 and <= 999999

Example: 30
purposestring

Verwendungszweck / Buchungstext der Payment Transaction.

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

Example: Antrag fuer Antragsformular
descriptionDatatypeC

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

Possible values: non-empty and <= 250 characters

Example: Anträge für Antragsformulare
redirectUrlstring<uri>required

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-]+$

    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-]+$

    Example: XYZ22113
    descriptionDatatypeC

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

    Possible values: non-empty and <= 250 characters

    Example: XYZ22113-01 - Antrag auf Erteilung eines Antragsformulars
    taxRatenumber<double>required

    Steuersatz als Prozentbetrag

    Possible values: >= 0 and <= 100

    Example: 19
    quantityinteger<int32>required

    Possible values: >= 1 and <= 999999

    Example: 3
    totalNetAmountnumber<double>required

    Nettobetrag der Position

    Possible values: > 0 and <= 999999

    Example: 25.2
    totalTaxAmountnumber<double>required

    Steuerbetrag der Position

    Possible values: >= 0 and <= 999999

    Example: 4.8
    singleNetAmountnumber<double>required

    Nettobetrag der Position

    Possible values: > 0 and <= 999999

    Example: 8.4
    singleTaxAmountnumber<double>required

    Steuerbetrag der Position

    Possible values: >= 0 and <= 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

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

  • ]
    • requestor object
    requestorType stringrequired

    Possible values: [INDIVIDUAL, ORGANIZATION]

    nameDatatypeArequired

    Familienname des Bezahlers

    Possible values: non-empty and <= 250 characters

    Example: Mustermann
    firstNameDatatypeArequired

    Vorname(n) des Bezahlers

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

    Example: Max
    genderstring

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

    Possible values: [M, F, D]

    address objectrequired
    addressType string

    Possible values: [POSTAL_ADDRESS]

    Eine Gruppe von Informationselementen, die Informationen über die Anschrift enthalten.

    addressLine1DatatypeBrequired

    Die Hauptzeile einer Anschrift. Üblicherweise ist dies entweder Straße und Hausnummer oder der Text 'Postfach' gefolgt von der Postfachnummer.

    Possible values: non-empty and <= 250 characters

    Example: Wilhelmstraße 97
    addressLine2DatatypeB

    Eine zusätzliche Adresszeile in einer Anschrift, die verwendet werden kann, um weitere Einzelheiten in Ergänzung zur Hauptzeile anzugeben.

    Possible values: non-empty and <= 250 characters

    addressLine3DatatypeB

    Eine zusätzliche Adresszeile in einer Anschrift, die verwendet werden kann, um weitere Einzelheiten in Ergänzung zur Hauptzeile anzugeben.

    Possible values: non-empty and <= 250 characters

    cityDatatypeBrequired

    Die Bezeichnung der Stadt oder Gemeinde, in der sich die Anschrift befindet.

    Possible values: non-empty and <= 250 characters

    Example: Berlin
    postalCodestringrequired

    Die Postleitzahl.

    Possible values: non-empty and <= 16 characters

    Example: 10117
    countrySubdivisionDatatypeB

    Die Unterteilung eines Landes (wie Region, Bundesland, Provinz etc.).

    Possible values: non-empty and <= 250 characters

    countryCodestringrequired

    Ein Code, mit dem das Land bezeichnet wird. Anmerkung: Die Liste der zulässigen Länder ist bei der ISO 3166-1 'Codes for the representation of names of countries and their subdivisions' erhältlich. Nur die Alpha-2-Darstellung darf verwendet werden.

    Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

    Example: DE
    PaymentRequest
    {
      "requestId": "XYZ12345-2021",
      "requestTimestamp": "2025-10-06T14:32:00.711+02:00",
      "currency": "EUR",
      "grossAmount": 30,
      "purpose": "Antrag fuer Antragsformular",
      "description": "Anträge für Antragsformulare",
      "redirectUrl": "https://efa-od-xy.de/sdfsdfsdf/success?sid=DSYXD1234FSD",
      "items": [
        {
          "id": "01",
          "reference": "XYZ22113",
          "description": "XYZ22113-01 - Antrag auf Erteilung eines Antragsformulars",
          "taxRate": 19,
          "quantity": 3,
          "totalNetAmount": 25.2,
          "totalTaxAmount": 4.8,
          "singleNetAmount": 8.4,
          "singleTaxAmount": 1.6,
          "bookingData": {
            "haushaltstelle": "1234",
            "objektnummer": "0815",
            "href": "AlphaBetaGamma"
          }
        }
      ],
      "requestor": {
        "requestorType": "INDIVIDUAL",
        "name": "Mustermann",
        "firstName": "Max",
        "gender": "M",
        "address": {
          "addressType": "POSTAL_ADDRESS",
          "addressLine1": "Wilhelmstraße 97",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "Berlin",
          "postalCode": "10117",
          "countrySubdivision": "string",
          "countryCode": "DE"
        }
      }
    }