​
Jornada de Contratação

Antes de utilizar este serviço, é necessário configurar a autenticação. Consulte as instruções de autenticação para orientações detalhadas.
O Saque-Aniversário permite ao trabalhador retirar, anualmente, uma parte do saldo do Fundo de Garantia por Tempo de Serviço (FGTS) no mês de seu aniversário. No caso de uso dessa modalidade, o cliente pode optar por antecipar o valor disponível, utilizando o saldo do FGTS como garantia para a antecipação. Assim, o caso de uso do Saque-Aniversário possibilita ao trabalhador acessar, antecipadamente, uma parte do saldo do FGTS para atender às suas necessidades financeiras. Para entendimento do cálculo realizado pela CEF, consulte o site da Caixa Econômica Federal.
Lembrando que não é possível manter o Saque-Aniversário e o Saque- Rescisão simultaneamente ativados.
Para realizarmos a consulta do saldo do FGTS junto à Caixa Econômica Federal, é necessário informar ao seu cliente que deve realizar a autorização da BMP no aplicativo do FGTS, selecionando as seguintes instituições financeiras:
  • BMP SOCIEDADE DE CRÉDITO DIRETO S.A
  • MONEY PLUS SOCIEDADE DE CRÉDITO AO MICROEMPREENDEDOR E A EMPRESA DE PEQUENO PORTE LTDA
Caso tenha dúvidas sobre a autorização, temos uma página com o passo a passo para o seu cliente realizar a adesão.
A CEF impede a consulta e averbação do saldo de um cliente no período de 16 dias úteis antes do mês de aniversário do trabalhador.

​
Diagrama caso de uso

caso-de-uso-fgts
Abaixo segue o passo a passo para utilização do caso de uso:

​
1 - Simulações

Nessa etapa, você pode consultar os valores disponíveis para saque do FGTS e executar simulações. Após isso, poderá realizar empréstimos com garantia do FGTS e os valores serão inclusos em uma proposta. A seguir, detalharemos as opções de simulações disponíveis. Confira qual delas se ajusta melhor às necessidades da sua operação:
Quando o valor do campo ConsultaCache for false, a requisição consultará o saldo do FGTS atualizado diretamente na Caixa Econômica Federal (CEF); quando for true, o saldo será obtido do cache da BMP. Este campo não é obrigatório, caso não seja informado, o sistema assume o valor true como padrão.

​
2 - Onboarding

Nesta etapa, ocorre o cadastro do cliente via requisição, onde será solicitado o empréstimo com garantia do FGTS. Para isso, será necessário:
1

Cadastro dos dados pessoais do cliente

Nesta etapa será necessário realizar o cadastro dos dados do cliente (nome, documentos (CPF e RG) e dados de contato (e-mail e telefone) através da integração com nossa API de Cadastro de Cliente
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token gerado no 1º passo' \
--data-raw '{
    "dto": {
        "Codigo": "1", // Código para identificar o cliente em seu sistema | NÃO OBRIGATÓRIO
        "Nome": "CLIENTE TESTE", // Nome do seu cliente | OBRIGATÓRIO
        "DocumentoFederal": "75000000000", // Documento federal (CPF: 11 dígitos | CNPJ: 14 dígitos | temos um validador, então precisa ser um documento válido) | OBRIGATÓRIO
        "PF": {
            "rg": "string", // RG do seu cliente | OBRIGATÓRIO
            "dtNasc": "2024-02-26T16:33:57.775Z" // Data de nascimento do seu cliente | OBRIGATÓRIO
        },
        "PessoaDadosContato": {
            "Email": "teste@email.com.br", // E-mail do seu cliente | OBRIGATÓRIO
            "TelefoneCelular1": "11923456781" // Celular do seu cliente | OBRIGATÓRIO
        }
    }
}'
2

Cadastro ou atualização do endereço completo do cliente

Nesta etapa será necessário realizar o cadastro ou atualização do endereço através da integração com nossa API de Cadastro de Endereço
curl --location 'https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco' \
--header 'IdempotencyKey: GUID UNICO PARA CADA CHAMADA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token gerado no 1º passo' \
--data '{
  "dto": {
    "codigo": "string", // Código para identificar o endereço em seu sistema | NÃO OBRIGATÓRIO
    "cep": "string" // CEP do endereço | OBRIGATÓRIO
  },
  "param": {
    "documentoCliente": "string" // Documento federal CPF: 11 dígitos |  temos um validador, então precisa ser um documento válido | OBRIGATÓRIO
  }
}'

