Home Equity - SAC — Payload e campos

Quais campos envio em cada objeto.

Modelo de cálculo descontinuado. O contrato ainda publica este valor no enum, mas a API o rejeita: a criação e a simulação respondem "Modelo de cálculo não suportado. Entre em contato com a equipe de suporte." Não integre com ele. Não use. Para Home Equity com amortização constante, use a finalidade SAC com garantia de imóvel.

Campos do cálculo

São 21 campos no total, 4 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"`
`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
`requestedAmount`	`integer (int64)`	opcional	Valor solicitado	—	`0`
`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 data da primeira parcela

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`firstPaymentDate`	`string (date-time)`	obrigatório	Data de início	—	`"2025-08-11T13:45:00Z"`
`numberOfPayments`	`integer`	obrigatório	Número de parcelas	—	`0`
`numberOfInterestPayments`	`integer`	opcional	Parcelas de pagamento de juros	—	`0`
`apr`	`number (double)`	opcional	Taxa de Juros em base mensal	—	`1.99`
`calculationType`	`string`	obrigatório	—	`V252DiasUteis`, `V252MesesX21`, `V360DiasCorridos`, `V360Meses`, `V365DiasCorridos`, `V365Meses`, `Irregular`	`"V252DiasUteis"`
`paymentPeriodicity`	`objeto`	obrigatório	—	objeto — ver detalhe abaixo	`{ … }`
`dueDateOnBusinessDays`	`boolean`	opcional	Datas de vencimento são ajustadas para o próximo dia útil	—	`true`
`discountMode`	`boolean`	opcional	Calcula o juros baseado no valor de amortização em relação à data de início. Caso contrário, calcula o juros baseasdo no saldo devedor em relação à ultima parcela.	—	`true`

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

`calculationType`

Valor	Significado
`V252DiasUteis`	V252 Dias Uteis
`V252MesesX21`	V252 Meses X21
`V360DiasCorridos`	V360 Dias Corridos
`V360Meses`	V360 Meses
`V365DiasCorridos`	V365 Dias Corridos
`V365Meses`	V365 Meses
`Irregular`	Irregular

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",
  "firstPaymentDate": "2025-08-11T13:45:00Z",
  "numberOfPayments": 0,
  "numberOfInterestPayments": 0,
  "calculationType": "V252DiasUteis",
  "paymentPeriodicity": {
    "every": 0,
    "periodicity": "Monthly"
  },
  "dueDateOnBusinessDays": true,
  "discountMode": true
}

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