Errors

This page shows how is the errors format in Matic REST API

Matic REST API uses conventional HTTP status code to indicate whether the request failed or not. 2xx status codes indicate a success and 4xx and 500 are returned when things went wrong.

You will find the format of the successful response in each endpoint definition at our Matic REST API section. Here you will find the format for the failed requests.

Format

The format used for all the data is JSON and so our errors. The JSON structure for 4xx and 500 is the following:

4xx/500

{
    "code": 400,
    "name": "Error name",
    "description": "Error description"
}

422

{
    "code": 422,
    "name": "Error name",
    "description": "Error description",
    "errors": {
        "json|query|_schema|view_args": {
          "field_name": [
            "First validation error",
            "Second validation error"
          ],
          "second_field_name": [
            "First validation error",
            "Second validation error"
          ]
        }
    }
}

Error code summary

Matic has a set of error codes with an specific meaning.

HTTP status code	Description
400 - Bad request	The request could not be processed due business validations.
401 - Unauthorized	There was an error with the http credentials that you are using.
403 - Forbidden	You are not allowed to access to the resource.
404 - Not found	We could not find some ID referenced in your request.
405 - Method not allowed	You are using the HTTP method/verb incorrectly against the API endpoint URL.
500 - Internal server error	An error happened at Matic API end's. When this happen, we will be automatically notified so we can cover the irregular scenario.