🛠️ Documentação para Desenvolvedores

Bem-vindo à referência oficial da API do fnwallet-pix-service. Esta documentação foi desenhada para desenvolvedores que desejam integrar pagamentos Pix, gestão de faturas e relatórios financeiros diretamente em seus sistemas.

---

📌 Guia de Referência Rápida

Abaixo estão os módulos essenciais para a integração externa:

1. ⚡ Pix & Pagamentos: Receber Pix em tempo real.
2. 📊 Extratos e Saldos: Consultar movimentações e saldo disponível.

---

🔐 Autenticação e Cabeçalhos

Todas as requisições autenticadas devem incluir obrigatoriamente:

Header	Valor / Exemplo	Descrição
Accept	application/json	Garante que o servidor responda em JSON.
Authorization	Bearer {SEU_TOKEN}	Token de acesso para a API.
Content-Type	application/json	Necessário para requisições do tipo POST ou PUT.

TOKEN DE API

Você pode gerar um token JWT através do endpoint de Autenticação ou utilizar o seu API Token Estático para integrações permanentes.

---

🏗️ Convenções de Dados

Moeda e Valores

• Requisição: Envie os valores como float (Ex: 150.00 para R$ 150,00).
• Resposta: A API retorna os valores limpos ou objetos formatados para exibição.

Datas

• Utilizamos o padrão ISO 8601 (Ex: 2024-03-22T10:00:00Z).
• Campos de data simples devem estar no formato YYYY-MM-DD.

Formato de Resposta (Sucesso)

{
  "code": 200,
  "success": true,
  "data": { ... },
  "message": "Operação realizada com sucesso"
}

Formato de Erro

{
  "code": 400,
  "success": false,
  "message": "Descrição detalhada do erro."
}