Skip to main content

Exemplos

Casos completos, do primeiro ensaio ao aditamento aplicado.

1. Repactuar o fluxo de pagamento​

O cenário mais comum: o emissor pede mais prazo e as partes acordam uma taxa nova.

Passo 1 — Simular​

Antes de qualquer compromisso, veja o efeito no fluxo e quanto custa o aditamento.

POST /security_amendment/amendment/simulation
{
  "security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
  "financial_base_date": "2026-09-20",
  "changes": [
    {
      "type": "financial_flow",
      "operation": "modification",
      "new_value": {
        "installments": [
          { "installment_number": 3, "due_date": "2026-10-20" },
          { "installment_number": 4, "due_date": "2026-11-20" },
          { "installment_number": 5, "due_date": "2026-12-20" }
        ]
      }
    }
  ]
}

Confira closing.passed na resposta. Se vier false, o fluxo proposto não fecha e o aditamento nasceria recusado — ajuste antes de seguir.

Passo 2 — Validar​

Mesmo corpo da criação, sem criar. Confirme o next_status.

POST /security_amendment/amendment/validation

Passo 3 — Criar​

POST /security_amendment/amendment
{
  "amendment_key": "7f1c9a20-6c3e-4a51-9f0b-2d8e5b4c1a33",
  "security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
  "financial_base_date": "2026-09-20",
  "signature_method": "certifiqi",
  "changes": [
    {
      "type": "financial_flow",
      "operation": "modification",
      "new_value": {
        "interest_rate": { "monthly_rate": 0.0199, "interest_base": "workdays" },
        "installments": [
          { "installment_number": 3, "due_date": "2026-10-20" },
          { "installment_number": 4, "due_date": "2026-11-20" },
          { "installment_number": 5, "due_date": "2026-12-20" }
        ]
      }
    }
  ]
}

Passo 4 — Pagar a taxa​

Consulte o aditamento e pegue a linha digitável em charges[].digitable_line. O aditamento fica em pending_charge_settlement até a compensação.

GET /security_amendment/amendment/7f1c9a20-6c3e-4a51-9f0b-2d8e5b4c1a33

Passo 5 — Coletar assinaturas​

Com a taxa paga, o termo vai para assinatura. Pegue os links:

GET /security_amendment/amendment/7f1c9a20-6c3e-4a51-9f0b-2d8e5b4c1a33/signers

Passo 6 — Acompanhar a aplicação​

Assinado o termo, o aditamento vai para pending_application e é aplicado na financial_base_date. Quando chega a applied, o campo applied_at é preenchido e new_financial_key aponta para o fluxo novo.

2. Substituir uma garantia​

Remover a garantia antiga e incluir a nova no mesmo aditamento — assim as duas alterações valem juntas, e o título nunca fica descoberto.

POST /security_amendment/amendment
{
  "security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
  "financial_base_date": "2026-09-20",
  "changes": [
    {
      "type": "collateral",
      "operation": "removal",
      "target_key": "a1b2c3d4-0000-4000-8000-000000000001",
      "term_wording": "Fica liberada a garantia constituída sobre o veículo de placa ABC1D23."
    },
    {
      "type": "collateral",
      "operation": "addition",
      "new_value": {
        "collateral_type": "fiduciary_alienation_vehicle",
        "description": "Veículo dado em substituição",
        "value": 92000.00
      }
    }
  ]
}
Tudo ou nada

As alterações de um mesmo aditamento são aplicadas em conjunto. Em uma substituição, isso garante que a liberação da garantia antiga e a constituição da nova acontecem no mesmo ato.

3. Incluir um avalista que assina o termo​

A parte incluída pelo aditamento também precisa assinar o termo aditivo — então ela traz o próprio grupo de assinatura.

POST /security_amendment/amendment
{
  "security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
  "financial_base_date": "2026-09-20",
  "signature_method": "certifiqi",
  "changes": [
    {
      "type": "related_party",
      "operation": "addition",
      "is_term_signer": true,
      "new_value": {
        "person_type": "natural",
        "name": "Maria Oliveira",
        "document_number": "96969879003",
        "role_type": "surety",
        "street": "Avenida Brigadeiro Faria Lima",
        "number": "1234",
        "neighborhood": "Itaim Bibi",
        "city": "São Paulo",
        "state": "SP",
        "postal_code": "01451-001",
        "signer_group_list": [
          {
            "minimum_required_signers": 1,
            "signers": [
              {
                "name": "Maria Oliveira",
                "document_number": "969.698.790-03",
                "email": "maria.oliveira@exemplo.com.br",
                "is_group_mandatory": true
              }
            ]
          }
        ]
      }
    }
  ]
}
E-mail com CertifiQI

Com signature_method: certifiqi, o email de cada signatário é obrigatório. Sem ele, a criação é recusada com AMD000042.

4. Enviar o termo já redigido​

Quando o escritório do emissor redige o termo, envie-o na criação. O aditamento entra em conferência da QI Tech antes de seguir.

POST /security_amendment/amendment
{
  "security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
  "financial_base_date": "2026-09-20",
  "changes": [
    {
      "type": "issue_number",
      "operation": "modification",
      "new_value": { "issue_number": 2 }
    }
  ],
  "documents": [
    {
      "document_type": "amendment_term",
      "document_name": "termo-aditivo-002.pdf",
      "document_base64": "JVBERi0xLjQKJeLjz9MK..."
    }
  ]
}

O aditamento nasce em pending_manual_approval. Acompanhe pelo status: aprovado, ele segue para a cobrança; recusado, vai para canceled com status_reason: manual_approval_rejected.

5. Desistir de um aditamento​

PATCH /security_amendment/amendment/7f1c9a20-6c3e-4a51-9f0b-2d8e5b4c1a33/cancel

Sem corpo. Aceito até pending_signature_confirmation. O boleto em aberto é baixado e o envelope de assinatura é cancelado.

Veja também​