PaymentInformation

Dieses Objekt enthält die Informationen vom Bezahldienst, die 1-zu-1 in den Antrag übernommen werden können. Die Antrags-API wird künftig angeglichen.

transactionUrlurirequired

Die Rest-URL der Payment Transaction für die Statusabfrage. Diese Information könnte aus den Informationen generiert werden. Eine explizite Ablage der URL dient der Robustheit der Schnittstelle.

Possible values: non-empty and <= 2082 characters

Example: https://payment.bundesland.zzzz/api/v1/paymenttransaction/12002312/MELD-ANT-FORM-4711/9xxd-432x-6543-xfd6-gfdx-fd27

transactionRedirectUrlurirequired

Die Redirect-URL an die der Online-Dienst den Benutzer weiterleiten soll. Diese URL öffnet die "Paypage" / "Bezahlseite" des Bezahldienstes. Diese URL muss nur im Status "INITIAL" (also bei der Post-Response oder Statusabfrage vor Abschluss / Abbruch der Transaktion) enthalten sein. Nach Abschluss der Transaktion sollte diese URL nicht enthalten sein.

Possible values: non-empty and <= 5000 characters

Example: https://portal.bundesland.zzzz/ui/doPayment/9xxd-432x-6543-xfd6-gfdx-fd27-CHECKSUM

transactionIdstringrequired

Eine vom Bezahldienst vergebene Transaktions-ID beim POST des Requests. Diese ID wird für die späteren Abfragen (GET) verwendet. Dies kann schon das Kassenzeichen sein. Sofern dies später vergeben wird, kann hier eine 'technische' ID des Bezahldienstes vergeben werden. Falls der Bezahldienst keine eigenen IDs hier verwendet, kann die Schnittstelle auch die Request-ID zurück geben.

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

Example: 9xxd-432x-6543-xfd6-gfdx-fd27

transactionReferencestring

Das "fachliche" Kennzeichen für eine Bezahlung. Dieses kann bei dem POST des Requests vom Bezahldienst vergeben werden oder erst nach der Autorisierung durch den Bezahler. Daher ist die relevante ID für diese Schnittstelle die transactionId, die durch den Bezahldienst bei der Anlage des Payment-Requests vergeben wird.

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

Example: KA-2020-1234

transactionTimestampdate-time

Zeitstempel der erfolgreichen Durchführung der Bezahlung.

paymentMethodstring

Die vom Benutzer ausgewählte Zahlart. Das Feld ist nur bei einer erfolgreichen Zahlung vorhanden / befüllt.

Possible values: [GIROPAY, PAYDIRECT, CREDITCARD, PAYPAL, OTHER]

Example: CREDITCARD

paymentMethodDetailstring

Weitere Erläuterung zur gewählten Zahlart.

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

Example: Visa

statusstringrequired

Der Status der Transaktion soll dem EfA-Onlinedienst erkennbar machen, ob die Bezahlung erfolgreich durchgeführt wurde.

• INITIAL - der Antrag hat einen Payment-Request ausgelöst und eine Payment-Transaction wurde angelegt. Der Nutzer hat aber im Bezahldienst noch keine Wirkung erzeugt. Der Benutzer kann mit dem Link zum Bezahldienst weitergeleitet werden. NEUE / Eränzende Info: Solange der Benutzer eine bestimmte Zahlart ausgewählt und abgebrochen hat - aber noch die Option hat, stattdessen eine andere Zahlart zu verwenden, so bleibt der Status auf INITIAL
• PAYED - der Nutzer hat die Bezahlung im Bezahldienst erfolgreich durchgeführt.
• FAILED - der Vorgang wurde vom Bezahldienst aufgrund der Nutzereingaben final abgebrochen.
• CANCELED - der Nutzer hat die Bezahlung im Bezahldienst final abgebrochen.

Possible values: [INITIAL, PAYED, FAILED, CANCELED]

statusDetailstring

Optionale ergänzende Erläuterungen zum Status. Diese Informationen werden Teil des Antrags und bieten dem Bezahldienst die Möglichkeit Informationen an das Fachverfahren / Sachbearbeitung zu schicken. Grundsätzlich ist dieses Feld nicht notwendig - Inhalte sind zwischen Bezahldienst und Fachverfahren abzustimmen.

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

Example: Transaktion XYZ wurde erfolgreich gebucht auf Konto ABC in Hoehe von 36EUR

PaymentInformation

{
  "transactionUrl": "https://payment.bundesland.zzzz/api/v1/paymenttransaction/12002312/MELD-ANT-FORM-4711/9xxd-432x-6543-xfd6-gfdx-fd27",
  "transactionRedirectUrl": "https://portal.bundesland.zzzz/ui/doPayment/9xxd-432x-6543-xfd6-gfdx-fd27-CHECKSUM",
  "transactionId": "9xxd-432x-6543-xfd6-gfdx-fd27",
  "transactionReference": "KA-2020-1234",
  "transactionTimestamp": "2024-07-29T15:51:28.071Z",
  "paymentMethod": "CREDITCARD",
  "paymentMethodDetail": "Visa",
  "status": "INITIAL",
  "statusDetail": "Transaktion XYZ wurde erfolgreich gebucht auf Konto ABC in Hoehe von 36EUR"
}