Antecipação Saque-aniversário FGTS — Payload e campos

Quais campos envio em cada objeto.

Campos do cálculo

São 11 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	`{ … }`

Prazo, valor e mês do saque exclusivo deste tipo

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`termInMonths`	`integer`	opcional	Duração em meses	—	`0`
`requestedAmount`	`integer (int64)`	opcional	Valor solicitado	—	`0`
`paymentMonth`	`string`	opcional	—	`NotSet`, `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`	`"NotSet"`

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.

`paymentMonth`

Valor	Significado
`NotSet`	Não utilizado
`January`	Janeiro
`February`	Fevereiro
`March`	Março
`April`	Abril
`May`	Maio
`June`	Junho
`July`	Julho
`August`	Agosto
`September`	Setembro
`October`	Outubro
`November`	Novembro
`December`	Dezembro

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
  },
  "termInMonths": 0,
  "requestedAmount": 0,
  "paymentMonth": "NotSet"
}

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