Skip to main content

Lançamento de Negociação Financeira

Este webhook deve ser enviado para nossa API sempre que for realizada uma negociação financeira no sistema do parceiro, gerando uma nova cobrança relacionada ao contrato.


📦 Exemplo de Payload​

{
"event_type": "INSERTED_FINANCIAL_NEGOCIATION",
"contract_id": 123,
"data": {
"financial": {
"installment": 12,
"method": "in_sight",
"form_of_payment": "creditcard",
"partner_pay_subscription_id": "123",
"partner_pay_id": "456",
"partner_pay_link": "https://pagamento.com/link",
"status": "Aberta",
"status_description": "Ainda não capturada na operadora",
"value": 250,
"first_pay_day_date": "2024-06-10T15:30:00Z"
}
}
}

🧾 Campos​

CampoTipoObrigatórioDescrição
event_typestring✅Identificador do evento: INSERTED_FINANCIAL_NEGOCIATION
contract_idinteger✅ID do contrato no nosso sistema
data.financial.installmentinteger✅Número de parcelas negociadas
data.financial.methodstring✅Modalidade de pagamento (ex: in_sight)
data.financial.form_of_paymentstring✅Forma de pagamento (ex: creditcard)
data.financial.partner_pay_subscription_idstring✅ID da assinatura do parceiro 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 do status da cobrança
data.financial.valuenumber✅Valor total da cobrança
data.financial.first_pay_day_datestring (ISO 8601)✅Data do primeiro vencimento da negociação

🔄 Resposta esperada​

{
"success": true
}