O endpoint de saldo em tempo real busca o saldo da conta diretamente da instituição financeira sem acionar uma sincronização completa de itens. Isso é útil quando você precisa de informações de saldo atualizadas entre ciclos de sincronização regulares.
GET /accounts/{id}/balance
{
"balance": 1500.50,
"blockedBalance": 0,
"automaticallyInvestedBalance": 200,
"currencyCode": "BRL",
"updateDateTime": "2024-01-15T10:30:00Z"
}O valor de balance retornado por este endpoint é calculado usando a mesma lógica de uma execução completa de item -- não há diferença em como o saldo é derivado.
Quando você chama este endpoint, o recurso da conta também é atualizado com o novo saldo. Qualquer solicitação subsequente GET /accounts/{id} refletirá o valor buscado pela chamada de saldo em tempo real.
Aviso: Este endpoint está disponível apenas para connectors de Open Finance. Chamá-lo em contas que não são de Open Finance retornará um erro.
Limitação de taxa: O limite de taxa para este endpoint é compartilhado com a execução completa de itens. Solicitações para o endpoint de saldo em tempo real e sincronizações de itens contam para a mesma cota de limite de taxa imposta pela instituição financeira. Se a instituição limitar a taxa da solicitação, você receberá uma resposta 429.
| Código de Resposta | Descrição |
|---|---|
200 | Saldo buscado e conta atualizada |
404 | Conta não encontrada para o ID fornecido |
429 | Limite de taxa imposto pela instituição financeira -- tente novamente mais tarde |
500 | Erro ao buscar o saldo do connector |
Veja Obter saldo em tempo real na referência da API para mais detalhes.