Guide

Limpando a consulta de saldo

Para otimizar a performance durante a jornada de proposta, a API da V8 Digital realiza o cache das informações de saldo FGTS após uma consulta bem-sucedida. Essa abordagem reduz a quantidade de chamadas desnecessárias ao sistema de consulta, garantindo mais agilidade durante o processo.

Regras de Cache

  • Após uma consulta de saldo ser realizada via endpoint POST /fgts/balance, o resultado será armazenado em cache por até 24 horas.

  • Caso uma proposta seja digitada com sucesso utilizando os dados consultados, o cache da consulta associada ao CPF utilizado será imediatamente invalidado.

  • Se for necessário refazer a consulta com dados atualizados — por exemplo, se houver alguma alteração no CPF consultado — deve-se remover manualmente o cache utilizando o endpoint descrito abaixo.

Endpoint de Remoção de Cache

  • URL: https://bff.v8sistema.com/fgts/balance/cache/{documentNumber}

  • Método: DELETE

  • Path Parameter:

    • documentNumber: número do CPF do cliente (somente números).

Funcionamento

  • Esse endpoint remove o cache de saldo FGTS associado ao CPF informado, forçando assim a necessidade de uma nova consulta para obter dados atualizados.

  • É especialmente útil em casos onde o cliente alega mudança de saldo, alteração de vínculo ou regularização da autorização para saque aniversário.

Exemplo de Requisição 

DELETE /fgts/balance/cache/12345678900
Authorization: Bearer <token>

Resposta Esperada 

{
  "message": "Cache successfully cleared for documentNumber 12345678900"
}

Considerações Técnicas

  • A remoção de cache não realiza uma nova consulta automaticamente. Após limpar o cache, será necessário chamar novamente o endpoint POST /fgts/balance.

  • Recomendado executar este endpoint somente quando houver necessidade comprovada de obter um saldo atualizado.

  • O cache é específico por CPF e por provider, então múltiplas chamadas com diferentes provider podem coexistir no sistema até expirar ou serem sobrescritas.