Dispute management response codes
This document outlines the response codes associated with the Dispute Management API. These codes are essential for understanding the status of API responses and are instrumental in diagnosing and resolving any issues that may arise from request submissions.
Relevant response fields
Besides httpStatus
, the rest of the following fields are only included in the body of an unsuccessful response and can be helpful for troubleshooting purposes:
httpStatus
: The response code that is returned to the client based on how a backend service handled the request.title
: Short human readable title of the error.context
: An array of objects for failed requests, comprising of the following fields:code
- The dispute managerment API employs the following numbering convention to indicate a specific type of issue:- 10** - Invalid/Missing mandatory field errors / Validation Failures
- 11** - Business Validation Failures
- 12** - Timeouts
- 13** - Other Errors
- 15** - System Errors
- 14** - Authentication/Authorization Failures
message
- Provides textual description of a problem that has occurred.field
- The field for which the error has occured.location
- Location of the field for which the error occurred in the request ["BODY","PATH","QUERY","HEADER"
]
Successful responses (200-299)
A 2XX
httpStatus code signifies that a request has been successfully processed.
httpStatus | Scenario | Relevant API endpoint(s) | |
---|---|---|---|
200 | Successfully retrieved a list of disputes. |
|
|
200 | Successfully retrieved dispute details. |
|
|
200 | Successfully retieved disputes status. |
|
|
200 | Successfully retieved a list of issuer documents. |
|
|
200 | Successfully challenged a dispute. |
|
|
200 | Successfully fulfilled a retrieval request. |
|
|
200 | Successfully accepted a dispute. |
|
Client error responses (400-499)
A 4XX
httpStatus code indicates that an error has occurred during a request, and provides a list of specific context code(s) and context message(s) to aid in troubleshooting. Address the problem and resubmit the request.
httpStatus |
context code | context message |
Relevant API endpoint(s) | |
---|---|---|---|---|
400 | 11002 | Document validation failed. |
|
|
400 | 11003 | No document found. |
|
|
400 | 11001 | Invalid document type provided. |
|
|
400 | 10001 | At least one of the MerchantId, DisputeId, startDateTime or endDateTime is required to retrieve status. |
|
|
400 | 10102 | Invalid Date range, either of the cases met. end date is prior to start date, start date or end date is future date. |
|
|
400 | 10001 | Mandatory field missing or invalid. |
|
|
400 | 10001 | Invalid value for parameter. |
|
|
400 | 10104 | Unsupported value. |
|
|
400 | 10908 | Invalid request. |
|
|
400 | 10105 | Please enter valid required headers. |
|
|
401 | 14000 | Authentication Failure. |
|
|
403 | 14001 | Authorization Failure. |
|
|
404 | 10107 | The dispute case does not exist. |
|
|
406 | 13007 | Action not allowed on the dispute case. |
|
|
422 | 10908 | Invalid request |
|
Server error responses (500-599)
A 5XX
httpStatus code indicates that an error has occurred within the J.P. Morgan environment during the request. Additional fields are provided in the body of the response to identify the error.
httpStatus | context code |
context message |
Relevant API endpoint(s) |
---|---|---|---|
503 | 12999 | Service Unavailable. |
|
503 | 13005 | Service Unavailable. |
|
503 | 13006 | Service Unavailable. |
|
503 | 13008 | Service Unavailable. | |
503 | 13009 | Service Unavailable. | |
503 | 13010 | Service Unavailable. | |
503 | 13011 | Service Unavailable. | |
503 | 13012 | Service Unavailable. |