Resumo: pela API você lê produtos e carteiras e simula parcelas. Criar e editar produto é feito na tela de Produtos. Conceitos em Produtos e Precificação.
Ler a configuração de propostas
Esteira que toda proposta do canal de correspondentes roda ao nascer.
null enquanto a organização não escolheu uma.Listar carteiras
Listar produtos
Ler um produto
productKey ao criar a proposta.
Como o valor é definido:
mode FIXED (com valueCents), RANGE (com minCents e ou maxCents) ou FREE.Estrutura financeira. Veja abaixo.
O que roda quando a solicitação conclui:
kind POLICY ou OPERATION e o id da política ou da esteira. Com um destino por tipo de cliente, vem kind: "NONE", id: null e byEntityType com PERSON e ou COMPANY, cada um com o seu kind e id.Estrutura financeira
A estrutura financeira (pricing) é o mesmo objeto no produto, na proposta (pricingSnapshot) e na simulação. Dinheiro em centavos, taxas em pontos-base.
Componentes de
rate:
A fórmula de cada componente está em Precificação.
Listar modelos de estrutura financeira
key, name, description e a pricing completa (resumida acima).
Consultar os índices de mercado
Simular parcelas
pricing de um produto (de GET /v1/products/{key}) para mostrar ao cliente quanto ele vai pagar antes de criar a proposta.
Estrutura financeira. Formato em Estrutura financeira.
Spread de risco, em pontos-base ao ano, a partir de
0. Ausente: a simulação usa o teto do componente RISK e avisa.Valores de índice para esta simulação, com as chaves de
assumptions (por exemplo, { "cdiBpsYear": 1400 }). Vencem o valor de mercado.assumptions desta chamada, o fixado no produto, o de mercado do dia, a premissa do produto e, por último, um padrão. Cada valor usado sai em indexValuesUsed, com origem e fonte.
Uma linha por parcela:
n, paymentCents, interestCents, amortizationCents, correctionCents (correção monetária do saldo, não é pagamento), feesCents, balanceCents e isGrace.Cada índice usado, com
key, label, bpsYear, origin (INPUT, PRODUCT_FIXED, MARKET, PRODUCT ou DEFAULT), data de referência, fonte e uma descrição pronta, como "CDI 14,90% a.a. em 23/09/2026, BCB-SGS 4392".400 com todas as falhas juntas.

