POST
Simular condições de empréstimo pessoal
Simula as condições de um empréstimo pessoal (valor, parcelas, taxas) antes de criar a proposta. Cada opção de parcelamento traz o period (nº de parcelas); use o code retornado + o period escolhido para depois Contratar.
O campo rebateId é opcional. Se omitido, a simulação usa a tabela padrão configurada para o lojista (tenant ou filial). Envie apenas quando precisar de uma tabela específica.
Os ids de tabela configurados para a sua loja (e o padrão de cada produto) estão em Listar tabelas.
Autentique-se antes (Autenticação). Os campos abaixo são o conteúdo de result do envelope.

Periodicidade das parcelas (opcional)

Disponível apenas para lojas com a periodicidade de parcelas habilitada pela HubCred, e cada periodicidade (mensal, diária, semanal, quinzenal) é habilitada separadamente para a loja. Com a periodicidade habilitada, uma simulação numa periodicidade não habilitada é recusada, inclusive a mensal (simulação sem installmentIntervalDays). Lojas sem a periodicidade habilitada mantêm a simulação mensal de sempre. Fale com o seu contato na HubCred para habilitar.
Por padrão a simulação é mensal e devolve todas as opções de prazo da tabela. Para parcelas diárias, semanais ou quinzenais, envie os dois campos abaixo juntos: Regras:
  • period sozinho não escolhe um prazo: sem installmentIntervalDays ele é ignorado, e a simulação mensal continua devolvendo todas as opções.
  • period é um número inteiro. Um valor que não seja inteiro é recusado como erro de validação.
  • Com intervalo, firstInstallmentDate não pode ser anterior a hoje mais o intervalo (por exemplo, hoje mais 7 dias na semanal). “Hoje” é a data do servidor.
  • Com intervalo, a resposta traz uma única opção em installments, com a quantidade de parcelas pedida. Use o period dela ao Contratar.
Cada opção de installments traz dois campos sobre a periodicidade:
As datas simuladas valem para o dia da simulação. Se a proposta for aprovada quando a primeira parcela simulada já não couber mais no prazo mínimo, ou se a periodicidade for desabilitada para a loja depois da simulação, a aprovação é recusada e é preciso simular de novo.
A simulação é recusada quando:

Dias sem parcela (só na diária)

Na parcela diária (installmentIntervalDays igual a 1), as datas pulam os dias que a loja configurou com a HubCred (dias da semana e datas específicas). A simulação não envia nada para isso. Os campos skipWeekdays e skipDates não fazem mais parte do contrato. Se ainda forem enviados, são ignorados sem erro, e a configuração da loja se aplica. Pular um dia estica a agenda: a quantidade de parcelas (period) não muda, e o último vencimento vai mais longe. Por exemplo, 30 parcelas diárias pulando os domingos ocupam 34 dias quando o período tem 4 domingos. A resposta não ganha campo: o schedule já vem sem os dias pulados, e intervalDays continua 1. A simulação é recusada quando:

Body

Input com os dados para simulação

Dados de entrada para simulação de empréstimo pessoal.

value
number<double>

Valor desejado do empréstimo.

cpf
string | null

CPF do cliente.

firstInstallmentDate
string<date-time>

Data da primeira parcela.

rebateId
integer<int32> | null

Identificador da tabela de rebate/comissão, quando aplicável.

installmentIntervalDays
integer<int32> | null

Intervalo em dias entre parcelas: 1 (diário), 7 (semanal) ou 15 (quinzenal). Quando ausente, a simulação é mensal (comportamento padrão). Só é aceito quando a função de parcelas não mensais está habilitada para a empresa; sem ela, a simulação é recusada. Com intervalo, period é obrigatório. Com intervalo, firstInstallmentDate não pode ser anterior a hoje mais o intervalo. Com intervalo, a resposta traz uma única opção em installments, com a agenda de vencimentos em schedule dentro dela.

period
integer<int32> | null

Número de parcelas. Obrigatório quando installmentIntervalDays é informado; ignorado quando informado sem ele.

Response

OK

Resultado da simulação de empréstimo pessoal.

code
string | null

Código público da simulação/operação — use ao contratar.

value
number<double>

Valor simulado.

maxValue
number<double> | null

Valor máximo disponível, quando aplicável.

registryCode
string | null

CPF/CNPJ do cliente.

installments
object[] | null

Opções de parcelamento simuladas.