Simulação Crédito CLT

A etapa de simulação do Crédito Privado CLT é composta por dois 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. Criação de simulação (POST /)
   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 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 vencimento da primeira parcela.

Fluxo recomendado:

• Consultar as taxas disponíveis para o provedor e condições desejadas.

• Selecionar uma taxa (identificada por 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.