Padrão de erros

Temos formatos padronizados de erros retornados pela API seguindo padrão de resposta HTTP, convencionais pra indiciar sucesso ou falha, seja por erro interno da aplicação ou erro na integração.

As respostas com um código de status chamadas de 4xx ou 5xx podem ser consideradas como falhas, enquanto respostas 2xx significam que sua solicitação foi processada com sucesso.

Em nossos endpoints os erros podem se diferenciar de acordo com cada necessidade por isso recomendamos que navegue nas páginas de erros e confira os possíveis retornos.

🚧

Qualidade na integração

Para que seja possível manter a integração com qualidade e fazer o melhor uso das funcionalidades oferecidas, é importante entender os possíveis erro e garantir que as validações sejam feitas antes do envio.

Confira abaixo os principais códigos de retorno que utilizamos:

Informações da resposta

Mantemos um modelo de retorno onde buscamos fornecer informações para que seja possível entender o detalhe do erro de acordo com cada endpoint e suas especificidades, veja abaixo os campos retornados:

Exemplo de Response

{
    "code": "REQUEST_VALIDATION_ERROR",
    "message": "Some fields are not valid",
    "details": [
        {
            "target": "field",
            "message": "error description"
        }
    ]
}