Webhooks - Renegociação em Lote BNPL

Resumo

Após a criação de uma proposta de renegociação em lote, o sistema enviará webhooks para notificar sobre o pagamento ou rejeição da proposta.

Atenção!

Os webhooks não devem ser mapeados de forma estrita. Novos campos podem ser adicionados ao payload sem aviso prévio.

Webhook de Pagamento

Este webhook é enviado quando o pagamento da proposta de renegociação em lote é confirmado.

WEBHOOK_TYPE

renegotiation.batch_proposal

STATUS

paid

Webhook Body

{
    "webhook_type": "renegotiation.batch_proposal",
    "key": "<BATCH-PROPOSAL-KEY>",
    "event_datetime": "<DATA E HORA DO ENVIO DO WEBHOOK>",
    "status": "paid",
    "data": {
        "paid_method_type": "<METODO DE PAGAMENTO>",
        "paid_in": {
            "code_number": "<CODIGO DO BANCO LIQUIDANTE>",
            "ispb": "<ISPB DO BANCO LIQUIDANTE>",
            "name": "<NOME DO BANCO LIQUIDANTE>"
        }
    }
}

Campos do Webhook de Pagamento

Campo	Tipo	Descrição
webhook_type	string	Tipo do webhook: renegotiation.batch_proposal
key	string	Chave da proposta de renegociação em lote (BATCH-PROPOSAL-KEY)
event_datetime	string	Data e hora do envio do webhook
status	string	Status do evento: paid
data.paid_method_type	string	Método de pagamento utilizado
data.paid_in.code_number	string	Código do banco liquidante
data.paid_in.ispb	string	ISPB do banco liquidante
data.paid_in.name	string	Nome do banco liquidante

Enumeradores paid_method_type

Enumerador	Descrição
bank_slip	Pagamento realizado por boleto
pix	Pagamento realizado por Pix

---

Webhook de Rejeição

Uma renegociação em lote pode ser rejeitada pelo decurso de prazo do pagamento ou por um pagamento de parcela por fora da renegociação.

WEBHOOK_TYPE

renegotiation.batch_proposal

STATUS

rejected

Webhook Body

{
    "webhook_type": "renegotiation.batch_proposal",
    "key": "<BATCH-PROPOSAL-KEY>",
    "event_datetime": "<DATA E HORA DO ENVIO DO WEBHOOK>",
    "status": "rejected",
    "data": {}
}

Atenção

Uma renegociação em lote pode ser rejeitada por:

• Decurso de prazo: o pagamento não foi realizado dentro da data de vencimento (proposal_due_date)
• Pagamento externo: uma parcela incluída na renegociação foi paga por fora antes da confirmação do pagamento do lote

---

Dados de Pagamento na Parcela

Quando uma parcela é paga através de uma renegociação em lote, os dados de pagamento são registrados na parcela:

Payment Data

{
    "batch_renegotiation_proposal_key": "f9addba2-ec91-41bf-a150-c59eb1c3fbef",
    "paid_in": {
        "ispb": "18236120",
        "name": "NU PAGAMENTOS - IP",
        "code_number": 260
    },
    "resource_account_key": "ea44b9f2-ad00-4896-b8a3-b1a3da28a72f"
}

Campos dos Dados de Pagamento

Campo	Tipo	Descrição
batch_renegotiation_proposal_key	string	Chave da proposta de renegociação em lote que originou o pagamento
paid_in.ispb	string	ISPB do banco utilizado para o pagamento
paid_in.name	string	Nome do banco utilizado para o pagamento
paid_in.code_number	integer	Código do banco utilizado para o pagamento
resource_account_key	string	Chave da conta de recursos que recebeu o pagamento