For the complete documentation index, see llms.txt. This page is also available as Markdown.

Respostas e erros

As respostas da API do Falcon Finanças combinam o código HTTP com um envelope JSON padronizado.

Resposta de sucesso

{
  "success": true,
  "message": "",
  "data": {}
}

Resposta de erro

{
  "success": false,
  "message": "Descrição do erro",
  "data": null
}

Códigos mais comuns

Código
Significado
Ação recomendada

200

Requisição processada

Utilize os dados retornados.

400

Dados inválidos

Revise parâmetros, corpo e campos obrigatórios.

401

Não autorizado

Confira as credenciais ou obtenha um novo token.

404

Recurso não encontrado

Confira o identificador e o vínculo com o parceiro.

500

Erro inesperado

Registre o horário e acione o suporte sem enviar credenciais.

Boas práticas

  • Não considere somente o campo success; confira também o código HTTP.

  • Não repita automaticamente requisições que alteram dados sem analisar o resultado anterior.

  • Registre um identificador próprio da operação para facilitar a auditoria.

  • Em erros temporários, utilize novas tentativas com intervalo progressivo.

Atualizado