Bezahlinformationen

paymentInformation

Diese Seite beschreibt den Bereich paymentInformation der Metadaten.

Dieser Bereich dient dazu, dem Empfänger eines Antrags (dem Verwaltungssystem) mitzuteilen, wie die antragstellende Person die Kosten für die Bearbeitung des Antrags beglichen hat.

Bezahlmethode

Der Sender (Onlinedienst) fügt unter paymentInformation.paymentMethod ein, welche Methode zum Bezahlen gewählt wird. Die folgenden Werte sind möglich: GIROPAY, PAYDIRECT, CREDITCARD, PAYPAL, INVOICE, OTHER.

Der Bereich paymentInformation kann fehlen, d.h. er ist optional (nicht erforderlich). Wenn der Bereich fehlt, dann bedeutet das, dass bislang noch keine Bezahlung erfolgt ist und dem Antragsteller ggf. eine Zahlungsaufforderung zu stellen ist.

Im folgenden Beispiel enthält der Bereich paymentInformation die Angabe, dass per Kreditkarte bezahlt wurde, weil unter paymentMethod der Wert CREDITCARD eingefügt wurde. Unter status steht im Beispiel der Wert BOOKED, d.h. der Antragsteller ist damit einverstanden, dass die Kreditkarte mit den Kosten belastet werden darf. Auf der Seite Überblick finden Sie weitere Details im Absatz Schema für Metadaten.

{
  "$schema": "https://schema.fitko.de/fit-connect/metadata/1.2.0/metadata.schema.json",

  // ...

  "paymentInformation": {
    "transactionUrl": "https://payment.bundesland.zzzz/api/v1/paymenttransaction/12002312/MELD-ANT-FORM-4711/2ec6dad2-5606-4a85-82bc-19521ed5e192",
    "transactionReference": "KA-2021-5678",
    "transactionId": "2ec6dcc2-5606-4a95-82bc-19521fd5e192",
    "paymentMethod": "CREDITCARD",
    "status": "BOOKED"
  }
}