Geração de Extrato Consolidado

Gera um extrato consolidado das transações do período informado e disponibiliza um link para download do arquivo (JSON ou OFX). O download do arquivo gerado é feito pelo endpoint público GET /api/statement/consolidated/files/{token}. Quando o arquivo fica pronto, uma notificação é enviada de forma assíncrona ao canal (Channel-Id) informando o link de download.

Método	POST
Path	/api/statement/consolidated
Autenticação	Authorization (Bearer token) + Channel-Id

Autenticação

Exige o header Authorization com um token válido e não expirado, emitido previamente para o integrador. Se ausente, mal formatado, ou o token for inválido/expirado, a API retorna 401 Unauthorized:

{ "error": "Token ausente ou inválido" }

ou

{ "error": "Token inválido" }

Também exige o header Channel-Id: <id_do_canal>. Se ausente, retorna 400 Bad Request:

{ "message": "Channel-Id header is required" }

Corpo da requisição

{
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "file_type": "json"
}

Campo	Tipo	Obrigatório	Descrição
start_date	string	Sim	Data inicial do período, formato YYYY-MM-DD
end_date	string	Sim	Data final do período, formato YYYY-MM-DD
file_type	string	Não	Formato do arquivo: json ou ofx. Qualquer valor diferente de json é tratado como ofx (padrão quando omitido)

Regras de validação do período

• start_date e end_date devem estar no formato YYYY-MM-DD.
• end_date não pode ser anterior a start_date.
• O intervalo máximo permitido é de 31 dias.

Respostas

200 OK — extrato gerado com sucesso:

{
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "link": "https://.../api/statement/consolidated/files/<token>?file_type=json",
  "expires_at": "2025-02-07T00:00:00Z",
  "groups": [
    {
      "status": "PAID",
      "total_amount": 1500.50,
      "items": [
        { "id": "tx-123", "amount": 500.00, "fee": 1.50 }
      ]
    }
  ]
}

400 Bad Request — corpo inválido, Channel-Id ausente, formato de data inválido, range de datas inválido, ou nenhuma movimentação encontrada no período:

{ "message": "Formato de data invalido. Use YYYY-MM-DD" }

{ "message": "Range maximo permitido e de 31 dias" }

{ "message": "Channel-Id header is required" }

Retenção

O arquivo gerado permanece disponível para download por um período limitado (padrão: 7 dias corridos), conforme descrito em Download de Extrato Consolidado.