Zum Hauptinhalt springen
Version: Next

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
grossAmountdoublerequired

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\d\s-]+$

Example: Antrag fuer Antragsformular
descriptionDatatypeC (string)

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

Possible values: non-empty and <= 250 characters, Value must match regular expression ([&#x0009;-\\&#x000A;]|&#x000D;|[&#x0020;-\\&#x007E;]|[&#x00A0;-\\&#x00AC;]|[&#x00AE;-\\&#x017E;]|[&#x0187;-\\&#x0188;]|&#x018F;|&#x0197;|[&#x01A0;-\\&#x01A1;]|[&#x01AF;-\\&#x01B0;]|&#x01B7;|[&#x01CD;-\\&#x01DC;]|[&#x01DE;-\\&#x01DF;]|[&#x01E2;-\\&#x01F0;]|[&#x01F4;-\\&#x01F5;]|[&#x01F8;-\\&#x01FF;]|[&#x0212;-\\&#x0213;]|[&#x0218;-\\&#x021B;]|[&#x021E;-\\&#x021F;]|[&#x0227;-\\&#x0233;]|&#x0259;|&#x0268;|&#x0292;|[&#x02B9;-\\&#x02BA;]|[&#x02BE;-\\&#x02BF;]|&#x02C8;|&#x02CC;|[&#x1E02;-\\&#x1E03;]|[&#x1E06;-\\&#x1E07;]|[&#x1E0A;-\\&#x1E11;]|[&#x1E1C;-\\&#x1E2B;]|[&#x1E2F;-\\&#x1E37;]|[&#x1E3A;-\\&#x1E3B;]|[&#x1E40;-\\&#x1E49;]|[&#x1E52;-\\&#x1E5B;]|[&#x1E5E;-\\&#x1E63;]|[&#x1E6A;-\\&#x1E6F;]|[&#x1E80;-\\&#x1E87;]|[&#x1E8C;-\\&#x1E97;]|&#x1E9E;|[&#x1EA0;-\\&#x1EF9;]|&#x2019;|&#x2021;|&#x20AC;|&#x0041;&#x030B;|&#x0043;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0044;&#x0302;|&#x0046;(&#x0300;|&#x0304;)|&#x0047;&#x0300;|&#x0048;(&#x0304;|&#x0326;|&#x0331;)|&#x004A;(&#x0301;|&#x030C;)|&#x004B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0048;|&#x035F;&#x0068;)|&#x004C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x004D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x004E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0050;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0052;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0053;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0054;(&#x0300;|&#x0304;|&#x0308;|&#x0315;|&#x031B;)|&#x0055;&#x0307;|&#x005A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x0061;&#x030B;|&#x0063;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0064;&#x0302;|&#x0066;(&#x0300;|&#x0304;)|&#x0067;&#x0300;|&#x0068;(&#x0304;|&#x0326;)|&#x006A;&#x0301;|&#x006B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0068;)|&#x006C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x006D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x006E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0070;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0072;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0073;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0074;(&#x0300;|&#x0304;|&#x0315;|&#x031B;)|&#x0075;&#x0307;|&#x007A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x00C7;&#x0306;|&#x00DB;&#x0304;|&#x00E7;&#x0306;|&#x00FB;&#x0304;|&#x00FF;&#x0301;|&#x010C;(&#x0315;|&#x0323;)|&#x010D;(&#x0315;|&#x0323;)|&#x012A;&#x0301;|&#x012B;&#x0301;|&#x017D;(&#x0326;|&#x0327;)|&#x017E;(&#x0326;|&#x0327;)|&#x1E32;&#x0304;|&#x1E33;&#x0304;|&#x1E62;&#x0304;|&#x1E63;&#x0304;|&#x1E6C;&#x0304;|&#x1E6D;&#x0304;|&#x1EA0;&#x0308;|&#x1EA1;&#x0308;|&#x1ECC;&#x0308;|&#x1ECD;&#x0308;|&#x1EE4;(&#x0304;|&#x0308;)|&#x1EE5;(&#x0304;|&#x0308;))*

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
    descriptionDatatypeC (string)

    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 ([&#x0009;-\\&#x000A;]|&#x000D;|[&#x0020;-\\&#x007E;]|[&#x00A0;-\\&#x00AC;]|[&#x00AE;-\\&#x017E;]|[&#x0187;-\\&#x0188;]|&#x018F;|&#x0197;|[&#x01A0;-\\&#x01A1;]|[&#x01AF;-\\&#x01B0;]|&#x01B7;|[&#x01CD;-\\&#x01DC;]|[&#x01DE;-\\&#x01DF;]|[&#x01E2;-\\&#x01F0;]|[&#x01F4;-\\&#x01F5;]|[&#x01F8;-\\&#x01FF;]|[&#x0212;-\\&#x0213;]|[&#x0218;-\\&#x021B;]|[&#x021E;-\\&#x021F;]|[&#x0227;-\\&#x0233;]|&#x0259;|&#x0268;|&#x0292;|[&#x02B9;-\\&#x02BA;]|[&#x02BE;-\\&#x02BF;]|&#x02C8;|&#x02CC;|[&#x1E02;-\\&#x1E03;]|[&#x1E06;-\\&#x1E07;]|[&#x1E0A;-\\&#x1E11;]|[&#x1E1C;-\\&#x1E2B;]|[&#x1E2F;-\\&#x1E37;]|[&#x1E3A;-\\&#x1E3B;]|[&#x1E40;-\\&#x1E49;]|[&#x1E52;-\\&#x1E5B;]|[&#x1E5E;-\\&#x1E63;]|[&#x1E6A;-\\&#x1E6F;]|[&#x1E80;-\\&#x1E87;]|[&#x1E8C;-\\&#x1E97;]|&#x1E9E;|[&#x1EA0;-\\&#x1EF9;]|&#x2019;|&#x2021;|&#x20AC;|&#x0041;&#x030B;|&#x0043;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0044;&#x0302;|&#x0046;(&#x0300;|&#x0304;)|&#x0047;&#x0300;|&#x0048;(&#x0304;|&#x0326;|&#x0331;)|&#x004A;(&#x0301;|&#x030C;)|&#x004B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0048;|&#x035F;&#x0068;)|&#x004C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x004D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x004E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0050;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0052;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0053;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0054;(&#x0300;|&#x0304;|&#x0308;|&#x0315;|&#x031B;)|&#x0055;&#x0307;|&#x005A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x0061;&#x030B;|&#x0063;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0064;&#x0302;|&#x0066;(&#x0300;|&#x0304;)|&#x0067;&#x0300;|&#x0068;(&#x0304;|&#x0326;)|&#x006A;&#x0301;|&#x006B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0068;)|&#x006C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x006D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x006E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0070;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0072;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0073;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0074;(&#x0300;|&#x0304;|&#x0315;|&#x031B;)|&#x0075;&#x0307;|&#x007A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x00C7;&#x0306;|&#x00DB;&#x0304;|&#x00E7;&#x0306;|&#x00FB;&#x0304;|&#x00FF;&#x0301;|&#x010C;(&#x0315;|&#x0323;)|&#x010D;(&#x0315;|&#x0323;)|&#x012A;&#x0301;|&#x012B;&#x0301;|&#x017D;(&#x0326;|&#x0327;)|&#x017E;(&#x0326;|&#x0327;)|&#x1E32;&#x0304;|&#x1E33;&#x0304;|&#x1E62;&#x0304;|&#x1E63;&#x0304;|&#x1E6C;&#x0304;|&#x1E6D;&#x0304;|&#x1EA0;&#x0308;|&#x1EA1;&#x0308;|&#x1ECC;&#x0308;|&#x1ECD;&#x0308;|&#x1EE4;(&#x0304;|&#x0308;)|&#x1EE5;(&#x0304;|&#x0308;))*

    Example: XYZ22113-01 - Antrag auf Erteilung eines Antragsformulars
    taxRatedoublerequired

    Steuersatz als Prozentbetrag

    Possible values: >= 0 and <= 100

    Example: 19
    quantityint32required

    Possible values: >= 1 and <= 999999

    Example: 3
    totalNetAmountdoublerequired

    Nettobetrag der Position

    Possible values: > 0 and <= 999999

    Example: 25.2
    totalTaxAmountdoublerequired

    Steuerbetrag der Position

    Possible values: >= 0 and <= 999999

    Example: 4.8
    singleNetAmountdoublerequired

    Nettobetrag der Position

    Possible values: > 0 and <= 999999

    Example: 8.4
    singleTaxAmountdoublerequired

    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
  • ]
  • requestor object
    nameDatatypeA (string)required

    Familienname des Bezahlers

    Possible values: non-empty and <= 250 characters, Value must match regular expression (&#x0020;|&#x0027;|[&#x002C;-\\&#x002E;]|[&#x0041;-\\&#x005A;]|[&#x0060;-\\&#x007A;]|&#x007E;|&#x00A8;|&#x00B4;|&#x00B7;|[&#x00C0;-\\&#x00D6;]|[&#x00D8;-\\&#x00F6;]|[&#x00F8;-\\&#x017E;]|[&#x0187;-\\&#x0188;]|&#x018F;|&#x0197;|[&#x01A0;-\\&#x01A1;]|[&#x01AF;-\\&#x01B0;]|&#x01B7;|[&#x01CD;-\\&#x01DC;]|[&#x01DE;-\\&#x01DF;]|[&#x01E2;-\\&#x01F0;]|[&#x01F4;-\\&#x01F5;]|[&#x01F8;-\\&#x01FF;]|[&#x0212;-\\&#x0213;]|[&#x0218;-\\&#x021B;]|[&#x021E;-\\&#x021F;]|[&#x0227;-\\&#x0233;]|&#x0259;|&#x0268;|&#x0292;|[&#x02B9;-\\&#x02BA;]|[&#x02BE;-\\&#x02BF;]|&#x02C8;|&#x02CC;|[&#x1E02;-\\&#x1E03;]|[&#x1E06;-\\&#x1E07;]|[&#x1E0A;-\\&#x1E11;]|[&#x1E1C;-\\&#x1E2B;]|[&#x1E2F;-\\&#x1E37;]|[&#x1E3A;-\\&#x1E3B;]|[&#x1E40;-\\&#x1E49;]|[&#x1E52;-\\&#x1E5B;]|[&#x1E5E;-\\&#x1E63;]|[&#x1E6A;-\\&#x1E6F;]|[&#x1E80;-\\&#x1E87;]|[&#x1E8C;-\\&#x1E97;]|&#x1E9E;|[&#x1EA0;-\\&#x1EF9;]|&#x2019;|&#x2021;|&#x0041;&#x030B;|&#x0043;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0044;&#x0302;|&#x0046;(&#x0300;|&#x0304;)|&#x0047;&#x0300;|&#x0048;(&#x0304;|&#x0326;|&#x0331;)|&#x004A;(&#x0301;|&#x030C;)|&#x004B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0048;|&#x035F;&#x0068;)|&#x004C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x004D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x004E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0050;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0052;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0053;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0054;(&#x0300;|&#x0304;|&#x0308;|&#x0315;|&#x031B;)|&#x0055;&#x0307;|&#x005A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x0061;&#x030B;|&#x0063;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0064;&#x0302;|&#x0066;(&#x0300;|&#x0304;)|&#x0067;&#x0300;|&#x0068;(&#x0304;|&#x0326;)|&#x006A;&#x0301;|&#x006B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0068;)|&#x006C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x006D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x006E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0070;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0072;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0073;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0074;(&#x0300;|&#x0304;|&#x0315;|&#x031B;)|&#x0075;&#x0307;|&#x007A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x00C7;&#x0306;|&#x00DB;&#x0304;|&#x00E7;&#x0306;|&#x00FB;&#x0304;|&#x00FF;&#x0301;|&#x010C;(&#x0315;|&#x0323;)|&#x010D;(&#x0315;|&#x0323;)|&#x012A;&#x0301;|&#x012B;&#x0301;|&#x017D;(&#x0326;|&#x0327;)|&#x017E;(&#x0326;|&#x0327;)|&#x1E32;&#x0304;|&#x1E33;&#x0304;|&#x1E62;&#x0304;|&#x1E63;&#x0304;|&#x1E6C;&#x0304;|&#x1E6D;&#x0304;|&#x1EA0;&#x0308;|&#x1EA1;&#x0308;|&#x1ECC;&#x0308;|&#x1ECD;&#x0308;|&#x1EE4;(&#x0304;|&#x0308;)|&#x1EE5;(&#x0304;|&#x0308;))*

    Example: Mustermann
    firstNameDatatypeA (string)required

    Vorname(n) des Bezahlers

    Possible values: non-empty and <= 250 characters, Value must match regular expression (?=(&#x0020;|&#x0027;|[&#x002C;-\\&#x002E;]|[&#x0041;-\\&#x005A;]|[&#x0060;-\\&#x007A;]|&#x007E;|&#x00A8;|&#x00B4;|&#x00B7;|[&#x00C0;-\\&#x00D6;]|[&#x00D8;-\\&#x00F6;]|[&#x00F8;-\\&#x017E;]|[&#x0187;-\\&#x0188;]|&#x018F;|&#x0197;|[&#x01A0;-\\&#x01A1;]|[&#x01AF;-\\&#x01B0;]|&#x01B7;|[&#x01CD;-\\&#x01DC;]|[&#x01DE;-\\&#x01DF;]|[&#x01E2;-\\&#x01F0;]|[&#x01F4;-\\&#x01F5;]|[&#x01F8;-\\&#x01FF;]|[&#x0212;-\\&#x0213;]|[&#x0218;-\\&#x021B;]|[&#x021E;-\\&#x021F;]|[&#x0227;-\\&#x0233;]|&#x0259;|&#x0268;|&#x0292;|[&#x02B9;-\\&#x02BA;]|[&#x02BE;-\\&#x02BF;]|&#x02C8;|&#x02CC;|[&#x1E02;-\\&#x1E03;]|[&#x1E06;-\\&#x1E07;]|[&#x1E0A;-\\&#x1E11;]|[&#x1E1C;-\\&#x1E2B;]|[&#x1E2F;-\\&#x1E37;]|[&#x1E3A;-\\&#x1E3B;]|[&#x1E40;-\\&#x1E49;]|[&#x1E52;-\\&#x1E5B;]|[&#x1E5E;-\\&#x1E63;]|[&#x1E6A;-\\&#x1E6F;]|[&#x1E80;-\\&#x1E87;]|[&#x1E8C;-\\&#x1E97;]|&#x1E9E;|[&#x1EA0;-\\&#x1EF9;]|&#x2019;|&#x2021;|&#x0041;&#x030B;|&#x0043;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0044;&#x0302;|&#x0046;(&#x0300;|&#x0304;)|&#x0047;&#x0300;|&#x0048;(&#x0304;|&#x0326;|&#x0331;)|&#x004A;(&#x0301;|&#x030C;)|&#x004B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0048;|&#x035F;&#x0068;)|&#x004C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x004D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x004E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0050;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0052;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0053;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0054;(&#x0300;|&#x0304;|&#x0308;|&#x0315;|&#x031B;)|&#x0055;&#x0307;|&#x005A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x0061;&#x030B;|&#x0063;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0064;&#x0302;|&#x0066;(&#x0300;|&#x0304;)|&#x0067;&#x0300;|&#x0068;(&#x0304;|&#x0326;)|&#x006A;&#x0301;|&#x006B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0068;)|&#x006C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x006D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x006E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0070;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0072;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0073;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0074;(&#x0300;|&#x0304;|&#x0315;|&#x031B;)|&#x0075;&#x0307;|&#x007A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x00C7;&#x0306;|&#x00DB;&#x0304;|&#x00E7;&#x0306;|&#x00FB;&#x0304;|&#x00FF;&#x0301;|&#x010C;(&#x0315;|&#x0323;)|&#x010D;(&#x0315;|&#x0323;)|&#x012A;&#x0301;|&#x012B;&#x0301;|&#x017D;(&#x0326;|&#x0327;)|&#x017E;(&#x0326;|&#x0327;)|&#x1E32;&#x0304;|&#x1E33;&#x0304;|&#x1E62;&#x0304;|&#x1E63;&#x0304;|&#x1E6C;&#x0304;|&#x1E6D;&#x0304;|&#x1EA0;&#x0308;|&#x1EA1;&#x0308;|&#x1ECC;&#x0308;|&#x1ECD;&#x0308;|&#x1EE4;(&#x0304;|&#x0308;)|&#x1EE5;(&#x0304;|&#x0308;))*)(?=^[\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
    organizationNameDatatypeD (string)

    Soll nur existieren, wenn isOrganization == true

    Possible values: non-empty and <= 250 characters, Value must match regular expression ([&#x0020;-\\&#x007E;]|[&#x00A1;-\\&#x00AC;]|[&#x00AE;-\\&#x017E;]|[&#x0187;-\\&#x0188;]|&#x018F;|&#x0192;|&#x0197;|[&#x01A0;-\\&#x01A1;]|[&#x01AF;-\\&#x01B0;]|&#x01B7;|[&#x01CD;-\\&#x01DC;]|[&#x01DE;-\\&#x01DF;]|[&#x01E2;-\\&#x01F0;]|[&#x01F4;-\\&#x01F5;]|[&#x01F8;-\\&#x01FF;]|[&#x0212;-\\&#x0213;]|[&#x0218;-\\&#x021B;]|[&#x021E;-\\&#x021F;]|[&#x0227;-\\&#x0233;]|&#x0259;|&#x0268;|&#x0292;|&#x02B0;|&#x02B3;|[&#x02B9;-\\&#x02BA;]|[&#x02BE;-\\&#x02BF;]|&#x02C6;|&#x02C8;|&#x02CC;|&#x02DC;|&#x02E2;|&#x0386;|[&#x0388;-\\&#x038A;]|&#x038C;|[&#x038E;-\\&#x03A1;]|[&#x03A3;-\\&#x03CE;]|&#x1D48;|&#x1D57;|[&#x1E02;-\\&#x1E03;]|[&#x1E06;-\\&#x1E07;]|[&#x1E0A;-\\&#x1E11;]|[&#x1E1C;-\\&#x1E2B;]|[&#x1E2F;-\\&#x1E37;]|[&#x1E3A;-\\&#x1E3B;]|[&#x1E40;-\\&#x1E49;]|[&#x1E52;-\\&#x1E5B;]|[&#x1E5E;-\\&#x1E63;]|[&#x1E6A;-\\&#x1E6F;]|[&#x1E80;-\\&#x1E87;]|[&#x1E8C;-\\&#x1E97;]|&#x1E9E;|[&#x1EA0;-\\&#x1EF9;]|[&#x2018;-\\&#x201A;]|[&#x201C;-\\&#x201E;]|[&#x2020;-\\&#x2021;]|&#x2026;|&#x2030;|[&#x2039;-\\&#x203A;]|&#x2070;|[&#x2074;-\\&#x2079;]|[&#x207F;-\\&#x2089;]|&#x20AC;|&#x2122;|&#x221E;|[&#x2264;-\\&#x2265;]|&#x0041;&#x030B;|&#x0043;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0044;&#x0302;|&#x0046;(&#x0300;|&#x0304;)|&#x0047;&#x0300;|&#x0048;(&#x0304;|&#x0326;|&#x0331;)|&#x004A;(&#x0301;|&#x030C;)|&#x004B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0048;|&#x035F;&#x0068;)|&#x004C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x004D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x004E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0050;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0052;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0053;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0054;(&#x0300;|&#x0304;|&#x0308;|&#x0315;|&#x031B;)|&#x0055;&#x0307;|&#x005A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x0061;&#x030B;|&#x0063;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0064;&#x0302;|&#x0066;(&#x0300;|&#x0304;)|&#x0067;&#x0300;|&#x0068;(&#x0304;|&#x0326;)|&#x006A;&#x0301;|&#x006B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0068;)|&#x006C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x006D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x006E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0070;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0072;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0073;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0074;(&#x0300;|&#x0304;|&#x0315;|&#x031B;)|&#x0075;&#x0307;|&#x007A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x00C7;&#x0306;|&#x00DB;&#x0304;|&#x00E7;&#x0306;|&#x00FB;&#x0304;|&#x00FF;&#x0301;|&#x010C;(&#x0315;|&#x0323;)|&#x010D;(&#x0315;|&#x0323;)|&#x012A;&#x0301;|&#x012B;&#x0301;|&#x017D;(&#x0326;|&#x0327;)|&#x017E;(&#x0326;|&#x0327;)|&#x1E32;&#x0304;|&#x1E33;&#x0304;|&#x1E62;&#x0304;|&#x1E63;&#x0304;|&#x1E6C;&#x0304;|&#x1E6D;&#x0304;|&#x1EA0;&#x0308;|&#x1EA1;&#x0308;|&#x1ECC;&#x0308;|&#x1ECD;&#x0308;|&#x1EE4;(&#x0304;|&#x0308;)|&#x1EE5;(&#x0304;|&#x0308;))*

    Example: Bundesministerium der Finanzen
    address objectrequired
    streetDatatypeB (string)

    Strasse

    Possible values: non-empty and <= 250 characters, Value must match regular expression ([&#x0020;-\\&#x007E;]|[&#x00A1;-\\&#x00A3;]|&#x00A5;|[&#x00A7;-\\&#x00AC;]|[&#x00AE;-\\&#x00B7;]|[&#x00B9;-\\&#x00BB;]|[&#x00BF;-\\&#x017E;]|[&#x0187;-\\&#x0188;]|&#x018F;|&#x0197;|[&#x01A0;-\\&#x01A1;]|[&#x01AF;-\\&#x01B0;]|&#x01B7;|[&#x01CD;-\\&#x01DC;]|[&#x01DE;-\\&#x01DF;]|[&#x01E2;-\\&#x01F0;]|[&#x01F4;-\\&#x01F5;]|[&#x01F8;-\\&#x01FF;]|[&#x0212;-\\&#x0213;]|[&#x0218;-\\&#x021B;]|[&#x021E;-\\&#x021F;]|[&#x0227;-\\&#x0233;]|&#x0259;|&#x0268;|&#x0292;|[&#x02B9;-\\&#x02BA;]|[&#x02BE;-\\&#x02BF;]|&#x02C8;|&#x02CC;|[&#x1E02;-\\&#x1E03;]|[&#x1E06;-\\&#x1E07;]|[&#x1E0A;-\\&#x1E11;]|[&#x1E1C;-\\&#x1E2B;]|[&#x1E2F;-\\&#x1E37;]|[&#x1E3A;-\\&#x1E3B;]|[&#x1E40;-\\&#x1E49;]|[&#x1E52;-\\&#x1E5B;]|[&#x1E5E;-\\&#x1E63;]|[&#x1E6A;-\\&#x1E6F;]|[&#x1E80;-\\&#x1E87;]|[&#x1E8C;-\\&#x1E97;]|&#x1E9E;|[&#x1EA0;-\\&#x1EF9;]|&#x2019;|&#x2021;|&#x20AC;|&#x0041;&#x030B;|&#x0043;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0044;&#x0302;|&#x0046;(&#x0300;|&#x0304;)|&#x0047;&#x0300;|&#x0048;(&#x0304;|&#x0326;|&#x0331;)|&#x004A;(&#x0301;|&#x030C;)|&#x004B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0048;|&#x035F;&#x0068;)|&#x004C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x004D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x004E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0050;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0052;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0053;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0054;(&#x0300;|&#x0304;|&#x0308;|&#x0315;|&#x031B;)|&#x0055;&#x0307;|&#x005A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x0061;&#x030B;|&#x0063;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0064;&#x0302;|&#x0066;(&#x0300;|&#x0304;)|&#x0067;&#x0300;|&#x0068;(&#x0304;|&#x0326;)|&#x006A;&#x0301;|&#x006B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0068;)|&#x006C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x006D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x006E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0070;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0072;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0073;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0074;(&#x0300;|&#x0304;|&#x0315;|&#x031B;)|&#x0075;&#x0307;|&#x007A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x00C7;&#x0306;|&#x00DB;&#x0304;|&#x00E7;&#x0306;|&#x00FB;&#x0304;|&#x00FF;&#x0301;|&#x010C;(&#x0315;|&#x0323;)|&#x010D;(&#x0315;|&#x0323;)|&#x012A;&#x0301;|&#x012B;&#x0301;|&#x017D;(&#x0326;|&#x0327;)|&#x017E;(&#x0326;|&#x0327;)|&#x1E32;&#x0304;|&#x1E33;&#x0304;|&#x1E62;&#x0304;|&#x1E63;&#x0304;|&#x1E6C;&#x0304;|&#x1E6D;&#x0304;|&#x1EA0;&#x0308;|&#x1EA1;&#x0308;|&#x1ECC;&#x0308;|&#x1ECD;&#x0308;|&#x1EE4;(&#x0304;|&#x0308;)|&#x1EE5;(&#x0304;|&#x0308;))*

    Example: Wilhelmstraße
    houseNumberstring

    Hausnummer

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

    Example: 97
    addressLineobject[]

    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
    cityDatatypeB (string)

    Stadt

    Possible values: non-empty and <= 250 characters, Value must match regular expression ([&#x0020;-\\&#x007E;]|[&#x00A1;-\\&#x00A3;]|&#x00A5;|[&#x00A7;-\\&#x00AC;]|[&#x00AE;-\\&#x00B7;]|[&#x00B9;-\\&#x00BB;]|[&#x00BF;-\\&#x017E;]|[&#x0187;-\\&#x0188;]|&#x018F;|&#x0197;|[&#x01A0;-\\&#x01A1;]|[&#x01AF;-\\&#x01B0;]|&#x01B7;|[&#x01CD;-\\&#x01DC;]|[&#x01DE;-\\&#x01DF;]|[&#x01E2;-\\&#x01F0;]|[&#x01F4;-\\&#x01F5;]|[&#x01F8;-\\&#x01FF;]|[&#x0212;-\\&#x0213;]|[&#x0218;-\\&#x021B;]|[&#x021E;-\\&#x021F;]|[&#x0227;-\\&#x0233;]|&#x0259;|&#x0268;|&#x0292;|[&#x02B9;-\\&#x02BA;]|[&#x02BE;-\\&#x02BF;]|&#x02C8;|&#x02CC;|[&#x1E02;-\\&#x1E03;]|[&#x1E06;-\\&#x1E07;]|[&#x1E0A;-\\&#x1E11;]|[&#x1E1C;-\\&#x1E2B;]|[&#x1E2F;-\\&#x1E37;]|[&#x1E3A;-\\&#x1E3B;]|[&#x1E40;-\\&#x1E49;]|[&#x1E52;-\\&#x1E5B;]|[&#x1E5E;-\\&#x1E63;]|[&#x1E6A;-\\&#x1E6F;]|[&#x1E80;-\\&#x1E87;]|[&#x1E8C;-\\&#x1E97;]|&#x1E9E;|[&#x1EA0;-\\&#x1EF9;]|&#x2019;|&#x2021;|&#x20AC;|&#x0041;&#x030B;|&#x0043;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0044;&#x0302;|&#x0046;(&#x0300;|&#x0304;)|&#x0047;&#x0300;|&#x0048;(&#x0304;|&#x0326;|&#x0331;)|&#x004A;(&#x0301;|&#x030C;)|&#x004B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0048;|&#x035F;&#x0068;)|&#x004C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x004D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x004E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0050;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0052;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0053;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0054;(&#x0300;|&#x0304;|&#x0308;|&#x0315;|&#x031B;)|&#x0055;&#x0307;|&#x005A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x0061;&#x030B;|&#x0063;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0315;|&#x0323;|&#x0326;|&#x0328;&#x0306;)|&#x0064;&#x0302;|&#x0066;(&#x0300;|&#x0304;)|&#x0067;&#x0300;|&#x0068;(&#x0304;|&#x0326;)|&#x006A;&#x0301;|&#x006B;(&#x0300;|&#x0302;|&#x0304;|&#x0307;|&#x0315;|&#x031B;|&#x0326;|&#x035F;&#x0068;)|&#x006C;(&#x0302;|&#x0325;|&#x0325;&#x0304;|&#x0326;)|&#x006D;(&#x0300;|&#x0302;|&#x0306;|&#x0310;)|&#x006E;(&#x0302;|&#x0304;|&#x0306;|&#x0326;)|&#x0070;(&#x0300;|&#x0304;|&#x0315;|&#x0323;)|&#x0072;(&#x0306;|&#x0325;|&#x0325;&#x0304;)|&#x0073;(&#x0300;|&#x0304;|&#x031B;&#x0304;|&#x0331;)|&#x0074;(&#x0300;|&#x0304;|&#x0315;|&#x031B;)|&#x0075;&#x0307;|&#x007A;(&#x0300;|&#x0304;|&#x0306;|&#x0308;|&#x0327;)|&#x00C7;&#x0306;|&#x00DB;&#x0304;|&#x00E7;&#x0306;|&#x00FB;&#x0304;|&#x00FF;&#x0301;|&#x010C;(&#x0315;|&#x0323;)|&#x010D;(&#x0315;|&#x0323;)|&#x012A;&#x0301;|&#x012B;&#x0301;|&#x017D;(&#x0326;|&#x0327;)|&#x017E;(&#x0326;|&#x0327;)|&#x1E32;&#x0304;|&#x1E33;&#x0304;|&#x1E62;&#x0304;|&#x1E63;&#x0304;|&#x1E6C;&#x0304;|&#x1E6D;&#x0304;|&#x1EA0;&#x0308;|&#x1EA1;&#x0308;|&#x1ECC;&#x0308;|&#x1ECD;&#x0308;|&#x1EE4;(&#x0304;|&#x0308;)|&#x1EE5;(&#x0304;|&#x0308;))*

    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
    PaymentRequest
    {
    "requestId": "XYZ12345-2021",
    "requestTimestamp": "2024-07-29T15:51:28.071Z",
    "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": {
    "name": "Mustermann",
    "firstName": "Max",
    "gender": "M",
    "isOrganization": true,
    "organizationName": "Bundesministerium der Finanzen",
    "address": {
    "street": "Wilhelmstraße",
    "houseNumber": "97",
    "addressLine": [
    "Dienstsitz Berlin",
    "Postanschrift: 11016 Berlin"
    ],
    "postalCode": "10117",
    "city": "Berlin",
    "country": "DE"
    }
    }
    }