Servicing e Gestão de Cobrança

Após a conclusão do desembolso (DISBURSED), a operação de crédito entra na fase de Servicing, permitindo a gestão do cronograma de parcelas, emissão de cobranças Pix e liquidações parciais ou totais.


1. Consultar o Plano de Pagamento Ativo

O plano de pagamento reúne o cronograma de amortização, dados das parcelas e cobranças geradas.

GET /credit-operations/{externalContractId}/payment-plan

Exemplo de Resposta (200 OK)

{
  "id": "7f8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
  "contractId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "externalContractId": "CONTRATO-2026-001",
  "status": "ACTIVE",
  "type": "ORIGINAL",
  "interest": 2.99,
  "originationDate": "2026-09-01T10:00:00Z",
  "interval": "MONTHLY",
  "installments": [
    {
      "number": 1,
      "status": "OPEN",
      "dueDate": "2026-10-01T00:00:00Z",
      "chargedValue": 542.80,
      "amortization": 450.00,
      "interest": 92.80,
      "paidAt": null,
      "paidAmount": null,
      "remainingAmount": 542.80,
      "isCompletelyPaid": false,
      "billings": []
    }
  ]
}

2. Emissão de Cobrança Pix Dinâmico

Para disponibilizar um meio de pagamento ao tomador, gere uma cobrança Pix dinâmico vinculada à parcela:

POST /credit-operations/{externalContractId}/billings
Content-Type: application/json

{
  "type": "PIX",
  "installmentNumber": 1,
  "dueDate": "2026-10-01T23:59:59Z",
  "amount": 542.80
}

A resposta retornará o código Copia e Cola (emv) e o QR Code em Base64 (imageBase64):

{
  "externalId": "bill-12345678-abcd",
  "type": "PIX",
  "status": "OPEN",
  "dueDate": "2026-10-01T23:59:59Z",
  "chargedValue": 542.80,
  "paidAmount": null,
  "paidAt": null,
  "pixInfo": {
    "identifier": "txid-pix-001",
    "emv": "00020126580014br.gov.bcb.pix...",
    "imageBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
    "expirationDate": "2026-10-01T23:59:59Z"
  }
}

3. Pagamento e Liquidação de Parcelas

O LaaS disponibiliza três operações de pagamento:

  1. Pagamento / Amortização Parcial:
    POST /credit-operations/{externalContractId}/installments/{installmentNumber}/payments
    • Se o valor pago for inferior ao saldo devedor da parcela, o status transiciona para PARTIALLY_PAID.
    • Se for igual ou superior, a parcela transiciona para PAID.
  2. Liquidação Individual de Parcela:
    POST /credit-operations/{externalContractId}/installments/{installmentNumber}/liquidate
    • Quita todo o saldo remanescente da parcela informada (PAID).
  3. Liquidação Antecipada Integral do Plano:
    POST /credit-operations/{externalContractId}/payment-plan/liquidate
    • Quita todas as parcelas em aberto e finaliza o plano de pagamento como PAID.

4. Regra de Negócio: Liquidação Externa e Perda de Lastro

⚠️

Aviso Crítico — Liquidação Externa e Perda de Lastro

  1. Permissão de Produto Obrigatória: As chamadas de liquidação externa exigem que o produto de crédito vinculado à operação esteja configurado para aceitar a liquidação externa, caso contrario a api retornara 403 Forbidden.

  2. Perda de Lastro da Operação: Tenha ciência de que, para liquidações originadas de fontes externas diretamente pelo parceiro, perde-se o lastro financeiro e regulatório da operação na esteira LaaS.


Did this page help you?