FinWise API
SupportChangelog

Errors

FinWise uses conventional HTTP status codes. 2xx succeeded. 4xx is a problem with the request. 5xx is on us.

Error bodies are wrapped in an error object:

Response attributes

nameenum
One of BadRequestError, AuthenticationError, AuthorizationError, NotFoundError, ConflictError, TooManyRequestsError.
messagestring
Human-readable summary of what went wrong.
codenullable string
Machine-readable reason, when there is one. A 403 with subscription_required means the API key's account has no active subscription; the key works again once the user resubscribes.
errorsnullable array of objects
Field-level issues for validation failures.
codestring
Machine-readable issue code, e.g. invalid_type.
messagestring
What was wrong with this field.
patharray of strings
Path to the field in the request.
Status codes
200  OK
400  Bad Request     — invalid or missing parameters
401  Unauthorized    — missing or invalid API key
403  Forbidden       — authenticated, but not allowed
                       (code subscription_required: no active subscription)
                       (a read-only API key on a write)
404  Not Found       — resource does not exist
409  Conflict
413  Payload Too Large
429  Too Many Requests
5xx  Server Error
Sample error
{
  "error": {
    "name": "BadRequestError",
    "message": "Invalid query parameters specified",
    "errors": [
      {
        "code": "invalid_type",
        "message": "Invalid date format, must use ISO format.",
        "path": ["date"]
      }
    ]
  }
}