Skip to main content

Alterar Data de Pagamento

Este fluxo descreve a solicitação de alteração da data de pagamento de um contrato, iniciada pelo nosso sistema, e a respectiva confirmação por webhook enviada pelo sistema do parceiro.

🔁 Visão Geral do Fluxo​

  1. Nosso sistema envia uma requisição para a API do parceiro solicitando a alteração da data de pagamento.
  2. A API do parceiro processa a solicitação.
  3. Após o processamento, o parceiro envia o webhook PAYMENT_DATE_UPDATE para confirmar a alteração.

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

Endpoint (API do parceiro): definido pelo parceiro.

Payload:

{
  "contract_id": 12345,
  "partner_pay_subscription_id": 67890,
  "event": "PAYMENT_DATE_UPDATE",
  "data": {
    "companie_user_id": 4,
    "payday": "2025-08-15"
  }
}

✅ Regras da solicitação​

  • A nova data (payday) deve estar no futuro e no formato YYYY-MM-DD.

📥 Webhook de retorno esperado​

Após processar a alteração, a API do parceiro deve nos enviar o webhook PAYMENT_DATE_UPDATE.

🔗 Veja a documentação do webhook PAYMENT_DATE_UPDATE

📋 Exemplo do fluxo completo​

🧪 Considerações técnicas​

  • A requisição pode ser assíncrona: a resposta da API do parceiro não confirma o sucesso, apenas o webhook.
  • O parceiro deve garantir retentativas caso o webhook falhe.

🔄 Resposta esperada do webhook​

{
  "success": true
}