Claims
Below section describes error response codes from Client-API for claim operations.
- Error Response: POST/v1/{clientId}/create_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. currency 2. originalDueDate 3. currentDueDate 4. amount 5. primaryDebtor → debtorReference 6. primaryDebtor → contactInformation → country | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID | -Entity is wrong. Check the field mentioned for duplicate resource created 1. accountReference | {"ENTITYID":{"success":false,"messageIds":[],"messages":"messages": [ "[4002] ParameterInputError: Claim already exists in the system" ] }} |
- Error Response: POST/v1/{clientId}/update_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 200 OK Transaction status: failed | Invalid ID | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference 2. claimId | {"ENTITYID":{"success":false,"messageIds":[],"messages":["Error processing message "cmd.claim.update.v1""]}} |
- Error Response: POST/v1/{clientId}/import_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. currency 2. originalDueDate 3. currentDueDate 4. amount 5. primaryDebtor → debtorReference 6. primaryDebtor → contactInformation → country | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference | {"ENTITYID":{"success":false,"messageIds":[],"messages":["Error processing message "cmd.claim.import.v1""]}} |
- Error Response: POST/v1/{clientId}/debit_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. currency 2. originator 3. amount | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 400 Bad Request | Wrong value in JSON payload | -Check value for 1. originator → DCA/CLIENT | |
| 200 OK Transaction status: failed | Invalid ID | -Entity is wrong. Check the field mentioned for duplicate resource created 1. claimId | {"ENTITYID":{"success":false,"messageIds":[],"messages":["Error processing message "]}} |
- Error Response: POST/v1/{clientId}/credit_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. currency 2. originator 3. amount | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 400 Bad Request | Wrong value in JSON payload | -Check value for 1. originator → DCA/CLIENT | |
| 200 OK Transaction status: failed | Invalid ID | -Entity is wrong. Check the field mentioned for invalid resource 1. claimId | {"ENTITYID":{"success":false,"messageIds":[],"messages":["Error processing message "]}} |
- Error Response: POST/v1/{clientId}/resolve_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. ref 2. reason | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 400 Bad Request | Wrong value in JSON payload | -Check value for reason → * CLAIM_SOLD * CLAIM_PAID * FRAUDULENT * CLAIM_DISCARDED * CLAIM_DISCHARGED * CLAIM_INVALIDATED | |
| 200 OK Transaction status: failed | Invalid ID | -Entity is wrong. Check the field mentioned for duplicate resource created 1. claimId | {"ENTITYID":{"success":false,"messageIds":[],"messages":["Error processing message "]}} |
- Error Response: POST/v1/{clientId}/recreate_claims
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. currency 2. originalDueDate 3. currentDueDate 4. amount 5. primaryDebtor → debtorReference 6. primaryDebtor → contactInformation → country | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference -Check claim is deleted already otherwise it will fail |