{
    "message": "The provided amount is invalid",
    "devMessage": "Amount must be greater than 0",
    "statusCode": 400,
    "code": "VALIDATION",
    "data": {
      "field": "amount",
      "value": -100
    },
    "docUrl": "https://docs.getivy.de"
  }

​
Status Codes

We follow the HTTP status code conventions. See the HTTP Status Code Summary for more details. 2xx Range (Success): Codes in this range indicate a successful API request. This means the requested operation was completed as expected. 4xx Range (Client Errors): Codes in this range indicate an error related to the client’s request. These errors may occur due to missing required parameters, payment failures, or other client-specific issues. 5xx Range (Server Errors): These codes indicate an issue with Ivy’s servers. When you encounter a code in this range, it signifies an error on Ivy’s side rather than an issue with the client’s request. Understanding these response codes helps developers work with Ivy’s API effectively and handle different scenarios appropriately, ensuring smooth and reliable integration.

​
Error Structure

​
message
string
required
A user-friendly message explaining the error in a way that end users can understand.
​
devMessage
string
required
A human-readable message providing additional details about the error, primarily intended for developers.
​
statusCode
number
required
The HTTP status code that corresponds to the error.
​
data
object
required
Additional error context.
​
docUrl
string
required
A URL to the documentation for the error.
​
code
string
required
A short string indicating the specific error code. Possible values include:
  • GENERIC
  • VALIDATION
  • AUTHENTICATION
  • UNAUTHENTICATED
  • REQUEST_FAILED
  • AUTHORIZATION
  • NOT_FOUND
  • NOT_ACCEPTABLE
  • CONFLICT
  • LOCKED
  • TOO_MANY_REQUESTS
  • INTERNAL_SERVER_ERROR
  • SERVICE_UNAVAILABLE

​
Example

  {
    "message": "The provided amount is invalid",
    "devMessage": "Amount must be greater than 0",
    "statusCode": 400,
    "code": "VALIDATION",
    "data": {
      "field": "amount",
      "value": -100
    },
    "docUrl": "https://docs.getivy.de"
  }