Pular para o conteúdo principal

Webhooks de dívida

Informação

O timeout para resposta de nosso webhooks é de 5 segundos.

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Webhook de assinatura finalizada

Response Body
{
"key": "ebe12ca1-ec34-4674-bd62-24c0bc204e81",
"status": "signature_finished",
"webhook_type": "debt",
"event_datetime": "2024-09-02 18:39:49",
"signed_contract_url": "https://storage.googleapis.com/live-doc-api/documents/6099edd7-1c83-4890-998e-ce60e218523cb/S_signed.pdf"
}

Webhook de desembolso.

Response Body
{
"key": "bb81d525s-aa4b-4ddf-81d6-aa4b41fd04nb",
"data": {
"installments": [
{
"due_date": "2025-11-24",
"total_amount": 8304.16,
"installment_key": "7ec2f4d-b21e-4bd5-ahs6-60e998267249",
"pre_fixed_amount": 2475.77421509,
"installment_number": 1,
"principal_amortization_amount": 5828.23857532
},
{
"due_date": "2025-12-22",
"total_amount": 8304.16,
"installment_key": "54g37d78-a9a9-bf82-9f8e-fd3ba123797a",
"pre_fixed_amount": 2001.06342502,
"installment_number": 2,
"principal_amortization_amount": 6303.43346322
}
],
"ted_receipt_list": [
{
"fee": 0,
"url": "https://storage.storage.com/sandbox-doc-api/documents/f9as9329-22bd-4dbg-91a2-f2sdgeth4h04/fheth459-bhrf-4hrt-9hra-fdsfsgehth42.pdf",
"amount": 123456.0,
"origin": {
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"type": "payment_account",
"branch": "0001",
"document": "32402502000777",
"bank_code": "329",
"account_key": "5d068423-7774-49e4-b15b-7741238df5a8",
"branch_digit": null,
"account_digit": "5",
"account_branch": "0001",
"account_number": "00002",
"financial_institution_name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A."
},
"timestamp": "2025-10-26T17:00:51",
"description": "60701190 8615 22110-2 96969879003 - Alan Mathison Turing",
"destination": {
"name": "Alan Mathison Turing",
"type": "checking_account",
"branch": "8612",
"purpose": "Crédito PIX em Conta",
"document": "96972379003",
"bank_ispb": "60111190",
"branch_digit": null,
"account_digit": "2",
"account_number": "44110",
"financial_institution_name": "BANCO S.A."
},
"end_to_end_id": "E32402402200510221300gNgeefVNtVr",
"transaction_key": "25044504-1902-412a-a445-23b813bee6c1",
"origin_transaction_key": "542224ea-b5ea-49ff-b7b7-673b81af387b"
}
],
"requester_identifier_key": null
},
"status": "disbursed",
"webhook_type": "debt",
"event_datetime": "2025-10-26 17:00:52"
}
Importante

Quando os boletos de uma dívida são gerados, é enviado outro webhook: Webhook de parcelas

Webhook de cancelamento.

Response Body
{
"webhook_type": "debt",
"key":"27a099df-4688-43cb-87fa-515b1cf343a5",
"event_datetime": "2022-09-27 07:03:49",
"data": {
"cancel_reason": "Operacao cancelada manualmente",
"cancel_reason_enumerator": "manual"
},
"status":"canceled "
}

Webhook de contrato quitado:

Response Body
{
"key": "27a099df-4688-43cb-87fa-515b1cf343a5",
"data": {
"settlement_amount": 3429.38
},
"status": "settled",
"webhook_type": "debt",
"event_datetime": "2022-09-27 07:03:49"
}

Motivos de cancelamento

cancel_reason_enumeratorDescrição
disbursing_errorOperação cancelada por erro no momento do desembolso.
waiting_signatureOperação cancelada por falta de assinatura.
is_portabilityA operação foi cancelada pois é uma portabilidade que não foi concluída.
not_collateral_constitutedA operação foi cancelada pois as garantias não foram constituídas.
entry_not_paidA operação foi cancelada pois a entrada não foi paga.
not_assignedOperação foi cancelada porque o processo de cessão não foi realizado.
pix_max_retryOperação cancelada pois o banco recebedor não conseguiu receber o desembolso.
lack_of_resourceOperação cancelada por falta de recurso.
manualOperação cancelada manualmente.
kyc_not_acceptedOperação cancelada pois não foi aprovada no compliance.
not_collateral_fgtsOperação cancelada por erro com FTGS.
agencia_conta_invalidaAgência ou Conta Destinatária do Crédito Inválida.
not_assignedOperação foi cancelada porque o processo de cessão não foi realizado.
invalid_accountNúmero da conta de destino é inexistente ou inválido.
invalid_document_numberCPF/CNPJ da conta de destino está incorreto.
unsupported_transactionA conta de destino não suporta este tipo de transação.
bank_slip_paymentOperação cancelada por erro no pagamento do boleto.
bank_slip_paidOperação cancelada pois o boleto já está pago.
bank_slip_written_offOperação cancelada pois o boleto já está baixado.
invalid_ispbNúmero ISPB é inválido ou inexistente.
rejected_paymentOrdem de pagamento foi rejeitada pelo banco recebedor.
disbursed_amount_refundedOperação cancelada devido a devolução do valor de desembolso