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

A API de Antecipação de Saque-Aniversário do FGTS permite que a plataforma pague as propostas em uma conta bancária pré-cadastrada.

Funcionamento geral da API

A API é separada em 2 simples etapas:

Consulta de saldo por valor: 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
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. Essa simulação na primeira chamada traz o máximo valor possível de antecipação para o cliente.

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/valor

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


{
    "uuid": "uuid"
    "VlrDispSaque": 13938.37,
    "PeriodoMin": 1,
    "PeriodoMax": 10,
    "Simulacao": {
        "Saldo": 13938.37,
        "Periodo": 10,
        "DtInicio": "2025-06-01T00:00:00",
        "DtFim": "2034-06-01T00:00:00",
        "TaxaMensal": 1.79,
        "TaxaCETMensal": 2.395,
        "TaxaCETAnual": 32.845,
        "TaxaJurosAnual": 23.72611,
        "VlrEmprestimoCliente": 6597.66,
        "VlrJuros": 7340.71,
        "VlrIOF": 197.79,
        "VlrIOFAdicional": 25.07,
        "VlrLiberado": 5378.48,
        "VlrOperacao": 13938.37,
        "VlrTAC": 989.65,
        "VlrReserva": 0.26,
        "VlrAmortizacao": 0.0,
        "VlrTransferencia": 0.64,
        "TaxaCCB": 0.0,
        "SimulacaoParcelas": [
            {
                "VlrRepasse": 11.27,
                "DtRepasse": "2025-06-01T00:00:00",
                "VlrPrincipal": 10.01,
                "VlrJuros": 1.2631,
                "VlrIOF": 0.16493,
                "VlrIOFAdicional": 0.03803,
                "VlrLiberado": 9.80394
            },
            {
                "VlrRepasse": 3284.87,
                "DtRepasse": "2026-06-01T00:00:00",
                "VlrPrincipal": 2350.44,
                "VlrJuros": 934.43445,
                "VlrIOF": 70.51307,
                "VlrIOFAdicional": 8.93166,
                "VlrLiberado": 2270.99082
            },
            {
                "VlrRepasse": 2792.14,
                "DtRepasse": "2027-06-01T00:00:00",
                "VlrPrincipal": 1609.98,
                "VlrJuros": 1182.15537,
                "VlrIOF": 48.29954,
                "VlrIOFAdicional": 6.11794,
                "VlrLiberado": 1555.56715
            },
            {
                "VlrRepasse": 2281.1,
                "DtRepasse": "2028-06-01T00:00:00",
                "VlrPrincipal": 1059.32,
                "VlrJuros": 1221.7817,
                "VlrIOF": 31.77955,
                "VlrIOFAdicional": 4.02541,
                "VlrLiberado": 1023.51334
            },
            {
                "VlrRepasse": 1824.88,
                "DtRepasse": "2029-06-01T00:00:00",
                "VlrPrincipal": 682.92,
                "VlrJuros": 1141.9581,
                "VlrIOF": 20.48766,
                "VlrIOFAdicional": 2.5951,
                "VlrLiberado": 659.83914
            },
            {
                "VlrRepasse": 1364.85,
                "DtRepasse": "2030-06-01T00:00:00",
                "VlrPrincipal": 411.6,
                "VlrJuros": 953.24937,
                "VlrIOF": 12.34802,
                "VlrIOFAdicional": 1.56408,
                "VlrLiberado": 397.68853
            },
            {
                "VlrRepasse": 955.4,
                "DtRepasse": "2031-06-01T00:00:00",
                "VlrPrincipal": 232.18,
                "VlrJuros": 723.21679,
                "VlrIOF": 6.9655,
                "VlrIOFAdicional": 0.8823,
                "VlrLiberado": 224.33542
            },
            {
                "VlrRepasse": 668.78,
                "DtRepasse": "2032-06-01T00:00:00",
                "VlrPrincipal": 130.9,
                "VlrJuros": 537.88397,
                "VlrIOF": 3.92688,
                "VlrIOFAdicional": 0.4974,
                "VlrLiberado": 126.47174
            },
            {
                "VlrRepasse": 468.14,
                "DtRepasse": "2033-06-01T00:00:00",
                "VlrPrincipal": 73.84,
                "VlrJuros": 394.30312,
                "VlrIOF": 2.21511,
                "VlrIOFAdicional": 0.28058,
                "VlrLiberado": 71.34119
            },
            {
                "VlrRepasse": 286.94,
                "DtRepasse": "2034-06-01T00:00:00",
                "VlrPrincipal": 36.47,
                "VlrJuros": 250.46938,
                "VlrIOF": 1.09412,
                "VlrIOFAdicional": 0.13859,
                "VlrLiberado": 35.23791
            }
        ]
    },
    "Consulta": {
        "cpfTrabalhador": "14731235774",
        "dataSaldo": "12/11/2024",
        "existeSaldoDesconsiderado": false,
        "qtdPedidos": 0,
        "periodos": [
            {
                "dataRepasse": "01/06/2025",
                "valor": 11.27
            },
            {
                "dataRepasse": "01/06/2026",
                "valor": 3284.87
            },
            {
                "dataRepasse": "01/06/2027",
                "valor": 2792.14
            },
            {
                "dataRepasse": "01/06/2028",
                "valor": 2281.1
            },
            {
                "dataRepasse": "01/06/2029",
                "valor": 1824.88
            },
            {
                "dataRepasse": "01/06/2030",
                "valor": 1364.85
            },
            {
                "dataRepasse": "01/06/2031",
                "valor": 955.4
            },
            {
                "dataRepasse": "01/06/2032",
                "valor": 668.78
            },
            {
                "dataRepasse": "01/06/2033",
                "valor": 468.14
            },
            {
                "dataRepasse": "01/06/2034",
                "valor": 286.94
            }
        ],
        "Cache": false
    },
    "Msg": "OK",
    "HasError": false,
    "Messages": []
}

