跳到主要内容

债务 Webhook

提示

我们 webhook 的响应超时时间为 5 秒。

注意！

QI Tech 的 webhooks 不应以严格方式进行映射。 API 返回的 webhook payload 中可能会添加额外字段。

Webhook 重发

您可以按照文档中的详细说明查询并重发 webhooks：Webhook 重发。

签署完成 Webhook​

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​

Response Body
{
    "key": "bb81d525s-aa4b-4ddf-81d6-aa4b41fd04nb",
    "data": {
        "installments": [...],
        "ted_receipt_list": [...],
        "requester_identifier_key": null
    },
    "status": "disbursed",
    "webhook_type": "debt",
    "event_datetime": "2025-10-26 17:00:52"
}
重要

当债务的银行划款生成后，会发送另一个 webhook：分期 Webhook

取消 Webhook​

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​

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"
}

取消原因​

cancel_reason_enumerator描述
disbursing_error发放时发生错误，操作被取消
waiting_signature因缺少签名，操作被取消
is_portability操作被取消，因为这是一个未完成的可携性操作
not_collateral_constituted操作被取消，因为担保未构成
entry_not_paid操作被取消，因为首付款未支付
not_assigned操作被取消，因为转让流程未完成
pix_max_retry操作被取消，因为接收银行无法收到发放款项
lack_of_resource操作因资源不足被取消
manual操作被手动取消
kyc_not_accepted操作被取消，因为未通过合规审查
not_collateral_fgts操作因 FGTS 错误被取消
agencia_conta_invalida收款银行支行或账户无效
invalid_account目标账号不存在或无效
invalid_document_number目标账户的 CPF/CNPJ 不正确
unsupported_transaction目标账户不支持此类交易
bank_slip_payment因划款支付错误，操作被取消
bank_slip_paid操作被取消，因为划款已支付
bank_slip_written_off操作被取消，因为划款已核销
invalid_ispbISPB 号码无效或不存在
rejected_payment支付指令被接收银行拒绝
disbursed_amount_refunded操作因发放金额退回而被取消