Tratamento de Erros

Tabela de status de retorno

RetornoDescrição
200Requisição processada com sucesso
400Algum dado informado não pôde ser processado. Revise os dados e tente novamente a requisição — Ver item Tabela de Erros
500Erro interno de nossa API. Nós monitoramos as chamadas e para ser viável a identificação e tratativa da causa. Recomendamos tentar novamente a requisição e solicitar suporte técnico se necessário.

Tabela de erros

Ao receber um erro HTTP 400, o retorno da requisição informará mais detalhes do erro ocorrido para auxiliar na identificação de qual valor está sendo enviado e não processado.

O formato da mensagem é o campo field para o nome do campo, e message para a mensagem de erro. Os itens são retornado dentro de um array errors, conforme exemplo a seguir:

{
    "title": "Invalid request",
    "status": 400,
    "path": "/integration/v3/simulations/simulate",
    "message": "There are invalid arguments",
    "errors": [
        {
            "object": "simulacao",
            "field": "tipo_pessoa",
            "message": "Tipo de pessoa 'PESSOA_JURIDICA' inválido. Deve ser uma das opções [PF, PJ]."
        },
        {
            "object": "simulacao",
            "field": "data_emprestimo",
            "message": "A data '22-03-30' é inválida. Deve estar no formato yyyy-MM-dd."
        }
    ]
}