API Requests

Overview

For GET requests, you can use one or more query parameters. In the response we will return a HTTP status code. Some endpoints return JSON bodies that include HAL (Hypertext Application Language) links.

Query Parameters

For most of our GET requests, one or more query parameters in the request URL can be used to specify the number of returned results and the number of pages returned.

ParameterTypeDescription
pageNumberintThe page number to control returned results into manageable sets. Default if not supplied: 1 pageNumber=1
pageSizeintThe page size to control returned results into manageable sets. Default if not supplied: 50 pageSize=50

HTTP Status Codes

ClearBank® requests return a HTTP status code to indicate the success or failure of a request. For successful requests, we return a HTTP 2XX status code. For failed requests, we return a HTTP 4XX or 5XX status code. Some endpoints return JSON response bodies that include errors and additional properties.

Status CodeDescription
200Success!
201Success!
202Request received successfully and is being processed
400Bad request. Something went wrong with the request. The response should include the reason why the request has failed
403Forbidden. Your API token does not have permissions to perform the request
404Not found. The resource you are looking for cannot be found
409Conflict. A request conflict with the current state of the server
500Internal server error
503Server error. Service unavailable

Example of a response containing detailed errors

{
"errors": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}