v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Extrato

Realizar a consulta do extrato

Extrato- realizar a consulta do extrato<br/>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.<br/><br/>Funcionalidades Essenciais:<br/>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.<br/>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.<br/>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.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>contaOrigem</td><td>Texto</td><td>Conta do lançamento com digito verificador.</td><td>Sim</td></tr><tr><td>cpfOperador</td><td>Texto</td><td>CPF do operador cadastrado na plataforma </td><td>Sim</td></tr><tr><td>page</td><td>Texto</td><td>Número da página do extrato </td><td>Sim</td></tr><tr><td>movementType</td><td>Texto</td><td>Tipo de movimentação filtrada: <b>D</b> para Débito, <b>C</b> para Crédito e <b>A</b> Para trazer ambos os tipos</td><td>Sim</td></tr><tr><td>finalDate</td><td>Texto</td><td>Data final da consulta </td><td>Não</td></tr><tr><td>initialDate</td><td>Texto</td><td>Data inicial da consulta </td><td>Não</td></tr><tr><td>refreshCache</td><td>Boleano</td><td>Limpar o cache da consulta </td><td>Não</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de retorno </td></tr><tr><td>period_summary-initial_date</td><td>Texto</td><td>Data de início da consulta </td></tr><tr><td>period_summary-final_date</td><td>Texto</td><td>Data final da consulta </td></tr><tr><td>initial_balance</td><td>Texto</td><td>Saldo inicial da consulta </td></tr><tr><td>final_balance</td><td>Texto</td><td>Saldo final da consulta </td></tr><tr><td>total_entries</td><td>Texto</td><td>Total de entradas </td></tr><tr><td>total_outputs</td><td>Texto</td><td>Total de saídas </td></tr><tr><td>last_date- date</td><td>Texto</td><td>Última data </td></tr><tr><td>last_date - hour</td><td>Texto</td><td>Última data hora </td></tr><tr><td>total</td><td>Texto</td><td>Saldo total </td></tr><tr><td>total_blocked</td><td>Texto</td><td>Saldo total bloqueado </td></tr><tr><td>Transactions- 0</td><td>Texto</td><td>Bloco de transação </td></tr><tr><td>type</td><td>Texto</td><td>Tipo da transação dia fechado / transação </td></tr><tr><td>date</td><td>Texto</td><td>Data da transação </td></tr><tr><td>hour</td><td>Texto</td><td>Hora da transação </td></tr><tr><td>transaction_details - name</td><td>Texto</td><td>Nome do destinatário da transação </td></tr><tr><td>transaction_details - description</td><td>Texto</td><td>Descrição da transação </td></tr><tr><td>transaction_type</td><td>Texto</td><td>Tipo de transação </td></tr><tr><td>description</td><td>Texto</td><td>Descrição da transação </td></tr><tr><td>value</td><td>Texto</td><td>Valor da transação </td></tr><tr><td>category</td><td>Texto</td><td>são classificações de entrada e/ou saída na conta regulamentado pela Febraban.</td></tr><tr><td>Transactions</td><td>Texto</td><td>Bloco de fechamento do dia </td></tr><tr><td>type</td><td>Texto</td><td>Tipo da transação dia fechado / transação </td></tr><tr><td>summary_day</td><td>Texto</td><td>Data do fechamento por escrito </td></tr><tr><td>total_entries</td><td>Texto</td><td>Total de entradas do dia fechado </td></tr><tr><td>total_outputs</td><td>Texto</td><td>Total de saídas do dia fechado </td></tr><tr><td>total_balance</td><td>Texto</td><td>Saldo total do dia fechado </td></tr><tr><td>isNextPage</td><td>Boleano</td><td>Se existe ou não uma próxima página no período consultado </td></tr></tbody></table>

post/api/v1/balance

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Request body

contaOrigemstring
cpfOperadorstring
pagestring
movementType'C' | 'D' | 'A'
finalDatestring
initialDatestring
refreshCacheboolean

Example request

{
  "contaOrigem": "0550000000",
  "cpfOperador": "00000000000",
  "page": "1",
  "movementType": "C",
  "finalDate": "YYYY-MM-DD",
  "initialDate": "YYYY-MM-DD"
}

Response

Consulta realizada com sucesso.

messagestring

Example response

{
  "message": "Consulta realizada com sucesso.",
  "data": [
    {
      "balance": [
        {
          "transactions": [
            {
              "0": [
                {
                  "type": "transaction"
                }
              ],
              "1": [
                {
                  "type": "closed"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}