Contexto


Neste artigo, vamos apresentar como realizar a consulta de extrato por meio da V1 da nossa API. A consulta permite o uso de filtros como datas de início, fim e tipo de data a ser considerada. Recomendamos atenção especial para contas com alto volume transacional.


Pré-requisitos 


Antes de realizar a consulta do extrato, certifique-se de que:

  • Está autenticado com um token válido da nossa API;
  • Possui um client_id e client_secret ativos;
  • Já possui uma conta cadastrada.


1. Consulta de Extrato (V1)


▶️ Endpoint 


GET {{url}}/v1/accounts/{{accountId}}/statement


Exemplo com filtros aplicados: 


{{url}}/v1/accounts/{{accountId}}/statement?start=2025-01-02&ending=2025-01-08&dateType=REALIZATION 


2. Parâmetros de Consulta 


Parâmetro
Descrição
start
Data inicial da consulta (formato YYYY-MM-DD).
ending
Data final da consulta (formato YYYY-MM-DD).
dateType
Tipo de data a ser considerada no filtro. Aceita: REALIZATION ou ENTRY.



Explicação do dateType:

  • REALIZATION: Filtra pelas datas de lançamento das transações (creditDate);
  • ENTRY: Filtra pelas datas de entrada/recebimento das transações (entryDate).


⚠️ Observações Importantes

  • Em casos de períodos com alta movimentação, recomendamos utilizar filtros com períodos curtos, preferencialmente de até 1 dia;
  • Quando não utilizado o parâmetro dateType é aplicado como valor DEFAULT o ENTRY;
  • A consulta via V1 pode apresentar erro de timeout se ultrapassar 30 segundos de execução;
  • Para essas situações, recomendamos o uso da versão mais recente: Extrato V3, que oferece paginação e suporte a filtros mais precisos com data e hora.

 

Suporte


Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte