Felloh uses standard HTTP response codes to indicate the success or failure of API requests.

Status Codes

200OKThe request was successful
201CreatedThe request was successful, and a new resource was created
204No ContentThe request was successful, but there is no response to send back
400Bad RequestThe request was invalid, for example due to missing headers
401UnauthorizedAn access token wasn't provided, or the provided token was invalid
403ForbiddenA valid access token was provided, but it didn't have sufficient permissions
404Not FoundThe requested resource doesn't exist
406Not AcceptableThe response type you requested with your Accept header isn't supported
422Unprocessable EntityA validation error occurred
429Too Many RequestsYou made too many requests to the API in a short period of time
500Internal Server ErrorSomething went wrong on our side. Contact support or try again later.
502Bad GatewayThe server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
503Service UnavailableThe server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. Try again later.
504Gateway TimeoutThe server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. Try again later.

Error Responses

An example of a transaction not found error response:

"data": {},
"errors": [
"title": "Transaction not found",
"message": "The transaction id that you are attempting to access does not exist",
"documentation_url": "",
"type": "not_found",
"code": "transaction.not_found"
"meta": {
"request_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"status": 404

Our API provides detailed information on what exactly went wrong, included in the response body. Every error returned by the API includes:

titleA quick and simple description of what went wrong
messageA more detailed human-readable description of what went wrong
documentation_urlA URL pointing to a place in our documentation where you can read about the error
typeA machine-readable identifier for the general category of error
codeA machine-readable identifier for this specific error