Errors

If an error occurs during a request, the API returns an HTTP status code >=400 and provides more
information in the response-body.

Error Object Structure

Examples:

{
  "error": {
    "code": 1000,
    "data": {
      "bank_code": ["Not a valid string."],
      "credentials": ["Credentials must contain at least 2 strings."]
    },
    "description": "Request body doesn't match input schema.",
    "group": "client"
  }
}

{
  "error": {
    "code": 1002,
    "data": {},
    "description": "Not Found",
    "group": "client",
  }
}

Error Codes

Error codes are grouped in ranges

whereas each code has the following meaning

Resource locked

With ongoing improvements on our system, at any point, a resource might return the HTTP status code 423 and the error code 1008. Your application should implement a retry logic with incremental backoff in the realm of seconds and up to minutes.

The most likely scenario where this happens is after a version change that requires data migration. The first request to an unmigrated user would then trigger such a response, consecutive calls might return 423 until migration is done.