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 |
|---|---|---|
| contaOrigem | Texto | Número da conta cadastrada na plataforma (opcional) |
| cpfOperador | Texto | CPF do operador cadastrado na plataforma (opcional) |
| page | Texto | Número da página do extrato (opcional) |
| movementType | Texto | Tipo de movimentação filtrada (opcional) |
| finalDate | Texto | Data final da consulta (opcional) |
| initialDate | Texto | Data inicial da consulta (opcional) |
| refreshCache | Boleano | Limpar o cache da consulta (opcional) | |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| message | Texto | Mensagem de retorno (opcional) |
| period_summary-initial_date | Texto | Data de início da consulta (opcional) |
| period_summary-final_date | Texto | Data final da consulta (opcional) |
| initial_balance | Texto | Saldo inicial da consulta (opcional) |
| final_balance | Texto | Saldo final da consulta (opcional) |
| total_entries | Texto | Total de entradas (opcional) |
| total_outputs | Texto | Total de saídas (opcional) |
| last_date- date | Texto | Última data (opcional) |
| last_date - hou | |Texto | Última data hora (opcional) |
| total | Texto | Saldo total (opcional) |
| total_blocked | Texto | Saldo total bloqueado (opcional) |
| Transactions- 0 | Texto | Bloco de transação (opcional) |
| type | Texto | Tipo da transação dia fechado \ transação (opcional) |
| date | Text | Data da transação (opcional) |
| hour | Text | Hora da transação (opcional) |
| transaction_details - name | Texto | Nome do destinatário da transação (opcional) |
| transaction_details - description | Texto | Descrição da transação (opcional) |
| transaction_type | Texto | Tipo de transação (opcional) |
| description | Texto | Descrição da transação (opcional) |
| value | Texto | Valor da transação (opcional) |
| Transactions | Texto | Bloco de fechamento do dia(opcional) |
| type | Texto | Tipo da transação dia fechado / transação(opcional) |
| summary_day | Texto | Data do fechamento por escrito (opcional) |
| total_entries | Texto | Total de entradas do dia fechado (opcional) |
| total_outputs | Texto | Total de saídas do dia fechado (opcional) |
| total_balance | Texto | Saldo total do dia fechado (opcional) |
| isNextPage | Boleano | Se existe ou não uma próxima página no período consultado(opcional) |