Errors

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

Status Codes

Code	Reason	Description
200	OK	The request was successful
201	Created	The request was successful, and a new resource was created
204	No Content	The request was successful, but there is no response to send back
400	Bad Request	The request was invalid, for example due to missing headers
401	Unauthorized	An access token wasn't provided, or the provided token was invalid
403	Forbidden	A valid access token was provided, but it didn't have sufficient permissions
404	Not Found	The requested resource doesn't exist
406	Not Acceptable	The response type you requested with your Accept header isn't supported
422	Unprocessable Entity	A validation error occurred
429	Too Many Requests	You made too many requests to the API in a short period of time
500	Internal Server Error	Something went wrong on our side. Contact support or try again later.
502	Bad Gateway	The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
503	Service Unavailable	The 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.
504	Gateway Timeout	The 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":  "https://developers.felloh.com/transaction",
      "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:

Name	Description
title	A quick and simple description of what went wrong
message	A more detailed human-readable description of what went wrong
documentation_url	A URL pointing to a place in our documentation where you can read about the error
type	A machine-readable identifier for the general category of error
code	A machine-readable identifier for this specific error