Guide

Cancelando Operação

Este recurso é utilizado para cancelar uma proposta de saque aniversário do FGTS previamente criada. O cancelamento dispara automaticamente uma solicitação de desaverbação do saldo junto ao sistema da Caixa Econômica Federal, liberando o saldo retido para novas simulações e propostas.

Endpoint

  • URL: https://bff.v8sistema.com/fgts/proposal/{id}/cancel

  • Método: PATCH

  • Autenticação: Requer token JWT válido.

  • Path Parameter:

    • id: identificador único da proposta a ser cancelada.

Funcionamento

  • Ao cancelar uma proposta, o saldo do FGTS bloqueado é liberado para novas operações.

  • Se a proposta ainda não tiver sido paga, o desbloqueio do saldo pode levar entre 24h a 48h.

  • O processo de cancelamento é manual e exige o envio de um corpo (payload) com o motivo do cancelamento.

Requisição

Payload Exemplo:

{
  "reason": "invalid_data:other",
  "description": "Cliente solicitou cancelamento por desistência da operação."
}

  • reason: campo obrigatório. Deve conter um dos códigos de motivo listados abaixo.

  • description: campo opcional, porém altamente recomendado para controle e rastreabilidade.

Motivos de Cancelamento (reason)

A seguir estão os valores aceitos no campo reason com suas respectivas descrições e orientações:

  • invalid_data:invalid_address
    Descrição: Endereço incorreto
    Quando o endereço digitado não confere com o informado pelo cliente.

  • invalid_data:incomplete_name
    Descrição: Nome incompleto
    Quando o nome informado na proposta está incompleto em comparação com o documento.

  • invalid_data:invalid_name
    Descrição: Nome incorreto
    Nome não corresponde ao CPF informado.

  • invalid_data:other
    Descrição: Outros
    Usado para qualquer outro motivo. Neste caso, recomenda-se sempre preencher o campo description com uma justificativa.

Considerações Técnicas

  • Este endpoint deve ser chamado apenas antes da finalização do pagamento da proposta.

  • Uma vez cancelada, a proposta não poderá ser reutilizada, sendo necessário iniciar uma nova simulação e proposta.

  • O campo description, embora opcional, melhora a visibilidade para backoffice e suporte da instituição.