Skip to main content

Baixa Manual de Pagamento

Este fluxo descreve a baixa manual de pagamentos iniciada pelo nosso sistema. A requisição é enviada para a API do parceiro contendo múltiplos itens pagos, e o parceiro responde com um webhook FINANCIAL_STATUS_UPDATE para cada item da baixa.

🔁 Visão Geral do Fluxo​

  1. Nosso sistema envia uma requisição MANUAL_PAYMENT para a API do parceiro com a lista de cobranças pagas.
  2. A API do parceiro processa cada item.
  3. Para cada item, o parceiro envia um webhook FINANCIAL_STATUS_UPDATE com os dados atualizados do pagamento.

📤 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": "MANUAL_PAYMENT",
  "data": {
    "items": [
      {
        "partner_pay_id": 111,
        "received_value": 250.0,
        "obs": "Pagamento manual realizado por transferência bancária."
      },
      {
        "partner_pay_id": 112,
        "received_value": 150.0,
        "obs": "Pagamento manual realizado por transferência bancária."
      }
    ],
    "received_date": "2024-06-10T15:30:00Z"
  }
}

✅ Regras da solicitação​

  • Cada partner_pay_id deve estar associado a uma cobrança válida e aberta.
  • O received_value não pode ser maior que o valor original da cobrança.
  • A data de pagamento (received_date) deve estar no formato (YYYY-MM-DD).

📥 Webhooks de retorno esperados​

Após o processamento, a API do parceiro deve nos enviar um webhook FINANCIAL_STATUS_UPDATE para cada item da lista informando a confirmação do pagamento.

🔗 Veja a documentação do webhook FINANCIAL_STATUS_UPDATE

📋 Exemplo do fluxo completo​

🧪 Considerações técnicas​

  • O parceiro deve garantir que todos os webhooks sejam enviados, mesmo que parcialmente falhem.
  • Webhooks devem ser reentregues caso haja falha de resposta (status ≠ 2xx).

🔄 Resposta esperada dos webhooks​

{
  "success": true
}