Zum Hauptinhalt springen
Version: 1.0.0

Abfrage des Status der konkreten Konfiguration des Bezahldienstes.

GET 
/status/:originatorId/:endPointId

Abfrage des Status der konkreten Konfiguration des Bezahldienstes.

Request​

Path Parameters

    originatorId stringrequired

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

    Enthält die Kennung des auslösenden Online-Dienstes, z. B. den fachlichen Kontext.

    Example: MELD-ANT-FORM-4711
    endPointId stringrequired

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

    Enthält ein weiteres Ordnungskriterium für die Identifikation der zuständigen Behörde, z. B. den AGS

    Example: BERLIN

Responses​

Erfolgsmeldung auf Statusabfrage

Schema

    type uri

    Possible values: non-empty and <= 2082 characters

    Link auf eine Seite mit der Fehlerbeschreibung

    status int32

    Possible values: >= 100 and <= 511

    HTTP Response Code

    title string

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

    HTTP Response Text

    detail string

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

    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.

    functionalCode string

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

    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 grosAmount.
    • 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.

Loading...