This website uses Cookies to provide you with the best possible service. Please see our Privacy Policy for more information. Click the check box below to accept cookies. Then confirm with a click on "Save".  

/collect/claim/{az}/close/

Response Daten

Bei einer erfolgreichen Anfrage HTTP-Statuscode = 200 werden als Antwort immer folgende Datentypen als JSON encoded String zurückgeliefert:

Response ⬆️

Das Response Objekt wird sowohl bei erfolgreichen als auch fehlerbehafteten Antworten zurückgeliefert

Feld Beschreibung Feldeigenschaften mögliche Werte
bSuccess Zeigt an, ob eine Anfrage an das Inkassosystem erfolgreich war type: boolean true oder false
aMessage Beinhaltet zusätzliche Informationen zum Anfrageergebnis type: array of collectResponseMessage siehe collectResponseMessage

Data ⬆️

Das Data Objekt wird nur bei erfolgreichen Anfragen (bSuccess=true) befüllt. Im Fehlerfall ist deren Wert null.

Feld Beschreibung Feldeigenschaften mögliche Werte
AcceptanceDate technisches Annahmedatum type: string
format: date		 example: "2023-10-11"

collectResponseMessage ⬆️

Beinhaltet zusätzliche Informationen zum Anfrageergebnis.

Feld Beschreibung Feldeigenschaften mögliche Werte
sKey Gibt die Art der Information an type: string "code"
"info"
"error"
sValue Information in textueller Form type: string example: "Operation successful"

✅ Beispiel Response - erfolgreiche Stornierungsanfrage

{
  "Response": {
    "bSuccess": true,
    "aMessage": [
      {
        "sKey": "info",
        "sValue": "Request successfully received"
      }
    ]
  }
}

🚫 Beispiel Response - fehlerhafte Stornierungsanfrage: mehrfaches Absetzen des Requests

{
  "bSuccess": false,
  "aMessage": [
    {
      "sKey": "error",
      "sValue": "Close process is already in progress"
    },
    {
      "sKey": "code",
      "sValue": "IKP230"
    }
  ]
}