Crédito Privado CLT

Simulação Crédito CLT

Como esta etapa entra no fluxo

Use a simulação depois de gerar o termo de consentimento, acompanhar a consulta e confirmar que o fluxo pode avançar.

Pré-requisitos

  • Token válido no header Authorization.
  • Identificador gerado no fluxo de consentimento.
  • Configuração/taxa escolhida em GET /private-consignment/simulation/configs.
  • consult_id gerado no consentimento e config_id escolhido para pré-calcular parcelas.
  • Dados necessários para calcular a operação.

O que guardar

Guarde o id_simulation retornado na simulação. Ele será usado como simulation_id na criação da operação CLT.

A etapa de simulação do Crédito Privado CLT é composta por três endpoints complementares:

  1. Consulta de taxas disponíveis
    Este endpoint retorna as opções de taxa de juros vigentes para a operação de crédito, considerando critérios como provedor, prazo e valor desejado. É a primeira ação na simulação, permitindo que o integrador apresente ao cliente as condições disponíveis de forma dinâmica e atualizada.
  2. Pré-cálculo de parcelas
    Depois de escolher a configuração/taxa, este endpoint permite fazer um pré-cálculo das parcelas usando o consult_id e o config_id.
  3. Criação de simulação (POST /private-consignment/simulation)
    Após escolher a taxa adequada no passo anterior, este endpoint processa os valores informados e retorna o cálculo completo da simulação, incluindo CET mensal e anual, valor das parcelas, total a pagar e data de vencimento da primeira parcela.
    O resultado serve para apresentar ao cliente uma proposta clara e transparente, atendendo às exigências de comunicação e compliance.

Endpoint consultar as taxas disponiveis

URL: https://bff.v8sistema.com/private-consignment/simulation/configs

Método HTTP: GET

Autenticação: Requer token JWT válido no header da requisição.

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte

{
  "configs": [
    {
      "id": "string",
      "slug": "string",
      "monthly_interest_rate": "string",
      "limit_days_to_disburse": 0,
      "number_of_installments": [
        "string"
      ],
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

Parâmetros da Response

  • id: string
    identificador que será utilizado para criar a simulação do cliente.
  • slug: string
    Nome da tabela.
  • monthly_interest_rate: string
    Taxa mensal aplicada.
  • number_of_installments: array[string]
    Quantidade de parcelas disponiveis para a tabela informada.

Endpoint pré-calcular parcelas

URL: https://v2-bff-prod-front.yellowisland-b252a8a0.eastus.azurecontainerapps.io/private-consignment/simulation/pre-calculate-installments

Método HTTP: POST

Autenticação: Requer token JWT válido no header da requisição.

Chamada validada sem o header Authorization: a API retorna 401 Unauthorized com a mensagem Missing Authorization HTTP header.

Body da Requisição 

{
  "consult_id": "3c2b4317-e807-4666-8c68-e55f2a689581",
  "config_id": "8dd56cfa-5c86-413b-a973-69d3d1ad3c16"
}

Parâmetros da Requisição

  • consult_id: string(UUID)
    Identificador da consulta/consentimento usado para calcular as parcelas.
  • config_id: string(UUID)
    Identificador da configuração/taxa escolhida em GET /private-consignment/simulation/configs.

Uso no fluxo

Use este endpoint depois de consultar as configurações disponíveis e antes de criar a simulação completa em POST /private-consignment/simulation.

O retorno autenticado deve ser usado para apoiar o pré-cálculo das parcelas antes da simulação final. O schema de resposta de sucesso deve ser validado em ambiente autenticado antes de mapear campos no seu sistema.

Endpoint criar simulação

URL: https://bff.v8sistema.com/private-consignment/simulation

Método HTTP: POST

Autenticação: Requer token JWT válido no header da requisição.

Body da Requisição 

{
  "consult_id": "string",
  "config_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "installment_face_value": 0,
  "disbursed_amount": 0,
  "number_of_installments": 0,
  "provider": "QI"
}

Parâmetros da Requisição

  • consult_id: string
    identificador gerado ao aceitar o termo de consentimento.
  • config_id: string(UUID)
    id da tabela consultada na etapa anterior.
  • installment_face_value: Number
    Valor da parcela desejada.
  • disbursed_amount: Number
    Valor desejado para desembolso.
  • number_of_installments: Number
    Quantidade de parcelas para a simulação.
  • provider: string
    provedor que irá averbar o contrato CLT informar como QI.

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte

{
  "id_simulation": "string",
  "partner_id": "string",
  "number_of_installments": 0,
  "monthly_interest_rate": 0,
  "disbursement_amount": 0,
  "installment_value": 0,
  "operation_amount": 0,
  "issue_amount": 0,
  "disbursed_issue_amount": 0,
  "disbursement_option": {
    "iof_amount": 0,
    "total_pre_fixed_amount": 0,
    "cet": 0,
    "contract_fee_amount": 0,
    "disbursement_date": "string",
    "first_due_date": "string",
    "issue_amount": 0,
    "disbursed_issue_amount": 0,
    "assignment_amount": 0,
    "final_disbursement_amount": 0,
    "installments": [
      {
        "installment_number": 0,
        "calendar_days": 0,
        "workdays": 0,
        "business_due_date": "string",
        "due_date": "string",
        "due_principal": 0,
        "has_interest": true,
        "post_fixed_amount": 0,
        "pre_fixed_amount": 0,
        "tax_amount": 0,
        "total_amount": 0,
        "principal_amortization_amount": 0
      }
    ]
  }
}

Parâmetros da Response

  • id_simulation: string(UUID)
    identificador gerado ao realizar a simulação, deverá ser usado na criação da contrato.
  • installment_value: Number
    Valor da parcela que será descontado por mês.
  • number_of_installments: Number
    Quantidade de parcelas selecionadas na requisição da simulação.
  • operation_amount: Number
    Valor total da operação, soma total das parcelas.
  • issue_amount: Number
    Valor de emissão do contrato.
  • iof_amount: string
    Valor total de IOF que será descontado.
  • monthly_interest_rate: Number
    Taxa de juros ao mês.
  • disbursed_issue_amount: Number
    Valor disponivel para o desembolso.
  • first_installment_date: string
    Data de vencimento da primeira parcela.

Fluxo recomendado:

  • Consultar as taxas disponíveis para o provedor e condições desejadas.
  • Selecionar uma taxa identificada por Id.
  • Fazer o pré-cálculo de parcelas com consult_id e config_id.
  • Criar a simulação com base nessa taxa e demais parâmetros do cliente.
  • Exibir o resultado ao cliente para aprovação e eventual digitação/formalização da proposta.

Próximo passo

Com o id_simulation retornado, siga para Criação da Proposta Crédito CLT.

Previous
Termo de Consentimento
Next
Criação da Proposta Crédito CLT