Price — Integraçã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 CleanPrice. Ele precisa ser exatamente o tipo do produto contratado — se divergir, a criação é rejeitada.

{
  "amortization": {
    "amortizationType": "CleanPrice"
  }
}

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": "CleanPrice" },
  "warranty": [
    { "warrantyType": "Warranty" }
  ]
}

São 1 tipo(s) de garantia utilizáveis nesta operação. Os campos de cada um estão em Payload e campos.

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

• Não há garantia obrigatória por natureza da finalidade. Se o produto contratado exigir lastro, o envio para aprovação passa a exigir ao menos uma garantia.
• Cálculo pelo valor da parcela não é suportado: "Operação inválida: este produto não suporta cálculo pelo valor de parcela." Só as finalidades Price e SAC aceitam esse modo.