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
boolean
true quando as carteiras estão ligadas. Desligado por padrão.string | null
Esteira que toda proposta do canal de correspondentes roda ao nascer.
null enquanto a organização não escolheu uma.Listar carteiras
integer
Produtos na carteira.
integer
Soma das propostas em
IN_ANALYSIS, WAITING_CUSTOMER e WAITING_OPERATOR, em centavos.integer
Soma das propostas que chegaram a
OFFER_ISSUED nos últimos 30 dias, em centavos.Listar produtos
string
FINANCING (financiamento) ou INSTALLMENT_SALE (venda a prazo).string
Id da carteira.
string
true para só os ligados, false para só os desligados. Ausente: todos.Ler um produto
productKey ao criar a proposta.
string
required
Chave do produto: letras, números,
- e _, sem espaço, até 60 caracteres.string
Chave estável do produto. Não muda depois de criada.
string
FINANCING ou INSTALLMENT_SALE.string | null
Finalidade, do catálogo de objetivos da política de crédito.
string[]
COMPANY, PERSON ou os dois. Vazio: atende os dois.boolean
Se o cliente vê o valor e a faixa na página da oferta.
object | null
Como o valor é definido:
mode FIXED (com valueCents), RANGE (com minCents e ou maxCents) ou FREE.object[]
Documentos que o produto pede ao cliente, somados aos do modelo de solicitação.
object | null
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.boolean
Produto desligado não aceita proposta nova. Propostas que já o usaram não mudam.
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
boolean
false quando não há valor. A simulação usa então fallbackBpsYear e avisa.integer | null
Valor em pontos-base ao ano.
1490 = 14,90% a.a.string | null
Chave em
assumptions que este índice alimenta.boolean
true quando a atualização falhou e este é o último valor bom guardado.Simular parcelas
pricing de um produto (de GET /v1/products/{key}) para mostrar ao cliente quanto ele vai pagar antes de criar a proposta.
object
required
Estrutura financeira. Formato em Estrutura financeira.
integer
required
Valor, em centavos. Mínimo
1.integer
required
Prazo, em meses. De
1 a 600.integer
Carência, em meses. De
0 a 120, limitada ao que a estrutura permite.integer
Spread de risco, em pontos-base ao ano, a partir de
0. Ausente: a simulação usa o teto do componente RISK e avisa.string
COMPANY ou PERSON. Muda a alíquota diária do IOF.object
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.
object[]
Uma linha por parcela:
n, paymentCents, interestCents, amortizationCents, correctionCents (correção monetária do saldo, não é pagamento), feesCents, balanceCents e isGrace.integer
Soma de tudo que o cliente paga.
integer
Custo efetivo total, em pontos-base ao ano.
boolean
true quando a taxa depende de índice: o cronograma é uma estimativa com o valor de hoje.object[]
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".string[]
Avisos do cálculo, em português. Mostre ao usuário.
400 com todas as falhas juntas.