Before using this service, you must configure authentication. See the authentication instructions for detailed instructions.
The Anniversary Withdrawal allows workers to withdraw part of their FGTS balance annually in the month of their birthday. When using this option, the customer can choose to advance the available amount, using the FGTS balance as collateral for the advance. Therefore, the Anniversary Withdrawal allows workers to access part of their FGTS balance in advance to meet their financial needs. To understand the calculation performed by CEF, please visit the website of Caixa Econômica Federal.
Please note that it is not possible to keep the Anniversary Withdrawal and Termination Withdrawal activated simultaneously.
To check the FGTS balance with Caixa Econômica Federal, you must inform your client that they must authorize the BMP in the FGTS application, selecting the following financial institutions:
  • BMP SOCIEDADE DE CRÉDITO DIRETO S.A;
  • MONEY PLUS SOCIEDADE DE CRÉDITO AO MICROEMPREENDEDOR E A EMPRESA DE PEQUENO PORTE LTDA.
If you have any questions about authorization, we have a page with step-by-step instructions for your client to register.
The CEF prevents the consultation and registration of a client’s balance in the period of 16 business days before the employee’s birthday month.
Below is the step-by-step guide to using the use case:

​
1 - Simulations

At this stage, you can check the amounts available for withdrawal from the FGTS and run simulations. After that, you can take out loans with FGTS collateral and the amounts will be included in a proposal. Below, we will detail the simulation options available. Check which one best fits the needs of your operation:
When the value of the ConsultaCache field is false, the request will query the updated FGTS balance directly at Caixa Econômica Federal (CEF); when it is true, the balance will be obtained from the BMP cache. This field is not mandatory; if it is not provided, the system assumes the true value as default.

​
2 - Onboarding

In this step, the customer is registered via request, where the loan with FGTS guarantee will be requested. To do this, it will be necessary to:
1

Registration of the customer's personal data

In this step, it will be necessary to register the customer’s data (name, documents (CPF and RG) and contact information (email and telephone) through integration with our Customer Registration API.
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

Registering or updating the customer's full address

In this step, you will need to register or update the address through integration with our Address Registration API.
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 - Hiring

At this stage, the proposal is sent, inserting the requested data:
  • Loan amount;
  • Amount or percentage of the TAC (if applicable);
  • Anniversary date;
  • CPF;
  • Interest rate applied;
  • Destination account for payment;
  • Number of periods desired.
1

Inclusion of Proposal

At this stage, you will need to send the proposal through integration with our Inclusion of Proposal APITo use a contract with TED split, add the object below to the previous request within the dto array:To use a contract with a BOLETO split, add the object below to the previous request within the dto array:After sending the data, we will consult the CEF. If the customer has a balance available for withdrawal, the response to the request will be the proposal code, and a callback informing the approval status of the proposal ID=2.If the customer does not have a balance available or an error occurs when calling the endpoint, see the table of messages with the error codes, present in the endpoint.

​
4 - Collecting Signatures

After completing the proposal inclusion, it is necessary to sign the CCB, as this is the formalization of a loan and proves responsibility for due payment.
To learn more about our signatures, their particularities and which one to use in your project read our explanatory material on signatures.
With the signature defined during the project scope planning with the sales executive, select the option below that you will use to proceed with the use case:

​
5 - Request for Balance Endorsement

After signing the transaction (ID=6), BMP will request CEF to reserve the balance of the CPF in question. While the reservation is in progress, CEF keeps the amount blocked, ensuring that there will be no new requests to endorse that balance.
In case of system unavailability on the part of CEF, it will return with the protocol status “in process”
The request will be automatically reprocessed by CEF on the evening of the next business day. Subsequently, the protocol status will be changed to ‘accepted’ or ‘not accepted’. Possible callback scenarios according to the protocol return by CEF:

​
6 - Cancellation (Optional)

Using this endpoint, you will be asked to cancel the advance payment contract with 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>"
  }
}'
The partner can request the cancellation of the proposal via API only in the following statuses: “Approved”, “Finalized”, “Released” and “Paid”.
After requesting the cancellation, check the possible callback returns that we make available through the cancellation callback.

​
7 - APIs Auxiliares