Error handling

Understanding the response structure

A typical API response will follow the following structure unless explicitly mentioned in the API Reference:

{
    "code": 0,
    "data": {
        ...
    },
    "message": "SUCCESS"
}

Here, a code 0 means that the API returned a success response. We also added an explicit "SUCCESS" message to make it obvious.

Error codes and messages to expect

We have dedicates codes for different errors handled by us to enable our Gateway partners to write custom handling on top of them. All such errors are listed below:

Smart context in client-side errors

It is infuriating when an API returns "Invalid request payload" without specifying exactly what was wrong with the payload. We are well-versed with this issue and figured out an ingenious solution.

We append the error message with a suffix to provide additional context on what was specifically wrong with the request when throwing a client-side error (i.e. HTTP 4xx).

This will save our Gateway partners from integrating with dozens of error codes even for simple integrations, and, at the same time, allow a more advanced error handling for Gateway partners who want to take things to the next level.

Note that the error codes will remain the same. The suffix will only be added to the error message to provide additional context on the error.