2. Simulação por parcela

POST

/proposals/fgts/installment-simulation

Esta seção da documentação descreve como realizar a requisição para realizar a simulação em uma tabela especifica porém manipulando as parcelas do saldo do FGTS.

Esse endpoint só funciona em tabelas que permitem a manipulação de parcelas.

Somente a remoção ou adição de parcelas pode ser feita, a manipulação de valores das parcelas não é suportado.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Success

application/json

Body

🟠422Erro de parâmetro

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://develop.api.bankerize.com.br/v1/proposals/fgts/installment-simulation' \
--header 'Authorization: ' \
--header 'X-User-Cpf;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cpf": "00000000000",
    "bank": "bmp",
    "table_id": "51acd201-0dc8-475e-9f43-e74c423cb6a0",
    "installments": [
        {
            "date": "2024-10-01",
            "released_value": 1000,
            "available_value": 1500
        }
    ]
}'

Response Example

200 - Example 1

{
    "data": {
        "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": 59.31,
        "gross_value": 103.01,
        "monthly_cet": 7.01355,
        "annual_cet": 125.5617,
        "monthly_fee": 1.79,
        "annual_interest": 23.72611,
        "tc_value": 33.99,
        "iof_value": 2.32,
        "interest_value": 50.8,
        "blocked_balance": 153.81,
        "simulation_id": "cb9a1a44-b25b-4cdb-9da1-ae21a0a61507",
        "bank_proposal_id": null
    },
    "message": "Simulação realizada com sucesso!"
}

Página anterior

1. Simulação

Próxima página

3. Cadastro da proposta