Pular para o conteúdo principal

Sincronizar Extrato

POST 
/v2/financial/accounts/:financial_account_uid/statement_transactions/sync

Sincroniza o extrato bancário de uma conta financeira. Busca transações diretamente da instituição financeira através de API. Requer conexão ativa.

Processamento Assíncrono: Este endpoint é processado assincronamente e cria um comando de sincronização de extrato para a Conta Financeira.

A Sincronização de Extrato de uma Conta Financeira é feita assincronamente, ou seja, ao receber a requisição, a nossa API guarda os parametros da requisição e cria um Comando. Esse comando é processado em sgundo plano e depois é confirmado e as transações serão importadas na Conta Financeira. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.

Veja mais em Listar Comandos de uma Conta Finaneira e Visualizar um Comando.

Para que seja possível executar a Sincronização de Extrato, deve haver uma Conexão ativa (ou seja, validada e habilitada) associada à Conta Financeira.

Período da Sincronização​

Os campos start_at e end_at são opcionais e delimitam a janela a sincronizar. Quando omitidos, a janela padrão vai do primeiro dia do mês corrente até hoje.

  • informando apenas start_at, a data final assumida é hoje;
  • informando apenas end_at, a data inicial assumida é o primeiro dia do mês de end_at;
  • a data final não pode ser futura;
  • o período máximo é de 2 anos para trás a partir de hoje.

Janelas que cruzam mais de um mês-calendário são fatiadas em um comando por mês. Isso mantém cada requisição à instituição financeira dentro de um volume que o banco consegue responder, e permite reprocessar apenas o mês que eventualmente falhar. Uma janela dentro de um mesmo mês continua criando um único comando.

Acompanhando a Importação​

Além do comando em data, a resposta traz em sync o registro da importação solicitada, com um uid próprio. Use esse uid para acompanhar o conjunto inteiro — especialmente em janelas multi-mês, onde vários comandos são criados — em Consultar Sincronização de Extrato.

Eventos de Webhook​

Quando a requisição é realizada, um evento financial.account.statement_sync.requested é disparado. O nosso servidor então começa a comunicação com a API da instituição financeira para buscar transações. Somente depois de confirmado na instituição financeira, aí então o extrato é atualizado. Neste momento o evento financial.account.statement_sync.confirmed é disparado.

Request​

Responses​

Comando criado por mês para janela multi-mês