1. Simulação

POST

/proposals/fgts/simulate

Esta seção da documentação descreve como realizar a requisição para realizar a simulação para antecipação dos saques aniversários do FGTS.

Ao realizar a simulação sem fornecer o valor desejado desired_value, a simulação será realizada com todo o valor disponível para o cliente.

Passos para realizar a integração

Para ter sucesso nessa integração, siga sempre esse fluxo:

Faça a simulação sem especificar um valor (Para receber o valor máximo possível)

Com o valor em mãos, solicite (se necessário) um novo valor respeitando o valor máximo recebido.

A simulação é realizada em todas as tabelas disponíveis, mas nem todos os resultados são passíveis de uso. Somente as simulações que retornarem com o atributo simulation_id preenchido podem ser usadas, caso contrário deve ser observado as descrições de erro que a simulação retornou.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://develop.api.bankerize.com.br/v1/proposals/fgts/simulate' \
--header 'Authorization: ' \
--header 'X-User-Cpf;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cpf": "00000000000",
    "bank": "bmp",
    "desired_value": null
}'

Response Example

{
    "data": [
        {
            "error": false,
            "table": {
                "id": "cb9a1a44-b25b-4cdb-9da1-ae21a0a61507",
                "name": "Hogwarts Plus"
            },
            "tc_percentage": 35,
            "simulation": {
                "rules": {
                    "allow_simulate_by_installments": false,
                    "min_installment_amount": 3,
                    "max_installment_amount": 12,
                    "installments_excluded": []
                },
                "error_description": [],
                "payload": {
                    "installments": [
                        {
                            "date": "2025-08-01",
                            "available_value": 44.01,
                            "released_value": 42.76319
                        },
                        {
                            "date": "2026-08-01",
                            "available_value": 30.8,
                            "released_value": 23.46222
                        },
                        {
                            "date": "2027-08-01",
                            "available_value": 21.57,
                            "released_value": 13.24107
                        },
                        {
                            "date": "2028-08-01",
                            "available_value": 20.12,
                            "released_value": 9.94714
                        },
                        {
                            "date": "2029-08-01",
                            "available_value": 14.82,
                            "released_value": 5.90437
                        },
                        {
                            "date": "2030-08-01",
                            "available_value": 7.68,
                            "released_value": 2.4657
                        },
                        {
                            "date": "2031-08-01",
                            "available_value": 3.84,
                            "released_value": 0.99349
                        },
                        {
                            "date": "2032-08-01",
                            "available_value": 3.86,
                            "released_value": 0.8043
                        },
                        {
                            "date": "2033-08-01",
                            "available_value": 4.74,
                            "released_value": 0.79591
                        },
                        {
                            "date": "2034-08-01",
                            "available_value": 2.37,
                            "released_value": 0.32069
                        }
                    ],
                    "net_value": 57.25,
                    "gross_value": 103.01,
                    "monthly_cet": 7.58264,
                    "annual_cet": 140.3845,
                    "monthly_fee": 1.79,
                    "annual_interest": 23.72611,
                    "tc_value": 36.05,
                    "iof_value": 2.32,
                    "interest_value": 50.8,
                    "blocked_balance": 153.81,
                    "simulation_id": "d7262388-fda6-49f7-8a5c-2d36f5b4c225",
                    "bank_proposal_id": null
                }
            }
        }
    ],
    "message": "Simulação realizada com sucesso!"
}

Página anterior

Introdução

Próxima página

2. Simulação por parcela

1. Simulação

Passos para realizar a integração#

Requisição

Respostas

Passos para realizar a integração