Antecipação de Saque-Aniversário FGTS - API

A API de Antecipação de Saque-Aniversário do FGTS permite que a plataforma simule e gere propostas dessa modalidade de empréstimo para o seu cliente final.

Funcionamento geral da API

A API é separada em 2 simples etapas:

1. Consulta de saldo já com simulação das parcelas: Endpoint vai verifica se há saldo disponível, e quanto, e já trazer as parcelas com simulação para antecipação do saque-aniversário FGTS

2. Envio e aceite da proposta: Endpoint que gera o link de assinatura de contrato e fluxo de KYC, e envia por WhatsApp e SMS.

O retorno e acompanhamento do status da proposta serão enviados por webhook e por relatórios/dashboards.

Basta pedir para o seu contato comercial disponibilizar isso.

Criando contato e simulando máximo de parcelas de antecipação FGTS

Descrição

Envio de dados básicos do cliente para consulta de saldo disponível para antecipação. A resposta mostra 10 parcelas disponíveis e a simulação de antecipação.

Importante

Antes de começar o fluxo, o cliente deverá habilitar, dentro do Aplicativo do FGTS, a consulta do saldo pro a instituição financeira:

BMP SOCIEDADE DE CREDITO DIRETO S.A

Endpoint: /external/fgts/contato

POST

{
    "cpf": "cpf",
    "celular" : "celular",
    "id_collaborator" : "1",
    "id_store" : "1",
    "datanascimento": "12/10/1991",
    "acceptMessage": true,
    "acceptTerms": true
}

200 - Response

400 - Response

Simulando outras parcelas de antecipação FGTS após criar o contato

Endpoint: /external/fgts/simulacao

POST

{
    "uuid" : "recebido",
    "parcelas" : 2
}

200 - Response

400 - Response

Aceite da oferta

Após o aceite da oferta, cliente receberá o link por WhatsApp e SMS.

Endpoint: external/fgts/proposta/criar

POST

{
  "uuid" : "",
  "nomecompleto": "Roberto Elias Silva",
  "cep": "06086-120",
  "endereconumero": "505",
  "uf": "SP",
  "cidade": "Osasco",
  "enderecocomplemento": "",
  "bairro": "Vila Osasco",
  "rua": "Rua do CLiente",
  "agencia": "1516",
  "conta": "28055-0",
  "tipoconta": "Checking",
  "banco": "Banco do Brasil",
  "parcelas" : 10
}

200 - Response

400 - Response

Cancelar a oferta

Endpoint: external/fgts/proposta/cancelar

POST

{
    "uuid" : "e3212923-5aef-4331-abb4-92597035e38d"
}

200 - Response

400 - Response

Lista de bancos

Aceitamos somente os bancos abaixo:

bank = {
        "Banco do Brasil": "001",
        "Santander": "033",
        "Inter": "077",
        "Caixa": "104",
        "Bradesco": "237",
        "Nubank": "260",
        "Itaú": "341",
        "C6": "336",
        "Pan": "623",
        "Bmg": "318",
        "Banrisul": "041",
        "Banese": "047",
        "Banco Real de Brasilia": "070",
        "Sicoob": "756",
        "Banco Banestes": "021",
        "Agibank": "121",
        "BMP": "274",
        "Sicredi": "748",
        "Banco BV": "655"
        }

Status

Será recebido via Webhook. Para cadastro, fale com nossa equipe comercial.

Lista de Status

A lista de status abaixo está em ordem de fluxo, começando com proposta aberta para simulação e terminando com em proposta paga.

Status	Descrição	Observação
cliente_com_proposta_aberta	Simulação feita mas proposta não enviada.
proposta_cadastrada	Proposta sendo cadastrada no banco. Em breve o Whatsapp e SMS serão enviado.
sms_assinatura	O SMS está sendo enviado para o cliente. Aguardando a assinatura e envio de fotos.
nao_aprovada	Proposta não foi aprovada na etapa de cadastro.	Proposta é cancelada
proposta_cancelada	Proposta cancelada.	Proposta é cancelada
cadastro_aprovado_reserva	Cadastro já foi aprovado. Reserva do saldo do FGTS em andamento.
proposta_aprovada_pagamento	Proposta aprovada e enviada para a fila de pagamento.
pagamento_falhou_dados	Tentativa de pagamento falhou pois dados bancários estavam incorretos pois dados bancários estavam incorretos.	Precisa atuar e depois chamar endpoint reprocessar
pagamento_falhou_habilitacao	Tentativa de pagamento falhou pois cliente não autorizou os dois bancos.	Precisa atuar e depois chamar endpoint dadosbancarios
pago	Valor já foi paga para o cliente.	Sucesso

Endpoint: external/fgts/reprocessar

Post

{
"uuid": "0123abc4-aabb-123f-1234-1234e1abc2d3"
"reprocess": true
}

200 - Response

Endpoint: external/fgts/dadosbancarios

Post

{
"uuid": "0123abc4-aabb-123f-1234-1234e1abc2d3"
"bank": "237",
"agency": "12345"
"account": "12345"
"acct_digit": "7"
"acct_type": "checking"
}

200 - Response