分期 Webhook

提示

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

注意！

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

Webhook 重发

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

当 QI Tech 为操作的收款代理时，可启用此配置，启用后您将收到操作分期的状态变更通知。

可配置的状态有：

• opened（待处理）
• paid（已支付）
• waiting_payment（等待支付）
• paid_early（已提前支付）
• paid_partial（部分支付）
• overdue（已逾期）
• paid_partial_overdue（逾期后部分支付）
• paid_overdue（逾期后已支付）

---

分期支付 Webhook 示例

Body.json

{
    "key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0",
    "data": {
        "status": "paid",
        "installment": {
            "events": [{
                "amount": 1009.68,
                "created_at": "2022-09-27T07:03:35",
                "event_date": "2022-09-27T07:03:34",
                "old_due_date": null,
                "installment_event_type": {
                    "enumerator": "payment",
                    "translation_path": "co.InstallmentEventType.payment"
                },
                "installment_old_status": {
                    "enumerator": "opened",
                    "translation_path": "co.InstallmentStatus.opened"
                }
            }],
            "paid_at": "2022-09-27T07:03:34",
            "due_date": "2022-10-28",
            "installment_key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0",
            "installment_status": {
                "enumerator": "paid",
                "translation_path": "co.InstallmentStatus.paid"
            },
            "installment_payment": [{
                "installment_payment_key": "f03e1fbc-6d7a-456b-bd6a-db0faac1b481",
                "paid_at": "2026-02-10T11:39:07",
                "paid_amount": 1009.68,
                "paid_method_type": {
                    "enumerator": "pix",
                    "translation_path": "co.PaymentType.pix"
                }
            }]
        },
        "is_finished": true
    },
    "webhook_type": "installment.status_change"
}

为分期支付创建银行划款的 Webhook 示例

Body.json

{
    "key": "96015228-4905-42fc-bda6-e70e0e552b6b",
    "webhook_type": "installment.status_change",
    "data": {
        "status": "update",
        "installments": [
            {
                "installment_key": "bc60ad8e-4dc1-4edc-8c5b-6df1b5c9415d",
                "digitable_line": "32990001455000000000503007797909797660000100000",
                "qr_code_key": "7d20015e-c4ed-4290-b255-33c1c5b56362",
                "qr_code_url": "00020126580014br.gov.bcb.pix0136dc4a27db-2fe1-474d-aa02-88d6fffb8d0d5204000053039865802BR5921NeymarSportEMarketing6008saopaulo62070503***63040EB2",
                "principal_amortization_amount": 141.07452576,
                "pre_fixed_amount": 72.89547424,
                "bank_slip_key": "5f25e9fd-f612-47a3-acff-be9f29d87f6c",
                "due_date": "2024-07-17",
                "total_amount": 216.97
            }
        ]
    }
}

字段定义

Request Body 对象

字段	类型	描述	最大字符
key *	object	信贷操作的 DEBT-KEY	-
data *	object	webhook 数据	-
webhook_type *	object	发送的 webhook 类型	-

data 对象

字段	类型	描述	最大字符
status *	object	分期状态	-
installment *	object	分期数据	-
is_finished *	boolean	布尔字段，表示分期是否还有新状态或已完成	-