POST
Simula as condições de uma Operação de Crédito.
Simula as condições de uma Operação de Crédito (valor, parcelas, taxas) antes de criar a proposta. Cada opção de parcelamento traz o period (nº de parcelas); use o code retornado e o period escolhido para depois Contratar. Na Operação de Crédito a loja empresta o próprio dinheiro: não há CCB nem proposta em banco, e o cliente assina uma confissão de dívida.
O campo rebateId é opcional. Se omitido, a simulação usa a tabela padrão configurada para o lojista (tenant ou filial). Os ids de tabela da sua loja estão em Listar tabelas, com product=7.

Data da primeira parcela

A firstInstallmentDate tem limite, conferido pela API:
  • não pode estar no passado (“Data da primeira parcela no passado.”);
  • não pode passar do número máximo de dias que a loja configurou para a primeira parcela. O limite é um para tabelas mensais e outro para tabelas semanais, e vale o da tabela usada na simulação (a do rebateId ou, sem ele, a padrão). Acima do limite, a simulação é recusada com “Data da primeira parcela acima do limite de N dias.”.
Autentique-se antes (Autenticação). Os campos abaixo são o conteúdo de result do envelope.

Body

Dados para simulação.

Dados de entrada para simulação de Operação de Crédito.

value
number<double>

Valor desejado da operação.

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. Define a periodicidade: tabelas mensais (type 0 ou nulo) usam o limite mensal da loja, tabelas semanais (type 1) usam o limite semanal.

Response

OK

Resultado da simulação de Operação de Crédito.

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.