The Veem API communicates errors through standard HTTP status codes with details supplied in the JSON response. Generally the following pattern applies:

  • 2xx - Veem received, understood, and accepted a request.
  • 3xx - The user agent must take further action in order to complete the request.
  • 4xx - An error occurred in handling the request. The most common cause of this error is an invalid parameter.
  • 5xx- Veem received and accepted the request, but an error occurred in the Veem service while handling it.

HTTP Error Codes

HTTP Status CodeDescription
200success
201created
302redirect
304not_modified
400bad_request
401unauthorized
403forbidden
404not_found
405method_not_allowed
409conflict
412precondition_failed
500internal_server_error
503unavailable

Error Code Response

NameTypeError
codeintegerThe API error code (different from the HTTP code)
errorstringShort Message
messagestringDetailed Message

Error code example:

{
  "code": "303",
  "error": "Invalid Payee Type",
  "Message": "Unexpected payee type entered"
}

The following table lists the most common error responses you are likely to see when using the Veem API. This list is not exhaustive; additional errors can occur. If your application handles all of these responses, though, then it's likely to be a robust application that gracefully handles the majority of user interactions and internet issues.