Referência técnica · Catálogo

Tipos de operação, gerados do contrato.

São 10 tipos de operação disponíveis na API de Crédito. Cada um é uma finalidade de cálculo — o valor que vai em amortizationType — e é ele que determina quais campos a operação aceita e se ela exige garantia.

Tipos ativos

Tipos de garantia

Descontinuados

Como escolher. O tipo de operação é definido pelo produto contratado: o amortizationType que você envia precisa ser exatamente o do produto, senão a criação é rejeitada. Comece pela tabela abaixo para saber o que cada tipo calcula, e abra o tipo para ver os campos, as regras e — quando houver — a garantia que precisa acompanhar o envio.

Tipos de operação

A coluna Campos conta o payload de cálculo completo, herança incluída. Garantia diz se a operação precisa de lastro — e a página de cada tipo explica por quê.

10 tipos

Tipo de operação	Código do contrato	Cálculo	Garantia	Campos	Instrumento	Guia
Price (CleanPrice)Crédito em tabela Price sem exigência de garantia, no modelo por dia de vencimento. É a base de…	`CleanPrice`	Cronograma por dia de vencimento	Sem garantia1 tipo(s) aceito(s)	21	CCB	—
Financiamento EstudantilFinanciamento estudantil com duas fases: durante a graduação o aluno paga uma parcela fixa…	`StudentLoan`	Cronograma por dia de vencimento	Sem garantia1 tipo(s) aceito(s)	24	CCB	—
Price com garantia fiduciáriaTabela Price com percentual de garantia fiduciária sobre recebíveis. O cálculo herda o crédito…	`ReceivablesPrice`	Cronograma por dia de vencimento	Garantia obrigatória2 tipo(s) aceito(s)	21	CCB	—
Antecipação Saque-aniversário FGTSAntecipação do saque-aniversário do FGTS. O cronograma é definido pelo mês do saque e pelo saldo…	`FGTS`	Antecipação de saque FGTS	Averbação própria	11	CCB	abrir
Nota ComercialNota Comercial — título de dívida emitido por pessoa jurídica, com série, número de emissão…	`CommercialPapper`	Cronograma por dia de vencimento	Conforme o produto2 tipo(s) aceito(s)	21	CommercialPapper	—
SACSistema de Amortização Constante: a parcela de principal é fixa e a parcela total é decrescente…	`SAC`	Cronograma por data da primeira parcela	Conforme o produto5 tipo(s) aceito(s)	21	CCB	—
PriceTabela Price no modelo vigente: parcela constante, data exata da primeira parcela, quantidade de…	`Price`	Cronograma por data da primeira parcela	Conforme o produto12 tipo(s) aceito(s)	20	CCB	—
Price CoeficientePrice calculada por coeficiente: a parcela sai da multiplicação do valor contratado pelo…	`PriceCoefficient`	Cronograma por dia de vencimento	Conforme o produto5 tipo(s) aceito(s)	22	CCB	—
DescontoDesconto de títulos: o integrador envia a lista de títulos com valor de face e vencimento, e a…	`Discount`	Desconto de títulos	Garantia obrigatória2 tipo(s) aceito(s)	9	CCB	—
Antecipação de RecebíveisAntecipação de recebíveis por desconto a valor presente, com a metodologia da antecipação de…	`ReceivablesAdvance`	Cronograma por data da primeira parcela	Garantia obrigatória2 tipo(s) aceito(s)	17	CCB	—

Famílias de cálculo

Os tipos se agrupam pela forma de montar o cronograma. Reconhecer a família é o atalho para saber quais campos esperar antes de abrir o tipo.

Cronograma por data da primeira parcelaA operação é montada a partir da data exata da primeira parcela, da quantidade de parcelas e de um critério de contagem de dias. É o modelo vigente e o único que aceita cálculo pelo valor da parcela.

SAC Price Antecipação de Recebíveis

Cronograma por dia de vencimentoA operação é montada a partir de um dia fixo de vencimento e de carências em meses. Prazo em meses, base de dias no ano e periodicidade completam o cronograma.

Price (CleanPrice)Financiamento Estudantil Price com garantia fiduciária Nota Comercial Price Coeficiente

Antecipação de saque FGTSCronograma amarrado ao mês do saque-aniversário e ao saldo disponível na conta do FGTS.

Antecipação Saque-aniversário FGTS

Desconto de títulosNão há parcelas calculadas: o integrador informa os títulos com valor de face e vencimento, e a operação devolve o valor presente.

Desconto

Modelos de cálculo descontinuados

Estes valores ainda aparecem no contrato, mas a API os rejeita. A criação e a simulação respondem "Modelo de cálculo não suportado. Entre em contato com a equipe de suporte." Estão listados aqui porque continuam visíveis no enum do contrato — e quem os encontrar precisa saber para onde migrar.

Código do contrato	Era	Use em vez dele
`HomeEquityPrice`	Home Equity - Price	Não use. Para Home Equity, use a finalidade Price (parcela constante) ou SAC (amortização constante), com garantia de imóvel.
`HomeEquitySac`	Home Equity - SAC	Não use. Para Home Equity com amortização constante, use a finalidade SAC com garantia de imóvel.
`CleanPriceIncentivized`	Price incentivada	Não use. Trate a linha incentivada como configuração do produto contratado, sobre a finalidade Price ou Price sem garantia.
`Consignado`	Crédito Consignado Privado Simples	Não use. O consignado hoje roda na finalidade Price, com a garantia definindo a modalidade: Consignado privado, INSS, Consignado público ou Cartão consig. saque.
`CleanPriceNoIOF`	Price (sem repasse de IOF)	Não use. Para não financiar o IOF, use a isenção no objeto de cálculo (`financeTaxExempted`) sobre a finalidade Price ou Price sem garantia.