Skip to main content

Lançamento Financeiro

Este webhook deve ser enviado para nossa API sempre que for lançado um registro financeiro relacionado a um contrato, como uma nova cobrança gerada no sistema do parceiro.


📦 Exemplo de Payload​

{
"event_type": "INSERTED_FINANCIAL",
"contract_id": 123,
"data": {
"financial": {
"partner_pay_subscription_id": "123",
"partner_pay_id": "456",
"partner_pay_link": "https://pagamento.com/link",
"status": "Aberta",
"status_description": "Aguardando pagamento",
"value": 250,
"due_date": "2024-06-10T15:30:00Z",
"received_date": "2024-06-10T15:30:00Z",
"received_value": 250
}
}
}

🧾 Campos​

CampoTipoObrigatórioDescrição
event_typestring✅Identificador do tipo de evento: INSERTED_FINANCIAL
contract_idinteger✅ID do contrato no nosso sistema
data.financial.partner_pay_subscription_idstring✅ID da assinatura associada à cobrança
data.financial.partner_pay_idstring✅ID da cobrança individual
data.financial.partner_pay_linkstring (URL)✅Link para o pagamento
data.financial.statusstring✅Status atual da cobrança (ex: Aberta)
data.financial.status_descriptionstring✅Descrição textual do status
data.financial.valuenumber✅Valor total da cobrança
data.financial.due_datestring (ISO 8601)✅Data de vencimento
data.financial.received_datestring (ISO 8601)✅Data em que o pagamento foi recebido (se houver)
data.financial.received_valuenumber✅Valor efetivamente pago

🔄 Resposta esperada​

{
"success": true
}