Zum Hauptinhalt springen
Version: 1.1.0

SystemResponse

Systemmeldung entsprechend RFC7807

typeuri

Link auf eine Seite mit der Fehlerbeschreibung

Possible values: non-empty and <= 2082 characters

Example: https://docs.fitko.de/xbezahldienste/API-SystemResponse/
statusint32

HTTP Response Code

Possible values: >= 100 and <= 511

Example: 400
titlestring

HTTP Response Text

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

Example: Bad Request
detailstring

Funktionale Beschreibung des Fehlers. Hier sollen aber nur 'fachliche Beschreibungen' erfolgen. Aus Sicherheitsgründen sollten die Bezahldienste hier keine Systeminterna herausgeben. Eine Referenz-Nummer für den Austausch zwischen den Betriebsorganisationen scheint sinnvoll.

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

Example: In den BookingData fehlen die für diesen Bezahldienst notwendigen Felder Kapitel, Titel, TitelKennz, TitelZusatz
functionalCodestring

Die genauen Ausprägungen der Funktionalen Response müssen noch diskutiert werden. Arbeitsthese:

  • NO_VALID_ORIGINATOR_OR_DESTINATION - Deprecated - siehe nächsten Punkt.
  • NO_VALID_ORIGINATOR_OR_ENDPOINT - Der Mandant kann anhand OriginatorID und EndPointID nicht ermittelt werden.
  • PAYMENT_EXISTS - Mit dieser Transaktions-ID wurde bereits ein PaymentRequest platziert.
  • CALCULATION_ERROR - Die Summe des PaymentRequests passt nicht zu den Positionen - z.B. fehlerhafter grossAmount.
  • BOOKING_DATA_MISSING - Notwendige Daten für die Verbuchung (in bookingData) fehlen - genaue Beschreibung im functionalText.
  • VALIDATION_ERROR - Andere Validierungsfehler / semantische Fehler wie z.B. nicht unterstützte Währung.
  • UNSPECIFIED - Alle Fehler, die hier aktuell nicht konkret definiert sind.
  • FORBIDDEN - Fehlende Authentisierungsdaten oder keine Authorisierung in diesem Kontext.

Possible values: [NO_VALID_ORIGINATOR_OR_DESTINATION, NO_VALID_ORIGINATOR_OR_ENDPOINT, PAYMENT_EXISTS, CALCULATION_ERROR, BOOKING_DATA_MISSING, VALIDATION_ERROR, UNSPECIFIED, FORBIDDEN]

Example: BOOKING_DATA_MISSING
SystemResponse
{
  "type": "https://docs.fitko.de/xbezahldienste/API-SystemResponse/",
  "status": 400,
  "title": "Bad Request",
  "detail": "In den BookingData fehlen die für diesen Bezahldienst notwendigen Felder Kapitel, Titel, TitelKennz, TitelZusatz",
  "functionalCode": "BOOKING_DATA_MISSING"
}