Consolidação de Dados

Endpoints de uso interno ou administrativo para verificação cruzada de dados com as instituições bancárias.

---

Listagem de Boletos Sicredi

[GET] /v1/consolidation/sicredi/boletos

Consulta a lista de boletos registrados no Sicredi para uma data específica, útil para processos de conciliação.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	Bearer Token	Sim	Deve corresponder ao TOKEN_CONSOLIDATION configurado no sistema.

Query Params

Nome	Tipo	Obrigatório	Descrição
date	string	Não	Data para consulta no formato DD/MM/YYYY. Se omitido, utiliza a data de ontem.

Response (200 OK)

{
  "date": "26/12/2024",
  "total_boletos": 2,
  "boletos": [
    {
      "nosso_numero": "24100001",
      "status": "LIQUIDADO",
      "valor": 150.00,
      "identificador": "ch_7a8b9c",
      "pagador": "JOAO LIMA"
    },
    {
      "nosso_numero": "24100002",
      "status": "ABERTO",
      "valor": 250.00,
      "identificador": "ch_xyz123",
      "pagador": "ANA OLIVEIRA"
    }
  ]
}

---

Detalhes do Boleto (Sicredi)

[GET] /v1/consolidation/sicredi/boletos/{nossoNumero}

Busca os detalhes completos de um boleto diretamente na API do Sicredi.

Response (200 OK)

{
  "boleto": {
    "nossoNumero": "24100001",
    "status": "LIQUIDADO",
    "valorNominal": 150.00,
    "dataVencimento": "2024-12-25",
    "liquidacao": {
      "dataLiquidacao": "2024-12-24",
      "valorLiquidado": 150.00
    },
    "pagador": {
      "nome": "JOAO LIMA",
      "documento": "12345678901"
    }
  }
}

---

Outros Endpoints de Sistema

[GET] /

Endpoint de verificação de disponibilidade (Health Check).

Response (200 OK)

"ok"

[GET] /jobTeste

Dispara um job de teste para validação da fila de processamento.

Response (200 OK)

"disparado!"

---

---

Extrato Detalhado (Statement Detailed)

[GET] /v1/consolidation/transactions/statement-detailed

Fornece uma visão detalhada das movimentações financeiras, agrupadas por dia, com cálculos de saldo de abertura, fechamento e saldo progressivo (linha a linha) para cada transação. O saldo é recalculado linha a linha com base em todo o histórico anterior à página atual, garantindo precisão matemática mesmo em consultas paginadas.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	Bearer Token	Sim	Token de autenticação do usuário.
account	integer	Sim	ID da conta para a qual o extrato será gerado.

Query Params

Nome	Tipo	Obrigatório	Descrição
created_at_start	string	Não	Data inicial no formato YYYY-MM-DD. (Padrão: 30 dias atrás)
created_at_end	string	Não	Data final no formato YYYY-MM-DD. (Padrão: Hoje)
per_page	integer	Não	Quantidade de dias com transações por página. (Padrão: 15)
page	integer	Não	Número da página para navegação.
skip_empty	boolean	Não	Se true (padrão), oculta dias sem movimentação.

Response (200 OK)

{
  "code": 200,
  "success": true,
  "data": {
    "current_page": 1,
    "data": [
      {
        "date": "2024-03-15",
        "opening_balance": 1500.0,
        "closing_balance": 1650.0,
        "transactions": [
          {
            "id": 12345,
            "datetime": "2024-03-15 10:00:00",
            "description": "Recebimento PIX",
            "value": 200.0,
            "balance": 1700.0,
            "type": {
              "id": 1,
              "name": "PIX IN",
              "slug": "pix-in"
            },
            "metadata": {
              "payer": {
                "name": "Cliente Exemplo",
                "document": "12345678901"
              }
            }
          },
          {
            "id": 12346,
            "description": "Taxa de Serviço",
            "value": -50.0,
            "balance": 1650.0,
            "type": {
              "id": 3,
              "name": "TAXA",
              "slug": "tax-pix-in"
            },
            "metadata": null
          }
        ]
      }
    ],
    "first_page_url": "...",
    "from": 1,
    "last_page": 4,
    "last_page_url": "...",
    "links": [ ... ],
    "next_page_url": "...",
    "path": "...",
    "per_page": 1,
    "prev_page_url": null,
    "to": 1,
    "total": 20
  },
  "message": "Extrato detalhado recuperado com sucesso"
}

Erro de Validação (422 Unprocessable Entity)

{
  "code": 422,
  "message": "The payment date start field is required when payment date end is present. (and other errors)",
  "success": false,
  "data": {
    "created_at_start": ["O campo created_at_start não corresponde ao formato Y-m-d."]
  }
}

Erro de Autenticação (401 Unauthorized)

{
  "message": "Unauthenticated."
}