Introduction

Sections

Theme switcher

Errors

In this guide, we will explore potential challenges that you might come across and discuss effective strategies for managing them. By addressing these issues, you can significantly enhance the efficiency of your development process.


Trace Request

On every response and webhook transaction a header is sent to track it, the name of this header is X-Trace-Id.

This information will be ask on any support request made so we can speed up the solution of any error ocurred.

Error response

If the request has not been successful, you will receive a JSON with the following attributes:

error_code: The error code that has occurred.

message: A message that describes the error.


Example

error_codestring
messagestring
Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 { "error_code": "API_ERROR", "message": "Access denied. The API Key is not authorized to do this operation." }

Error Codes

200-201

The request executed had finished successfully.

400

The request is not valid, due to some unpredictable error. If you are using a POST, PUT or PATCH request, check that the body is valid. If you are using a GET request, check that the parameters are correct. If you are using a DELETE request, check the path.

401

The API Key is not authorized to do this operation. Check that your API Key had been correctly configured.

404

The requested resource does not exist. Some of the information needed to do this request was not found.

412

The request was not completed because an internal validation was not fulfilled. Check that the body of the request is valid.

500

Our APIs are currently experiencing issues. This is an error on our side, we will check as soon as possible. Please contact support and try again later.

Was this section helpful?

What made this section unhelpful for you?