Price — Payload e campos

Quais campos envio em cada objeto.

Campos do cálculo

São 21 campos no total, 0 obrigatório(s), organizados da base comum até o que é exclusivo deste tipo. Só o que se aplica a ele aparece aqui.

Identificação, início e taxa

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`amortizationType`	`string`	opcional	Indica o tipo de tabela de amortização utilizada	—	`"texto"`
`startDate`	`string (date-time)`	opcional	Data de início	—	`"2025-08-11T13:45:00Z"`
`apr`	`number (double)`	opcional	Taxa de Juros	—	`1.99`
`includePaymentFixedCosts`	`boolean`	opcional	Incluir valor da parcela fixa na simulação	—	`true`
`validationErrors`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`agentCommissions`	`array de objeto`	opcional	Comissões devidas ao CORBAN/Parceiro originador da operação. Utilizado para compor o Custo de Emissão (TAC), observados os limites estabelecidos no produto	objeto — ver detalhe abaixo	`[ … ]`
`agentCommission`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`

Valor, IOF e indexador

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`financeTaxExempted`	`boolean`	opcional	Isenção de IOF	—	`true`
`fiduciaryGuarantee`	`number (double)`	opcional	Percentual de Garantia fiduciária	—	`1000`
`indexer`	`string`	opcional	Indexador Pós-Fixado que deve ser aplicado à cada parcela	—	`"texto"`
`indexerValue`	`number (double)`	opcional	Percentual Indexador Pós-fixado que deve ser aplicado à cada parcela	—	`1000`

Forma de cálculo do valor

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`calculateByValueType`	`string`	opcional	—	`Gross`, `Liquid`, `Payment`	`"Gross"`

Cronograma por dia de vencimento

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`requestedAmount`	`integer (int64)`	opcional	Valor solicitado	—	`0`
`paymentDay`	`integer`	opcional	Dia de vencimento	—	`0`
`absAmortizationInMonths`	`integer`	opcional	Carência de Principal	—	`0`
`absInterestInMonths`	`integer`	opcional	Carência de Juros	—	`0`
`periodicity`	`string`	opcional	—	`Monthly`, `Yearly`, `Daily`	`"Monthly"`
`daysInYear`	`integer`	opcional	Base de cálculo	—	`0`
`firstPaymentInterest`	`boolean`	opcional	Cobra juros na primeira parcela (em caso de ajuste de dia de vencimento)	—	`true`

Prazo exclusivo deste tipo

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`termInMonths`	`integer`	opcional	Duração em meses	—	`0`

Regras e valores aceitos

Os campos abaixo aceitam um conjunto fechado de valores. A lista é a do contrato para este tipo — outros tipos podem aceitar conjuntos diferentes.

`calculateByValueType`

Valor	Significado
`Gross`	Valor bruto - O valor de principal informado será considerado o valor de face da dívida emitida, sem realizar o financiamento das tarifas (TACs e IOF). O valor líquido final será menor que o valor do principal.
`Liquid`	Valor líquido - O valor de principal informado será considerado o valor líquido final desejado pelo tomador. Para tanto, será realizado o financiamento das tarifas (TACs e IOF), majorando o valor de face da dívida emitida.
`Payment`	Valor da parcela - o valor da parcela que será pago pelo cliente em cada vencimento. Só é válido para cálculos do tipo PRICE

`periodicity`

Valor	Significado
`Monthly`	Mensal
`Yearly`	Anual
`Daily`	Daily

Exemplo de objeto de cálculo

Gerado do contrato. Valores são amostras: troque pelos dados reais da operação.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortizationType": "texto",
  "startDate": "2025-08-11T13:45:00Z",
  "apr": 1.99,
  "includePaymentFixedCosts": true,
  "validationErrors": [
    {
      "memberNames": [
        "Fulano de Tal"
      ],
      "errorMessage": "texto"
    }
  ],
  "agentCommissions": [
    {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true
    }
  ],
  "agentCommission": {
    "name": "Fulano de Tal",
    "amount": 1000,
    "type": "Absolute",
    "baseValue": "InitialValue",
    "chargeCommissionFrom": "All",
    "financeCost": true,
    "totalValue": 0
  },
  "requestedAmount": 0,
  "financeTaxExempted": true,
  "fiduciaryGuarantee": 1000,
  "indexer": "texto",
  "indexerValue": 1000,
  "calculateByValueType": "Gross",
  "paymentDay": 0,
  "absAmortizationInMonths": 0,
  "absInterestInMonths": 0,
  "periodicity": "Monthly",
  "daysInYear": 0,
  "firstPaymentInterest": true,
  "termInMonths": 0
}

Campos da garantia

Esta operação não exige lastro. Se o produto contratado exigir, a garantia vai na lista warranty do mesmo corpo de criação, ao lado do objeto de cálculo, com o discriminador warrantyType em cada item.

Garantia — `Warranty`

Garantia genérica: registra apenas o tipo, sem campos específicos de bem ou margem. É o que se usa quando o lastro é descrito em texto livre no campo de garantia da operação.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty"
}

IntroduçãoO que é, quando usar e se exige garantia IntegraçãoComo integro, do zero à primeira operação Payload e camposQuais campos envio em cada objeto