Crédito Consignado Privado Simples — Integração

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

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. O consignado hoje roda na finalidade Price, com a garantia definindo a modalidade: Consignado privado, INSS, Consignado público ou Cartão consig. saque.

1. Declare o tipo da operação

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

{
  "amortization": {
    "amortizationType": "Consignado"
  }
}

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": "Consignado" },
  "warranty": []
}

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

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