/collect/claim/{az}/status/

Die OpenAPI Spezifikation dieser API stellen wir als yaml Datei zur Verfügung: /v2.2/api/validate.openapi.yaml

Statusabfrage einer bestehenden Forderung im mediaFinanz Inkassosystem

Request

Bei der Anfrage ist das Aktenzeichen der Forderung im Pfad für {az} zu übergeben.
Der eigentliche HTTP Request Body bleibt hierbei leer.

Aktenzeichen Bedingungen

• Das Aktenzeichen im Pfad muss eine Länge von 11 Zeichen aufweisen
• Das Aktenzeichen im Pfad muss allein aus Zahlen bestehen

Beispiel Anfrage mit Aktenzeichen 12345678901 im Pfad

curl -X 'GET' \
'https://test.api.mediafinanz.de/v2.2/collect/claim/12345678901/status/' \
-H 'accept: application/json' \
-H 'uuid: …' \
-H 'user: …' \
-H 'password: …'

Request mit Validierung

Sie können Ihre Anfrage gegen die Schnittstelle explizit validieren lassen, indem im Header der Wert validate: 1 mitgesendet wird.

Bedeutung

• Die Anfrage wird nur validiert, nicht verarbeitet (wird bspw. nicht entgegengenommen und gespeichert)
• Die Rückgabe enthält eine Auswertung der Validierung

Beispiel: Anfrage mit nicht-korrektem Aktenzeichen-Wert XYZ123

curl -X 'GET' \
'https://test.api.mediafinanz.de/v2.2/collect/claim/XYZ123/status/' \
-H 'accept: application/json' \
-H 'validate: 1' \
-H 'uuid: …' \
-H 'user: …' \
-H 'password: …'

Response

{
  "bSuccess": false,
  "aMessage": [],
  "aValidationResult": [
    {
      "name": "az",
      "code": "error_pattern",
      "value": "XYZ123",
      "in": "path",
      "pattern": "^\\d{11}$"
    }
  ]
}

• Die Rückgabe enthält Hinweise auf die fehlerhafte Übermittlung
• Der übergebene Aktenzeichen "name": "az", Wert "value": "XYZ123", im Pfad "in": "path",
• entspricht nicht der Syntax "pattern": "^\\d{11}$" (digits "Zahlen", 11 Zeichen)