Novo Endpoint
Essa nova versão do endpoint (v3/accounts/{accountId}/statement), foi desenvolvida para atender algumas das solicitações de melhorias para consulta de extrato e substituir o endpoint de extrato paginado v2 (v2/accounts/{branch}/{account}/statement).
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. Para quem utiliza a versão de extrato paginado V2 será obrigatório realizar a migração para v3 pois o antigo será desabilitado em 22/07/2024.
(Obs.: A API V1 de extrato não será afetada e continuará funcionando normalmente. Caso utilize apenas a V1 não será necessária nenhuma mudança)
Como funciona a consulta nessa nova versão?
O endpoint para consulta é {{url}}/v3/accounts/{{accountId}}/statement e possui os seguintes parâmetros de consulta:
startDateTime* - Data inicial de consulta do extrato, exemplo: startDateTime=2024-06-12T09:00:00
endDateTime - Data final de consulta do extrato, exemplo: endDateTime=2024-06-12T23:59:59
pageSize* - Quantidade de registros por página, o valor deve ser maior ou igual a 1 e menor ou igual a 100, exemplo: pageSize=10
pageNumber* - Número da pagina atual, os registros iniciam na pagina 0, sendo assim se houver 8 lançamentos no extrato e for definido por exemplo um pageSize=2 os lançamentos serão divididos em 4 paginas sendo a inicial pageNumber = 0 e final pageNumber = 3
dateCategory - tipo de data no filtro de consulta, podendo ser utilizado ENTRY ou INCOMING caso não seja informado esse parâmetro o valor default será ENTRY.
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á.
*Parâmetros obrigatórios para consulta
É possível obter o saldo final do dia nessa consulta de extrato?
Não, esse endpoint não retorna em sua consulta o saldo final do dia com a utilização dos parâmetros ENTRY e INCOMING, assim como retornado na v1 quando utilizado o dateType=REALIZATION, porém foi desenvolvido um novo endpoint (/v1/accounts/{accountId}/balance-period) onde é possível realizar a consulta de saldo de uma data específica.
O grande benefício deste novo serviço é permitir a consulta de saldo fechado em datas anteriores.
Para mais detalhes acesse o nosso artigo em: https://ipflagship.freshdesk.com/a/solutions/articles/67000735119