Erros

Todas as respostas de erro seguem o mesmo formato:

{ "code": "idempotency_conflict", "message": "Idempotency-Key já usada com outros dados", "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e" }

• code é estável: use-o para tratar o erro no seu código.
• message é um texto descritivo e pode mudar sem aviso.
• requestId é o mesmo valor do header X-Request-Id. Informe-o ao entrar em contato com o suporte.

O endpoint de token segue o padrão OAuth (RFC 6749): { "error": "invalid_client", "error_description": "..." }.

Códigos HTTP

HTTP	Quando	O que fazer
400	Dados inválidos: CPF, celular, Idempotency-Key, corpo	Corrija a requisição: repeti-la sem alterações resulta no mesmo erro.
401	Token ausente, inválido ou expirado	Peça um token novo e repita.
403	Canal inativo ou IP não autorizado	Entre em contato com a Eagle IX.
404	Recurso inexistente ou pertencente a outro canal	Verifique o id.
409	Idempotency-Key já usada com outros dados, ou transição de status inválida	Use uma chave diferente para cada indicação (ou não envie a chave) e verifique o status atual.
429	Muitas tentativas inválidas no endpoint de token	Aguarde o tempo indicado em Retry-After.
503	Serviço ou banco parceiro indisponível	Repita a chamada mais tarde (com a mesma Idempotency-Key, se você enviou uma).

Códigos específicos

code	Onde	Significado
cpf_invalido	Criar link	CPF com tamanho ou dígitos verificadores inválidos.
celular_invalido	Criar link	Celular fora do formato DDD + 9 dígitos.
referencia_invalida	Criar link	referenciaExterna acima de 200 caracteres.
idempotency_key_invalida	Criar link	Header informado fora do formato (8 a 100 caracteres: letras, números, _ . : -).
idempotency_conflict	Criar link	A mesma chave já foi usada com outros dados.
url_invalida	Webhooks	A URL não é https com domínio público.
eventos_invalidos	Webhooks	A lista contém um tipo de evento desconhecido.
sem_proposta	Simulação de status	O cliente ainda não enviou a proposta.
transicao_invalida	Simulação de status	O status solicitado retrocederia a proposta.
status_invalido	Simulação, entregas, caixa de entrada	Valor de status fora dos aceitos.
nao_encontrado	Webhooks, caixa de entrada	Nenhum webhook ou caixa de entrada cadastrado para o canal.