extrato Explorando as Rotas da API de Extrato Bancário para Transmissão Automática (VAN)

[wagner.aquino]

Olá, pessoal. Tudo certo?

 

No decorrer deste tópico, vamos explorar o uso das rotas da nossa API de extrato bancário em conjunto com a integração da VAN para conciliação automática dos arquivos. A nossa API dispõe de quatro rotas: Envio de Extrato Bancário, Consulta de Extrato Bancário, Consulta de Extrato Bancário por Período e Download de Arquivo de Extrato. No cenário de transmissão automática, a rota de envio de extrato não será necessária, uma vez que a conciliação dos arquivos de extrato, disponibilizados pelo banco, ocorre de forma automática. Nessa situação, o foco se concentra nas rotas de método GET, utilizadas para consulta.

 

Para realizar a consulta dos arquivos, é necessário utilizar a rota 'Consultar Extrato Bancário por Período'. Essa rota retorna todos os arquivos de extrato conciliados dentro do intervalo de datas especificado. Abaixo, um exemplo de ‘response’:

{
  "data": [
    {
      "uniqueId": "string",
      "date": "2019-08-24",
      "type": "string",
      "balance": "string",
      "dateStart": "2019-08-24",
      "dateEnd": "2019-08-24"
    }
  ],
  "meta": {
    "count": 0,
    "page": 0,
    "totalPages": 0
  }
}

Na seção "data", serão exibidos os arquivos recebidos, com detalhes como o uniqueId do extrato (uniqueId), a data do arquivo (date), o formato (type), o saldo (balance), além das datas de início e fim das transações incluídas no extrato (dateStart e dateEnd). A seção "meta" traz informações sobre a quantidade de arquivos correspondentes à data informada (count), a página (page) e o total de páginas (totalPages).

 

Para obter informações detalhadas de cada extrato listado na rota 'Consultar Extrato Bancário por Período', deve-se utilizar a rota 'Consultar Extrato Bancário'. A utilização desta rota proporciona a seguinte ‘response’:

{
  "bankStatement": {
    "bankCode": "string",
    "bank": "string",
    "currency": "string",
    "balance": 0,
    "date": "2019-08-24",
    "type": "string",
    "totalTransactions": 0,
    "accountHash": "string",
    "dateStart": "string",
    "dateEnd": "string"
  },
  "transactions": {
    "credit": [
      {
        "sequence": 0,
        "code": "string",
        "description": "string",
        "amount": 0,
        "date": "2019-08-24",
        "fitid": "string"
      }
    ],
    "debit": [
      {
        "sequence": 0,
        "code": "string",
        "description": "string",
        "amount": 0,
        "date": "2019-08-24",
        "fitid": "string"
      }
    ],
    "balance": {
      "inicial": {
        "date": null,
        "balance": 0
      },
      "final": {
        "date": null,
        "balance": 0
      }
    }
  }
}

Na parte "bankStatement", são apresentados os detalhes do arquivo, como o código do banco (bankCode), nome do banco (bank), moeda (currency), saldo (balance), data do arquivo (date), formato (type), número total de transações (totalTransactions), identificador da conta (accountHash) e datas de início e término das transações no extrato (dateStart e dateEnd). Na seção "transactions", são exibidos os detalhes das transações, tanto créditos quanto débitos, incluindo informações como o sequencial da transação (sequence), código interno do banco (code), descrição (description), valor (amount), data (date) e código/tag da transação fornecida pela instituição bancária (fitid). Adicionalmente, é apresentado o saldo inicial e final.

Por fim, a rota 'Baixar Arquivo de Extrato' permite fazer o download de um arquivo específico, bastando fornecer o uniqueId correspondente. A resposta dessa rota contém o conteúdo do arquivo de extrato em formato de 'string'.

 

Para saber mais detalhes sobre as rotas da API de extrato bancário, acesse nossa documentação clicando aqui.

👉 Se você ainda não está familiarizado com a nossa API de extrato bancário, clique aqui para obter informações mais detalhadas. Estamos à disposição para esclarecer qualquer dúvida que possa surgir.

Isso é tudo, pessoal. Obrigado!