API Error Codes
Funnel Leasing uses conventional HTTP response codes to indicate the success or failure of an API request. Here is a general overview:
- Codes in the
2xx
range indicate success. - Codes in the
4xx
range indicate an error due to the provided information. - Codes in the
5xx
range indicate a server error on Funnel Leasing’s end.
Some 4xx
errors include an error code that explains the issue with a human-friendly message.
Attributes
- code:
integer
- Represents the specific error code returned by the API. - message:
nullable string
- A human-readable message describing the error. - param:
nullable string
- The parameter that caused the error (if applicable).
HTTP Status Code Summary
Code | Status | Description |
---|---|---|
200 | OK | Everything worked as expected. |
400 | Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 | Unauthorized | No valid API key provided. |
403 | Forbidden | The API key doesn’t have permissions to perform the request. |
404 | Not Found | The requested resource doesn’t exist. |
429 | Too Many Requests | Too many requests hit the API too quickly. Try exponential backoff. |
500, 502, 503, 504 | Server Errors | Something went wrong on Funnel Leasing’s end. |