Errors

The API uses HTTP response codes to indicate the success or failure of a request. Codes in the 2xx range indicate success, codes in the 4xx range indicate an error in your request, and codes in the 5xx range indicate an error with interlace platform's servers.

In addition to the HTTP response code, most errors also include more detailed information about the problem in the response body. The detailed error message will be encoded in a JSON response under the error key.

Error:
    title: Error Entity
    description: An error entity which can be used at the API level for error responses
    properties:
    code:
        type: string
        description: Long term persistent identifier which can be used to trace error condition back to log information
    message:
        type: string
        description: End user displayable information which might help the customer diagnose an error
    type: object

Example Response

{
    "code": "InvalidCreditCard",
    "message": "Incorrect credit card number",
}

Sometimes, we may want to report more than one error for a request. In this case, we should return the errors in a list:

{
    "errors": [
         {
            "code": "InvalidCreditCard",
            "message": "Incorrect credit card number",
         },
         ...
    ]
}

For more information about our APIs please refer to our API Reference