Skip to content
Last updated

Responses

The Open Banking API returns standard HTTP status codes. Most endpoints return Json-Encoded responses. Some endpoints also return contextual HATEOAS links.

Codes in the 2xx range indicate success. Codes in the 4xx range indicate that the information provided for the request is invalid. Codes in the 5xx range indicate an error in the Open Banking servers.

Http Status Codes

Successful Requests (2xx)

Status CodeDescription
200 OKThe request succeeded.
201 CreatedThe request succeeded, and a new resource was created as a result.
202 AcceptedThe request has been received but not yet acted upon.
204 No ContentThe request succeeded, but without a response body.

Failed Requests (4xx)

Status CodeDescription
400 Bad RequestThe request was unacceptable, usually due to missing a required parameter. See Validation Errors.
401 UnauthorizedThe access token could not be authenticated.
401 UnauthorizedThe access token did not have permissions to the requested resource.
403 ForbiddenThe access token did not have permissions to perform the request.
404 Not FoundThe requested resource was not found.
405 Method Not AllowedThe request method is known by the server but is not supported by the target resource. Example: PATCH.
406 Not AcceptableThe server cannot use the client-request media type to return the response payload. (The request is most likely missing an Accept: application/json header.)
409 ConflictThe request conflicts with the current state of the server. (Most likely due to a resource that already exists.)
415 Unsupported Media TypeThe media format of the requested data is not supported by the server. (The request is most likely missing a Content-Type: application/json header.)
429 Too Many RequestsToo many requests in a given amount of time.

Server Error Responses (5xx)

Status CodeDescription
500 Internal Server ErrorAn unhandled system or application error occurred.
501 Not ImplementedThe request method is not supported by the server and cannot be handled. (Most likely due to a feature that has not been implemented yet.)
503 Service UnavailableThe server is not ready to handle the request. (The server might be overloaded or down for maintenance.)
504 Gateway TimeoutThis error response is given when the server is acting as a gateway and cannot get a response in time. (Most likely due to an unavailable service dependency.)