Pular para o conteúdo principal

Sincronizar Saldo

POST 

/v2/financial/accounts/:financial_account_uid/balances/sync

Solicita à instituição financeira o saldo atual de uma conta financeira. Requer conexão ativa.

Processamento Assíncrono: Este endpoint cria um comando de sincronização de saldo para a Conta Financeira.

Ao receber a requisição, a nossa API cria um Comando, que é processado em segundo plano. Quando o banco responde com o saldo, o comando é confirmado e um novo saldo é registrado na Conta Financeira. Você recebe na resposta desta requisição o comando criado e pode consultá-lo a qualquer momento em Listar Comandos de uma Conta Financeira e Visualizar um Comando. O saldo registrado aparece em Listar saldos.

Para que seja possível executar a Sincronização de Saldo, deve haver uma Conexão ativa (ou seja, validada e habilitada) associada à Conta Financeira, e o provedor financeiro dela precisa oferecer consulta de saldo via API. Caso contrário, a resposta é 422 com param: financial_account.

Eventos de Webhook​

Quando a requisição é realizada, um evento financial.account.balance_sync.requested é disparado. Depois da resposta da instituição financeira, o evento financial.account.balance_sync.confirmed é disparado.

Request​

Responses​

Comando criado