{
  "uuid": "0123abc4-aabb-123f-1234-1234e1abc2d3",
  "parcelas": [
  {
  "errors": [
    {
    "code": "Error",
    "message": "C0326 : Valor solicitado R$ 409.0 superior ao máximo permitido R$ 309.60"
    },
    {
      "code": "invalid_uuid",
      "message": "UUID não encontrado."
    },
    {
      "code": "invalid_cpf",
      "message": "CPF inválido."
    },
    {
      "code": "invalid_simulation",
      "message": "Cliente não tem saldo suficiente para antecipar."
    },
    {
      "code": "invalid_autorization",
      "message": "Cliente não autorizou BMP e MoneyPlus para consulta."
    },
    {
      "code": "invalid_date",
      "message": "Data de aniversário muito próxima."
    },
    {
      "code": "caixa",
      "message": "Instabilidade na Caixa, tente novamente."
    }
  ]
}
    {
    }
  ]
}

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

Utilize esse endpoint para simular as condições quando queremos enviar um valor exato para a conta bancária cadastrada.

Endpoint: /external/fgts/simulacao/valor

{
    "uuid" : "recebido",
    "valor": 1000.00
}


{
    "uuid": "e3212923-5aef-4331-abb4-92597035e38d"
    "VlrDispSaque": 13938.37,
    "PeriodoMin": 2,
    "PeriodoMax": 10,
    "Simulacao": {
        "Saldo": 13938.37,
        "Periodo": 2,
        "DtInicio": "2025-06-01T00:00:00",
        "DtFim": "2026-06-01T00:00:00",
        "TaxaMensal": 1.79,
        "TaxaCETMensal": 2.93974,
        "TaxaCETAnual": 41.5783,
        "TaxaJurosAnual": 23.72611,
        "VlrEmprestimoCliente": 2360.45,
        "VlrJuros": 935.69,
        "VlrIOF": 70.68,
        "VlrIOFAdicional": 8.97,
        "VlrLiberado": 1000,
        "VlrOperacao": 1250,
        "VlrTAC": 354.07,
        "VlrReserva": 0.26,
        "VlrAmortizacao": 0.0,
        "VlrTransferencia": 0.64,
        "TaxaCCB": 0.0,
        "SimulacaoParcelas": [
            {
                "VlrRepasse": 11.27,
                "DtRepasse": "2025-06-01T00:00:00",
                "VlrPrincipal": 10.01,
                "VlrJuros": 1.2631,
                "VlrIOF": 0.16493,
                "VlrIOFAdicional": 0.03803,
                "VlrLiberado": 9.80394
            },
            {
                "VlrRepasse": 3284.87,
                "DtRepasse": "2026-06-01T00:00:00",
                "VlrPrincipal": 2350.44,
                "VlrJuros": 934.43445,
                "VlrIOF": 70.51307,
                "VlrIOFAdicional": 8.93166,
                "VlrLiberado": 2270.99082
            }
        ]
    },
    "Consulta": {
        "cpfTrabalhador": "14731235774",
        "dataSaldo": "12/11/2024",
        "existeSaldoDesconsiderado": false,
        "qtdPedidos": 0,
        "periodos": [
            {
                "dataRepasse": "01/06/2025",
                "valor": 11.27
            },
            {
                "dataRepasse": "01/06/2026",
                "valor": 3284.87
            },
            {
                "dataRepasse": "01/06/2027",
                "valor": 2792.14
            },
            {
                "dataRepasse": "01/06/2028",
                "valor": 2281.1
            },
            {
                "dataRepasse": "01/06/2029",
                "valor": 1824.88
            },
            {
                "dataRepasse": "01/06/2030",
                "valor": 1364.85
            },
            {
                "dataRepasse": "01/06/2031",
                "valor": 955.4
            },
            {
                "dataRepasse": "01/06/2032",
                "valor": 668.78
            },
            {
                "dataRepasse": "01/06/2033",
                "valor": 468.14
            },
            {
                "dataRepasse": "01/06/2034",
                "valor": 286.94
            }
        ],
        "Cache": false
    },
    "Msg": "OK",
    "HasError": false,
    "Messages": []
}

