Skip to main content

Solicitação de Cancelamento

Este fluxo descreve a solicitação de cancelamento de contrato iniciada pelo nosso sistema. Após receber a requisição, a API do parceiro deve processar a solicitação e enviar o webhook CONTRACT_STATUS_UPDATE com o novo status do contrato.

🔁 Visão Geral do Fluxo​

  1. Nosso sistema envia uma requisição CANCEL_REQUEST com o motivo do cancelamento.
  2. A API do parceiro processa a solicitação de cancelamento.
  3. O parceiro envia o webhook CONTRACT_STATUS_UPDATE com o status atualizado do contrato.

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

Endpoint (API do parceiro): definido pelo parceiro.

Payload:

{
  "contract_id": 1003,
  "partner_pay_subscription_id": 2003,
  "event": "CANCEL_REQUEST",
  "data": {
    "contract_reason_cancellation_id": 7
  }
}

📥 Webhook de retorno esperado​

Webhook CONTRACT_STATUS_UPDATE​

O parceiro deve enviar o status atualizado do contrato: Ag.Cancelamento.

🔗 Veja a documentação do webhook CONTRACT_STATUS_UPDATE

📋 Exemplo do fluxo completo​

🔄 Resposta esperada do webhook​

{
  "success": true
}