Use este checklist para validar se a integração FGTS está pronta para homologação.

Credenciais e autenticação

• Credenciais recebidas e armazenadas com segurança.

• Token gerado por POST /oauth/token.

• Header Authorization: Bearer enviado nas chamadas autenticadas.

• Renovação de token tratada pela aplicação.

Webhooks

• Webhook de saldo cadastrado em POST /user/webhook/balance.

• Webhook de proposta cadastrado em POST /user/webhook/proposal.

• Endpoint da sua aplicação responde HTTP 2xx na validação do Scalar/V8.

• Eventos de sucesso e falha de saldo tratados.

• Eventos de atualização de proposta tratados.

Consulta de saldo

• Aplicação entende que POST /fgts/balance retorna null.

• Aplicação aguarda webhook antes de chamar o GET.

• Resultado final buscado com GET /fgts/balance?search=.

• Status success e fail tratados.

• balanceId, amount e periods armazenados quando retornados.

Simulação

• Tabelas consultadas em GET /fgts/simulations/fees.

• Apenas tabelas ativas são usadas na simulação.

• simulationFeesId armazenado.

• balanceId da consulta de saldo enviado na simulação.

• targetAmount enviado como 0 quando não houver valor específico.

• ID da simulação armazenado para criação da proposta.

Criação da proposta

• fgtsSimulationId enviado com o ID retornado pela simulação.

• simulationFeesId enviado com a tabela escolhida.

• Dados cadastrais obrigatórios preenchidos.

• Dados de pagamento enviados como pix ou transfer.

• Para transfer, bankId foi obtido em GET /banks.

• formalizationLink enviado como string vazia quando exigido.

• id, contractNumber e formalizationLink da resposta armazenados.

Pós-criação

• Operações acompanhadas por webhook e por consulta.

• Detalhe da proposta consultado por ID quando necessário.

• Pendências de banco, PIX ou documentos tratadas.

• Cancelamento usado somente quando a proposta ainda puder ser cancelada.