Skip to main content

Negociação de Multa

Este fluxo descreve uma negociação de multa contratual iniciada pelo nosso sistema. A solicitação é enviada à API do parceiro, e após o processamento, o parceiro deve:

  1. Enviar o webhook INSERTED_FINANCIAL_NEGOCIATION com os dados da cobrança negociada.
  2. Enviar o webhook CONTRACT_STATUS_UPDATE com o novo status do contrato: Ag.Cancelamento.

🔁 Visão Geral do Fluxo​

  1. Nosso sistema envia a requisição NEGOCIATION_CANCEL com os dados da negociação de multa.
  2. A API do parceiro processa a negociação.
  3. O parceiro envia o webhook INSERTED_FINANCIAL_NEGOCIATION.
  4. O parceiro envia o webhook CONTRACT_STATUS_UPDATE com o status Ag.Cancelamento.

📤 Requisição enviada pelo nosso sistema (para o parceiro)​

Endpoint (API do parceiro): definido pelo parceiro.

Payload:

{
  "contract_id": 1001,
  "partner_pay_subscription_id": 2001,
  "event": "NEGOCIATION_CANCEL",
  "data": {
    "financials": [
      { "partner_pay_id": "pp_abc123" },
      { "partner_pay_id": "pp_def456" }
    ],
    "form_of_payment": "credit_card",
    "method": "in_sight",
    "installment": 3,
    "value": 1500.75,
    "first_pay_day_date": "2025-08-01"
  }
}

✅ Regras da solicitação​

  • Todos os partner_pay_id devem estar associados a cobranças existentes e passíveis de negociação.
  • A data (first_pay_day_date) deve estar no formato YYYY-MM-DD.

📥 Webhooks de retorno esperados​

1. Webhook INSERTED_FINANCIAL_NEGOCIATION​

Enviado com os dados da nova cobrança parcelada da negociação. 🔗 Veja a documentação do webhook INSERTED_FINANCIAL_NEGOCIATION

2. Webhook CONTRACT_STATUS_UPDATE​

Enviado com status Ag.Cancelamento para atualizar o contrato. 🔗 Veja a documentação do webhook CONTRACT_STATUS_UPDATE

📋 Exemplo do fluxo completo​

🧪 Considerações técnicas​

  • O parceiro deve garantir o envio dos dois webhooks, mesmo que ocorram em momentos diferentes.
  • Os webhooks devem ser reenviados em caso de falha (resposta ≠ 2xx).

🔄 Resposta esperada dos webhooks​

{
  "success": true
}