Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. 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 http code and error message to figure out what has gone wrong. If you cannot figure out what is going wrong, you can always contact our support team!


Status codes

Here is a list of the different categories of status codes returned by the OnRamp 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.

  • Name
    5xx
    Description

    A 5xx status code indicates a server error.


Error types

Whenever a request is unsuccessful, the OnRamp API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the OnRamp API — use these to understand what is going wrong.

  • Name
    message
    Description

    This means that the error is because of an incorrect API Key configuration or missing headers.

  • Name
    error
    Description

    This means that there was an error with the data send.

Was this page helpful?