Contas

Consulta o saldo de uma conta em tempo real

Pergunta ao parceiro de Open Finance o saldo atual da conta diretamente na instituição, sem rodar uma sincronização. É uma consulta pura: nada é gravado na Snabber, então balance, provider_updated_at e o histórico de saldo da conta seguem refletindo a última sincronização — cabe a quem chama decidir o que fazer com esta leitura mais recente. Nem todo conector oferece saldo em tempo real; quando não oferece, o parceiro devolve o saldo da última coleta dele e a resposta traz is_realtime: false. O mesmo vale quando a consulta em tempo real falha: em vez de erro, a resposta devolve o último saldo conhecido com is_realtime: false e collected_at dizendo quando o parceiro coletou aquele número — então sempre confira is_realtime antes de tratar o valor como sendo do instante da chamada. Atenção: por vir da instituição naquele instante, um saldo em tempo real pode já refletir um lançamento que ainda não aparece em /api/v1/transactions. Cada chamada consulta o parceiro, então use com parcimônia — vale o limite de requisições da sua chave.

get/api/v1/accounts/realtime-balance

Request

  • Base URL: https://snabber.com.br
  • URL: https://snabber.com.br/api/v1/accounts/realtime-balance
  • Auth: HTTP bearer

Query parameters

workspace_idinteger

Workspace a consultar, entre os autorizados para esta chave (ver GET /api/v1/workspaces). Se omitido, usa o workspace padrão da chave. Um id fora do conjunto autorizado resulta em 400 INVALID_WORKSPACE. Só é possível autorizar (em /integrations) um workspace do qual o dono da chave já é membro — para incluir dados de um workspace de outra pessoa, ela precisa primeiro compartilhar esse workspace com você (convite em /workspaces), não basta saber o id.

account_idinteger required

Id da conta conectada via Open Finance (ver /api/v1/accounts)

Response

Saldo consultado no parceiro

Changes

No recorded changes to this operation across all 1 revision of this API.