Extrato- realizar a consulta do extrato
Permite que usuários autorizados acessem e recuperem informações detalhadas sobre transações para uma conta específica no sistema de pagamentos. Essa API otimiza a gestão financeira, fornecendo uma visão geral abrangente da atividade da conta, permitindo que os usuários acompanhem despesas, identifiquem tendências e tomem decisões financeiras informadas.
Funcionalidades Essenciais:
Recuperação do Histórico de Transações: Os usuários podem recuperar um histórico detalhado de transações associadas a uma conta específica, incluindo datas de transação, valores, descrições e informações do comerciante.
Filtragem e Classificação: A API permite que os usuários filtrem e classifiquem os dados das transações com base em diversos critérios, como intervalo de datas, tipo de transação e categoria do comerciante, facilitando a análise fácil de padrões de gastos específicos.
Integração com Software de Contabilidade: Os dados das transações recuperados podem ser integrados a softwares de contabilidade, automatizando o registro e a reconciliação de transações.
Requisição
| Campo | Tipo | Descrição | Obrigatoriedade |
|---|---|---|---|
| contaOrigem | Texto | Conta do lançamento com digito verificador. | Sim |
| cpfOperador | Texto | CPF do operador cadastrado na plataforma | Sim |
| page | Texto | Número da página do extrato | Sim |
| movementType | Texto | Tipo de movimentação filtrada: D para Débito, C para Crédito e A Para trazer ambos os tipos | Sim |
| finalDate | Texto | Data final da consulta | Não |
| initialDate | Texto | Data inicial da consulta | Não |
| refreshCache | Boleano | Limpar o cache da consulta | Não |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| message | Texto | Mensagem de retorno |
| period_summary-initial_date | Texto | Data de início da consulta |
| period_summary-final_date | Texto | Data final da consulta |
| initial_balance | Texto | Saldo inicial da consulta |
| final_balance | Texto | Saldo final da consulta |
| total_entries | Texto | Total de entradas |
| total_outputs | Texto | Total de saídas |
| last_date- date | Texto | Última data |
| last_date - hour | Texto | Última data hora |
| total | Texto | Saldo total |
| total_blocked | Texto | Saldo total bloqueado |
| Transactions- 0 | Texto | Bloco de transação |
| type | Texto | Tipo da transação dia fechado / transação |
| date | Texto | Data da transação |
| hour | Texto | Hora da transação |
| transaction_details - name | Texto | Nome do destinatário da transação |
| transaction_details - description | Texto | Descrição da transação |
| transaction_type | Texto | Tipo de transação |
| description | Texto | Descrição da transação |
| value | Texto | Valor da transação |
| category | Texto | são classificações de entrada e/ou saída na conta regulamentado pela Febraban. |
| Transactions | Texto | Bloco de fechamento do dia |
| type | Texto | Tipo da transação dia fechado / transação |
| summary_day | Texto | Data do fechamento por escrito |
| total_entries | Texto | Total de entradas do dia fechado |
| total_outputs | Texto | Total de saídas do dia fechado |
| total_balance | Texto | Saldo total do dia fechado |
| isNextPage | Boleano | Se existe ou não uma próxima página no período consultado |