Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the reason message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 87% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Protocol support.

Status codes

Here is a list of the different categories of status codes returned by pasby™-API. Use these to understand if a request was successful.

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error — this means it's a you problem.
Name
5xx
Description
A 5xx status code indicates a server error — you won't be seeing these.

Error structuring

Whenever a request is unsuccessful, pasby™ returns an error response with a status text and reason. You can use this information to better understand what has gone wrong and how to fix it. Most of the error messages are helpful and actionable.

Error response

{
  "status": "failed",
  "message": "Request has expired",
}