Guide

Consultando Operações FGTS

Este endpoint é utilizado para listar todas as propostas de saque aniversário FGTS associadas ao usuário autenticado. Permite realizar buscas por CPF, número de contrato ou código do parceiro, além de aplicar filtros por status e realizar paginação dos resultados.

Endpoint de Consulta

  • URL: https://bff.v8sistema.com/fgts/proposal

  • Método: GET

Parâmetros de Consulta

  • search (opcional): Permite a busca textual por CPF, número do contrato ou código do parceiro.

  • status (opcional): Filtra os resultados por status da proposta. Valores permitidos:

    • formalization: proposta em fase de formalização;

    • analysis: em análise;

    • manual_analysis: em análise manual;

    • pending: com pendência a ser resolvida;

    • processing: em processamento bancário;

    • paid: paga com sucesso;

    • canceled: cancelada;

    • refounded: valor devolvido ao cliente.

  • page (obrigatório): Número da página de resultados a ser retornada.

  • limit (obrigatório): Quantidade de itens por página.

  • Exemplo de Requisição

GET /fgts/proposal?search=12345678900&status=paid&page=1&limit=10
Authorization: Bearer <token>

Exemplo de Resposta 

{
	"data": [
{
			"id": "6f45235b-2044-4d2c-bd52-247c5575061c",
			"clientName": "Sidney Aparecido Moura ",
			"status": "paid",
			"disbursedIssueAmount": "101.94",
			"statusReason": null,
			"contractNumber": "D65YEL24838",
			"callFinished": null,
			"hasCcbGenerated": true,
			"partnerId": "0001"
		}
	],
	"pages": {
		"limit": 50,
		"total": 31429,
		"current": 1,
		"hasNext": true,
		"hasPrev": false,
		"totalPages": 629
	}
}

Considerações Técnicas

  • Este endpoint respeita as permissões do token de autenticação. Cada usuário visualiza apenas as propostas criadas por ele.

  • A busca por CPF ou número de contrato deve ser feita sem formatação (somente números).

  • O uso dos filtros de status ajuda a segmentar as propostas conforme o estágio de processamento.