📊 Consolidação e Financeiro

Endpoints para consulta de saldos em tempo real, extratos detalhados com filtros avançados e geração de comprovantes de transações em formato PDF.

---

💰 1. Saldo Bancário

Consultar Saldo Disponível

GET /consolidation/balance

Retorna o saldo livre para saques da sua conta, além da contagem de transações.

NOTA

O saldo já reflete todas as taxas aplicadas em recebimentos e pagamentos confirmados.

---

📝 2. Extrato de Transações (Extrato)

O extrato é a fonte de verdade para todas as movimentações financeiras da conta.

Listar Transações (Paginado)

GET /consolidation/transactions

Retorna o histórico detalhado, incluindo o saldo após cada operação.

Query Parameters (Filtros Avançados):

Campo	Tipo	Descrição
per_page	integer	Resultados por página (Ex: 50).
type_id	integer	Somente um tipo (Ex: PIX-OUT).
type_ids	array	Lista de IDs de tipos (Ex: [1, 5, 8]).
created_at_start	date	Início do período (YYYY-MM-DD).
created_at_end	date	Fim do período (YYYY-MM-DD).

Exemplo de Resposta (200 OK)

{
  "data": [
    {
       "id": 123,
       "datetime": "2024-03-22T10:00:00Z",
       "value": -150.00,
       "type": { "slug": "pix-out", "name": "Pix Solicitado" },
       "balance": 1350.50,
       "status": "COMPLETED"
    }
  ],
  "summary": [
    { "type_id": 1, "count": 10, "amount": 1500.00 }
  ]
}

---

📄 3. Comprovantes e Detalhes

Detalhes de uma Transação

GET /consolidation/transactions/{id}

Retorna todos os metadados brutos enviados pelo banco parceiro e o status atual.

Headers Recomendados:Accept: application/json

---

Baixar Comprovante (PDF)

GET /consolidation/transactions/{id}/download

Gera um arquivo PDF oficial com os dados da transação para fins fiscais ou de envio para o favorecido.

DICA

O link de download deve ser aberto diretamente no navegador ou via link de download, pois retorna o fluxo binário do PDF.

---

⚙️ 4. Tipos de Transação

GET /consolidation/transaction-types

Retorna os tipos de transações que podem aparecer no seu extrato. Útil para preencher filtros no seu painel de controle.

• pix-in: Recebimento.
• pix-out: Pagamento enviado.
• taxa: Débito de taxa de operação.
• estorno: Crédito por operação cancelada.