清算 Webhooks

注意！

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

Webhook 重发

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

简介

在我们的系统中，清算组是协调交易与已清算票据的一种方式。该流程（清算）描述了将已支付票据的金额转移至应收款账户的过程。简而言之，每当 QI 收到票据已被其他银行支付（或对于已抗议的票据，由公证处支付）的信息时，就会为该特定票据创建一条清算记录。随后，会创建清算组，这些清算组代表按类型分组的清算批次。

此后，会为该清算组执行向客户账户的付款交易。该交易的 transaction_key 随后将保存用于对账，通过此方式您可以查看在某次特定交易中已清算的所有票据。例如，若您有五张各 R$ 5.00 的票据，其中一张通过公证处支付，一张通过 QR Code PIX 支付，另外三张由其他银行通过可输入行或条形码支付，则会为这些票据创建五条清算记录。随后，这些清算记录将被分为三个清算组：一个 R$ 15.00 的清算组包含三张通过可输入行或条形码支付的票据（对其执行一笔交易）；一个 R$ 5.00 的清算组包含通过 QR Code PIX 支付的票据；最后一个 R$ 5.00 的清算组包含通过公证处支付的票据。

信息

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

示例

---

清算组

Webhook Body

{
    "webhook_type": "baas.bank_slip.bank_slip_settlement_group",
    "webhook_datetime": "2024-08-13T21:35:55.679Z",
    "data": {
        "bank_slip_settlement_group_key": "87e6687b-d02b-45dc-b5b8-b51e16ec0a03",
        "amount": 1,
        "bank_slip_settlement_group_type": "siloc",
        "bank_slip_settlement_group_status": "settled",
        "transaction_key": "fc60a57e-c6ac-4e39-a3cf-2dc3c491dac6"
    }
}

Enumeradores bank_slip_settlement_group_type

枚举值	描述
siloc	用于票据支付（票据金额小于 R$ 250.000）
qr_code	用于通过 QR Code 支付的票据
str	用于大额票据支付（票据金额大于 R$ 250.000）
notary_office	用于通过公证处支付的票据

Enumeradores bank_slip_settlement_group_status

枚举值	描述
pending	清算组已创建，但交易尚未执行
settled	清算组已创建，且交易已执行