Tratamento de erros

Sempre que houve algum problema na requisição (seja um parâmetro inválido, problema na autenticação ou um erro interno), a API retornará um erro. Ele sempre possuirá alguns campos que ajudam a identificar a causa do problema:

Código

Representa o tipo do erro. Em sua maioria, os erros possuem sub-erros que descrevem mais detalhes sobre sua causa. São estes os valores de código possíveis:

  • UNAUTHORIZED: Não autorizado. Normalmente representa um problema de autenticação com a API.

  • FORBIDDEN: Ação não permitida.

  • INTERNAL_SERVER_ERROR: Erro interno da aplicação.

  • BAD_REQUEST_BODY: Requisição mal construída. Normalmente acontece quando o body não corresponde ao formato esperado.

  • NOT_FOUND: Recurso não encontrado.

Mensagem

Este campo contém uma mensagem legível sobre a causa do problema.

Sub-erros

É uma lista de detalhes mais específicos sobre a causa do(s) problema(s). Cada sub-erro também possui um código e mensagem específicos. São estes os valores de código de sub-erro possíveis:

  • INVALID_TOKEN: Token inválido.

  • INVALID_ID: ID do recurso inválido.

  • ASSET_CODE_ALREADY_EXISTS: Você já emitiu um Ativo com este código. O código de Ativo é único por Conta emissora.

  • FROM_NOT_FOUND: Remetente não encontrado.

  • TO_NOT_FOUND: Destinatário não encontrado.

  • ASSET_NOT_FOUND: Ativo não encontrado.

  • UNDERFUNDED: Saldo insuficiente para realizar esta operação.

  • INVALID_ACTION_TYPE: Tipo de Ação inválido.

  • BATCH_LIMIT_EXCEEDED: Limite do lote excedido.

  • FIELD_NOT_FOUND: Campo não encontrado. Neste caso, o sub-erro possui uma propriedade chamada field indicando o nome do campo.

  • TRIGGER_INVALID_TYPE: Tipo de Trigger inválido.

  • TRIGGER_INVALID_CONDITION: Condição inválida para Trigger.

  • ACCOUNT_ALREADY_HAS_CREDENTIAL: Esta Conta já possui um par de Credenciais.

  • PERMISSION_DENIED: Suas credenciais não possuem permissões para executar esta requisição.

  • INTEGRATION_NOT_ENABLED: Integração não habilitada.

  • INTEGRATION_SERVICE_NOT_ENABLED: Este serviço não está habilitado para Integração.

  • INTEGRATION_ALREADY_ENABLED: Integração já habilitada.

  • MISSING_KYC: Para realizar esta operação, é necessário que esta Conta possua KYC.

  • INVALID_AMOUNT: Montante inválido.

  • INVALID_FIELD: Campo passado com valor inválido. Neste caso, o sub-erro possui uma propriedade chamada field com o nome do campo.

  • FIELDS_WITH_INVALID_VALUE: Valor inválido para o campo fields.

  • INVALID_INTEGRATION_NAME: Nome de Integração inválido.

  • INVALID_INTEGRATION_SERVICE: Nome de Serviço inválido para esta Integração.

  • INVALID_EXPIRATION_DATE: Data de expiração inválida.

  • INTERNAL_SERVICE_ERROR: Erro interno do servidor.

  • INVALID_BOLETO_BAR_CODE: Código de barras do boleto inválido.

  • KYC_ALREADY_ADDED: Esta Conta já possui KYC.