Antecipação Saque-aniversário FGTS — Integração

Como integro, do zero à primeira operação.

1. Declare o tipo da operação

No corpo de criação, o objeto de cálculo leva o discriminador amortizationType com o valor FGTS. Ele precisa ser exatamente o tipo do produto contratado — se divergir, a criação é rejeitada.

{
  "amortization": {
    "amortizationType": "FGTS"
  }
}

2. Simule

A simulação devolve plano de pagamento, CET, IOF e custo de emissão antes de contratar. Use os campos da página Payload e campos.

POST /v{version}/AmortizationCria um novo registro de Amortization.

3. Crie a operação

O objeto de cálculo e as garantias vão no mesmo corpo.

POST /v{version}/CreditNoteCria um novo registro de Credit Note.

{
  "amortization": { "amortizationType": "FGTS" },
  "warranty": []
}

Averbação em etapa própria. Não se envia objeto de garantia nesta operação: depois da criação, ela entra numa etapa dedicada de averbação e aguarda o retorno do órgão.

4. Acompanhe até a liquidação

Anexe documentos, submeta à esteira e acompanhe o status. Quando o produto contratado exige lastro, o envio para aprovação é rejeitado sem garantia e a operação passa por uma etapa de garantia antes de seguir.

Ver o fluxo completo na Referência de API

Regras que valem nesta operação

A averbação tem etapa própria na esteira, exclusiva desta finalidade: a operação assume a etapa de garantia e aguarda o retorno do FGTS, respeitando janela de manutenção do órgão.
Há limite anual de contratos por titular: exceder bloqueia o envio para aprovação.
O consentimento do titular para a consulta ao FGTS é documento de guarda obrigatória.

Abrir o guia deste produto

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