跳到主要内容

付款订单对账批次创建 Webhook

通过 Webhook 发送的通知对于处理 Pix 自动付款对账事件至关重要。此 Webhook 通知付款订单对账批次的创建。

对账批次创建 Webhook​

当新的付款订单对账批次被创建时，将发出此 Webhook。

注意！

QI Tech 的 Webhooks 不应以限制性方式映射。 我们 API 返回的 Webhook 载荷中可能会添加额外字段。

Webhook Request Body​

Request Body: 旅程 1
{
    "webhook_type": "baas.automatic_pix.payment_order_conciliation_batch.creation",
    "webhook_datetime": "2021-10-22T20:30:23.459Z",
    "data": {
        "payment_order_conciliation_batches": [
            {
                "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
                "payment_order_conciliation_batch_status": "open",
                "payment_order_conciliation_batch_type": "fixed_amount",
                "account_key": "uuid",
                "total_amount": 0,
                "conciliated_amount": 0,
                "total_payment_orders": 0,
                "conciliated_payment_orders": 0,
                "reference_date": "2025-06-13",
                "created_at": "2025-06-10T20:30:23.459Z"
            },
            {
                "payment_order_conciliation_batch_key": "99fc62fd-b0a0-4604-9bea-475e91a9dc82",
                "payment_order_conciliation_batch_status": "open",
                "payment_order_conciliation_batch_type": "variable_amount",
                "account_key": "uuid",
                "total_amount": 0,
                "conciliated_amount": 0,
                "total_payment_orders": 0,
                "conciliated_payment_orders": 0,
                "reference_date": "2025-06-13",
                "created_at": "2025-06-10T20:30:23.459Z"
            }
        ]
    }
}

Webhook Body Params​

字段类型描述字符数
webhook_type *stringWebhook 事件类型（baas.automatic_pix.payment_order_conciliation_batch.creation）。100
webhook_datetime *stringWebhook 生成的日期和时间（ISO 8601 格式）。-
data *Object包含对账批次详情的对象。Objeto data

Objeto data​

字段类型描述字符数
payment_order_conciliation_batches *array已创建的对账批次列表。Array payment_order_conciliation_batches

Array payment_order_conciliation_batches​

字段类型描述字符数
payment_order_conciliation_batch_keystring对账批次的唯一键。36
payment_order_conciliation_batch_statusstring对账批次状态（open）。-
payment_order_conciliation_batch_typestring对账批次类型（fixed_amount、variable_amount）。-
account_keyuuidv4与批次关联的账户标识键。36
total_amountnumber对账批次的总金额。-
conciliated_amountnumber批次中已对账的总金额。-
total_payment_ordersnumber批次中付款订单的总数。-
conciliated_payment_ordersnumber批次中已对账的付款订单数量。-
reference_datestring批次参考日期（YYYY-MM-DD 格式）。10
created_atstring批次创建日期（ISO 8601 格式）。-