Erros

Formatação padrão de erros

O formato padrão dos erros na API de Banking Gateway é JSON e as strings diferenciam os tipos de erros possíveis.

{
  "error_type": "string",
  "param": "string",
  "messages": ["string"]
}

Os campos possuem as seguintes descrições:

Campo	Descrição
`error_type`	Identifica o tipo de erro.
`param`	Parâmetro que ocasionou o erro.
`message`	Mensagem descritiva do erro em inglês.

Exemplo:

{
  "error_type": "missing_param",
  "param": "name",
  "messages": ["name is missing"]
}

No caso do erro acima o parâmetro name não foi passado, está em branco ou nulo.

Classes

Além dos tipos, nossos erros também possuem status que estão relacionados a alguns códigos HTTP. Os que aparecem na nossa API estão na lista abaixo.

Campo	Descrição
400	Erro na sintaxe de requisição.
422	Existe um problema por parte do parceiro que não permite que a requisição seja concluída.
401	Não autorizado.
403	Proibido.
404	Não encontrado.
500	Erros do servidor.

Lista de Erros

Abaixo está documentado todos os erros que podem ser encontrados ao utilizar a API, com uma breve descrição e uma possível solução para o problema.

error_type	Descrição	Solução
`blank`	Algum campo que foi passado está vazio	Verifique no campo `param` a indicação desse campo
`error_external_service`	Houve um erro ao solicitar um serviço externo	Aguarde alguns instantes, pois o serviço externo pode estar indisponível, caso o erro persista entre em contato com o desenvolvimento
`forbidden`	Ocorre quando você tem acesso à rota, mas por algum motivo não foi possível acessar ela com sucesso	Verifique se sua chave de API está correta, caso esteja e o erro continue entre em contato com o desenvolvimento
`greater_than`	Algum parâmetro passado precisa ser maior o valor especificado	Verifique o parâmetro informado no campo `param` e o limite indicado em `messages`
`greater_than_or_equal_to`	Algum parâmetro passado precisa ser maior ou igual ao valor especificado	Verifique o parâmetro informado no campo `param` e o limite indicado em `messages`
`insufficient_funds`	A `account`não tem fundos suficientes para realizar a operação. (atenção que caso a operação tenha custos adicionais estes estão envolvidos na verificação dos fundos)	Credite valor na `account`
`internal`	Ocorreu um erro interno do sistema	Aguarde alguns instantes para tentar novamente, caso o erro persista entre em contato com o desenvolvimento
`invalid`	Algum parâmetro passado está invalido (seja pela sua estrutura ou pelo seu valor)	Verifique o tipo da variável ou se o campo tem algum valor específico
`invalid_payment_account`	O usuário não possui uma conta de pagamento válida.	Realizar o processo de KYC.
`lesser_than`	Algum parâmetro passado precisa ser menor do que o valor especificado	Verifique o parâmetro informado no campo `param` e o limite indicado em `messages`
`lesser_than_or_equal_to`	Algum parâmetro passado precisa ser menor ou igual ao valor especificado	Verifique o parâmetro informado no campo `param` e o limite indicado em `messages`
`missing_param`	Algum parâmetro está faltando	Procure no campo `param` qual o parâmetro que está faltando
`not_found`	Alguma consulta usando um parâmetro que foi passado não teve correspondência, por exemplo um `account_id` que não existe	Procure no campo `param` qual parâmetro retornou esse erro de validação
`not_integer`	Algum parâmetro que deveria ser do tipo inteiro foi passado em outro formato	Procure no campo `param` qual parâmetro retornou esse erro de validação
`taken`	Algum parâmetro passado não pode ser utilizado, pois já tem um correspondente a ele e esse parâmetro é do tipo único	Troque o valor do parâmetro informado no campo `param`
`unauthorized`	Não é possível acessar a rota requisitada pois você não está autenticado.	Verifique se a rota está correta, caso esteja e você pense que isso é um erro entre em contato com o desenvolvimento