​
3 - Contratação

Nesta etapa é realizado o envio da proposta, inserindo os dados solicitados:
  • Valor do empréstimo
  • Valor ou Percentual da TAC (se houver)
  • Data de aniversário
  • CPF
  • Taxa de juros aplicada
  • Conta destino para pagamento
  • Quantidade de períodos desejada
1

Inclusão de Proposta

Nesta etapa será necessário realizar o envio da proposta através da integração com nossa API de Incluir PropostaPara utilização de contrato com split de TED adicione o objeto abaixo na requisição anterior dentro do array dto:Para utilização de contrato com split de BOLETO adicione o objeto abaixo na requisição anterior dentro do array dto:Após o envio dos dados, consultaremos a CEF. Caso o cliente tenha saldo disponível para saque, o retorno da resposta da requisição será o código da proposta, e um callback informando o status de aprovação da proposta ID=2.Se o cliente não tiver saldo disponível ou ocorrer algum erro na chamada do endpoint, consulte a tabela de mensageria com os códigos de erro, presentes no endpoint.

​
4 - Coleta de Assinaturas

Após a finalização da inclusão da proposta, é necessário realizar a assinatura da CCB, pois se trata da formalização de um empréstimo e comprova a responsabilidade pelo devido pagamento.
Para conhecer mais sobre nossas assinaturas, suas particularidades e qual utilizar em seu projeto conheça nosso material explicativo sobre as assinaturas.
Com a assinatura definida durante o planejamento do escopo de projeto com o executivo comercial, selecione abaixo a opção que irá utilizar para prosseguir com o caso de uso:

​
5 - Solicitação da Trava do Saldo

Após a assinatura da operação (ID=6), a BMP solicitará à CEF que realize a reserva do saldo do CPF em questão. Enquanto a reserva está em processo de andamento, a CEF mantém o valor bloqueado, garantindo que não haverá novas solicitações de trava daquele saldo.
Em caso de indisponibilidade de sistema por parte da CEF, retornará com o status do protocolo “em processamento”
A solicitação será reprocessada automaticamente pela CEF na noite do próximo dia útil. Posteriormente, o status do protocolo será alterado para ‘acatado’ ou ‘não acatado’. Possíveis cenários de callback de acordo com o retorno do protocolo pela CEF:

​
6 - Cancelamento (Opcional)

Por meio deste endpoint, será solicitado o cancelamento do contrato de antecipação junto à CEF: 
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/FGTS/CancelarProposta \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: GUID UNICO POR CHAMADA \
--data '{
  "dto": {
    "CodigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CodigoOperacao": "<string>",
    "TextoMotivoCancelamento": "<string>"
  }
}'
O parceiro pode solicitar o cancelamento da proposta via API apenas nos seguintes status: “Aprovada”, “Finalizada”, “Liberada” e “Paga”.
Após solicitar o cancelamento, consulte os possíveis retornos de callback que disponibilizamos através do callback de cancelamento

​
7 - APIs Auxiliares

Procedimento Técnico Callback será utilizado no decorrer do processo nas etapas de alteração de status da e solicitação de cancelamento da proposta. Consultar operação será utilizado ao longo do processo para acessar e verificar todas as informações detalhadas da proposta. Cancelamento de Contrato será utilizado nesta jornada para cancelamento de contrato.