{
  "uuid": "0123abc4-aabb-123f-1234-1234e1abc2d3",
  "parcelas": [
  {
  "errors": [
    {
      "code": "Error",
      "message": "C0326 : Valor solicitado R$ 409.0 superior ao máximo permitido R$ 309.60"
    },
    {
      "code": "invalid_uuid",
      "message": "UUID não encontrado."
    },
    {
      "code": "invalid_cpf",
      "message": "CPF inválido."
    },
    {
      "code": "invalid_simulation",
      "message": "Cliente não tem saldo suficiente para antecipar."
    },
    {
      "code": "invalid_autorization",
      "message": "Cliente não autorizou BMP e MoneyPlus para consulta."
    },
    {
      "code": "invalid_date",
      "message": "Data de aniversário muito próxima."
    },
    {
      "code": "caixa",
      "message": "Instabilidade na Caixa, tente novamente."
    }
  ]
}
    {
    }
  ]
}

Aceite da oferta

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

Endpoint: /fgts/proposta/split

{
  "uuid" : "",
  "nomecompleto": "Roberto Elias Silva",
  "cep": "06086-120",
  "endereconumero": "505",
  "uf": "SP",
  "cidade": "Osasco",
  "enderecocomplemento": "",
  "bairro": "Vila Osasco",
  "rua": "Rua do CLiente",
  "valor": 100.00
}

{
  “success”: false,
  “message”: [
  {
  "errors": [
    {
      "code": "invalid_amount",
      "message": "Saldo bloqueado ou insuficiente."
    },
    {
      "code": "invalid_birth",
      "message": "Data de nascimento inválida."
    },
    {
      "code": "invalid_bank",
      "message": "Banco não aceito para pagamentos."
    },
    {
      "code": "caixa",
      "message": "Instabilidade na Caixa, tente novamente."
    }
  ]
}

Cancelar a oferta

Endpoint: /fgts/proposta/cancelar

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

{
  “success”: false,
  “message”: [
  {
  "errors": [
    {
      "code": "invalid_amount",
      "message": "Saldo bloqueado ou insuficiente."
    },
    {
      "code": "invalid_birth",
      "message": "Data de nascimento inválida."
    },
    {
      "code": "invalid_bank",
      "message": "Banco não aceito para pagamentos."
    },
    {
      "code": "caixa",
      "message": "Instabilidade na Caixa, tente novamente."
    }
  ]
}

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

REPROCESSAMENTO DE PAGAMENTO

Caso o cliente retire a autorização do BMP no aplicativo do FGTS, o banco não consegue realizar o pagamento. A proposta vai ficar com o status pagamento_falhou_habilitacao

Nesse caso, temos que entrar em contato com o cliente, solicitar novamente que autorize e chamar o endpoint abaixo.

Endpoint: /fgts/reprocessar

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

Endpoint: /fgts/dadosbancarios

PreviousAntecipação de Saque-Aniversário FGTS - API NextAntecipação de Saque-Aniversário FGTS - Iframe

Last updated 2 months ago