/collect/claim/{az}/payment/
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 |
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 Zahlungsmeldung
{
"Response": {
"bSuccess": true,
"aMessage": [
{
"sKey": "info",
"sValue": "Request successfully received"
}
]
}
}
🚫 Beispiel Response - fehlerhafte Zahlungsmeldung: Datum des Zahlungseinganges in der Zukunft
{
"bSuccess": false,
"aMessage": [
{
"sKey": "error",
"sValue": "AcceptanceDate must not be in the future"
},
{
"sKey": "code",
"sValue": "IKP241"
}
]
}