Novo Endpoint
A versão V3 do endpoint de extrato foi desenvolvida com foco em melhor desempenho e precisão para contas com alto volume de movimentações, além de substituir o antigo endpoint paginado da V2:
✅ Novo endpoint:
v3/accounts/{accountId}/statement❌ Substitui:
v2/accounts/{branch}/{account}/statement(será descontinuado em 22/07/2024)
A nova versão permitirá o uso de hora, minuto e segundo como filtro além da data, assim tornando possível a busca de informações de altos volumes.
| ⚠️ Observações Importantes A API V1 de extrato não será afetada e continuará funcionando normalmente. Caso utilize apenas a V1, nenhuma mudança será necessária. |
1. Como funciona a consulta nesta nova versão?
▶️ Endpoint
GET {{url}}/v3/accounts/{{accountId}}/statement
2. Parâmetros de Consulta
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
startDateTime | ✅ Sim | Data e hora inicial da consulta. Ex: 2024-06-12T09:00:00 |
endDateTime | Não | Data e hora final da consulta. Ex: 2024-06-12T23:59:59 |
pageSize | ✅ Sim | Quantidade de registros por página (1 a 100). Ex: pageSize=10 |
pageNumber | ✅ Sim | Página atual da consulta (inicia em 0). Ex: pageNumber=0 |
dateCategory | Não | Tipo de data usada no filtro. Aceita: ENTRY (padrão) ou INCOMING |
Detalhamento sobre dateCategory:
O valor ENTRY considera os registro de acordo com sua data de lançamento (creditDate) e o INCOMING considera os registros de acordo com a sua data de entrada (entryDate), sendo assim para que o filtro de data e hora funcione deve ser informado o valor INCOMING pois o entryDate exibe além da data o horário da transação, caso contrário será retornado os lançamentos considerando apenas o dia (creditDate) e o filtro de hora não funcionará.
3. Exemplo de uso paginado
Se o extrato possuir 8 lançamentos e for definido pageSize=2, a consulta será paginada em:
- pageNumber=0 → registros 1–2
- pageNumber=1 → registros 3–4
- ...
- pageNumber=3 → registros 7–8
❓ É possível obter o saldo final do dia nessa consulta?
Não. O endpoint V3 não retorna o saldo final do dia, mesmo utilizando ENTRY ou INCOMING.
✅ Alternativa:
Utilize o endpoint:
GET /v1/accounts/{accountId}/balance-period
Esse novo serviço permite consultar o saldo fechado de datas anteriores, sendo ideal para conciliadores e relatórios financeiros.
Acesse o artigo completo com mais detalhes
Suporte
Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte