Bankerize API
  1. E-Consignado
Bankerize API
  • Conheça a Bankerize
  • Nossos produtos
  • Guia de integração
    • Introdução
    • Autenticação
    • Webhooks
    • Enums
  • Referências da API
    • Comece por aqui
      • Autenticação
      • Teste de integridade
    • CAAS
      • FGTS
        • Introdução
        • 1. Simulação
        • 2. Simulação por parcela
        • 3. Cadastro da proposta
      • E-Consignado
        • Introdução
        • Webhooks
        • 1. Solicitar vinculos empregatícios
          POST
        • 2. Solicitar detalhamento de um vinculo empregatícios
          POST
        • 3. Simulação
          POST
        • 4. Cadastro da proposta
          POST
    • Propostas
      • Cancelamento
      • Consultar
      • Enviar para desembolso
      • Solicitar link de assinatura
      • Atualizar dados bancários
      • Detalhamento
      • Alterar status do antifraude
      • Solicitar autorização de consulta
      • Enviar autorização de consulta
    • Administrativo
      • Introdução
      • Usuários
        • Cadastrar
      • Parceiros
        • Cadastrar
      • Perfis
        • Listar
  1. E-Consignado

3. Simulação

POST
/proposals/econsignado/simulate
A simulação é realizada em todas as tabelas disponíveis, não é necessário informar nenhuma tabela.
O installment_value não deve ser superior ao availableMarginValue recebido no webhook de detalhamento do vínculo empregatício.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Success
application/json
Body

🔴500Erro do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://develop.api.bankerize.com.br/v1/proposals/econsignado/simulate' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cpf": "12332145678",
    "request_uuid": "9d916377-8c41-4395-9a10-9989278e2ac0",
    "installment_value": 1000,
    "bank": "bmp"
}'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "table": {
                "id": "593d0603-1bd1-4b1d-b603-247833c5d171",
                "name": "Tabela XPTO"
            },
            "simulation": {
                "payload": {
                    "installments": [
                        {
                            "deadline": 66,
                            "value": 11.86,
                            "interest_value": 10.4,
                            "amortization_value": 1.46,
                            "due_date": "2025-08-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 97,
                            "value": 11.86,
                            "interest_value": 4.69,
                            "amortization_value": 7.17,
                            "due_date": "2025-09-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 127,
                            "value": 11.86,
                            "interest_value": 4.21,
                            "amortization_value": 7.65,
                            "due_date": "2025-10-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 158,
                            "value": 11.86,
                            "interest_value": 4,
                            "amortization_value": 7.86,
                            "due_date": "2025-11-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 188,
                            "value": 11.86,
                            "interest_value": 3.52,
                            "amortization_value": 8.34,
                            "due_date": "2025-12-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 219,
                            "value": 11.86,
                            "interest_value": 3.25,
                            "amortization_value": 8.61,
                            "due_date": "2026-01-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 250,
                            "value": 11.86,
                            "interest_value": 2.85,
                            "amortization_value": 9.01,
                            "due_date": "2026-02-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 278,
                            "value": 11.86,
                            "interest_value": 2.19,
                            "amortization_value": 9.67,
                            "due_date": "2026-03-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 309,
                            "value": 11.86,
                            "interest_value": 1.98,
                            "amortization_value": 9.88,
                            "due_date": "2026-04-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 339,
                            "value": 11.86,
                            "interest_value": 1.47,
                            "amortization_value": 10.39,
                            "due_date": "2026-05-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 370,
                            "value": 11.86,
                            "interest_value": 1.03,
                            "amortization_value": 10.83,
                            "due_date": "2026-06-23T00:00:00-03:00"
                        },
                        {
                            "deadline": 400,
                            "value": 11.86,
                            "interest_value": 0.45,
                            "amortization_value": 11.41,
                            "due_date": "2026-07-23T00:00:00-03:00"
                        }
                    ],
                    "net_value": 100,
                    "gross_value": 142.32,
                    "installment_value": 11.86,
                    "monthly_cet": 77.3406,
                    "annual_cet": 4.88998,
                    "monthly_fee": 4.5,
                    "annual_interest": 69.58814,
                    "iof_value": 2.28,
                    "first_due_date": "2025-08-23T00:00:00-03:00",
                    "simulation_id": "2ed087b5-30a5-4efa-bf49-1259bcab9065"
                }
            }
        }
    ],
    "message": "Simulação realizada com sucesso!"
}
Página anterior
2. Solicitar detalhamento de um vinculo empregatícios
Próxima página
4. Cadastro da proposta
Built with