简介

本节将介绍相关 API，这些 API 用于实现由 QI CTVM 管理的投资基金的资产清算流程。需要特别说明的是，国债或债券等资产的清算流程不适用于此上下文。

如需访问这些服务，请联系团队 integracao.dtvm@qitech.com.br，以便在沙盒（Homologação）环境和生产环境中获得相应权限。

执行资产清算需要以下步骤：

创建付款批次；
插入待付款的资产；
关闭付款批次；

清算流程

下图展示了主路径、分支以及每个步骤产生的状态。将鼠标悬停在节点上可查看端点，点击可打开该步骤的文档。

集成方QI Tech

1创建付款批次

pending_settlements_insertion

集成方

所有将被一起处理的清算记录的容器，由唯一的 external_id 标识。

POST/settlement/fund_class/{fund_class_key}/payment_batch

每条清算记录一次请求，需提供资产类型、金额、清算方式和标识符。

POST.../payment_batch/{external_id}/settlement

丢弃误插入的清算记录。仅在批次尚未关闭时可执行。

PUT.../settlement/{settlement_external_id}

查看文档 →

3关闭批次

集成方

设置 batch_status。批次中至少需要插入一条清算记录。

PUT.../payment_batch/{external_id}

查看文档 →

批次已丢弃

discarded

集成方

不处理任何清算记录，也不产生任何资金变动。流程终止。

批次付款已确认

paid

QI Tech

QI Tech 确认付款。从该事件起，各条清算记录开始被处理。

每条清算记录都会在基金投资组合中完成对账，并通过 webhook 单独发送通知。

所有清算记录均已达到最终状态，批次周期结束。

查看文档 →

完整流程

如需了解每一次状态流转、webhook 载荷以及异常路径，请参阅资产清算流程。

创建批次

在此步骤中，需要生成一个付款批次密钥，该密钥将用于在清算过程中标识批次。此密钥将在创建批次时发送，之后即可进入下一步骤。

注意

每个批次在已注册的基金中必须拥有唯一密钥。

插入资产

在此步骤中，清算相关资产将逐一发送，并附带其待清算金额、资产类型、清算方式以及资产标识符等信息，格式详情请参见 5.4.3.1 资产。

关闭批次

最后，插入所有资产后，需要使用批次密钥关闭付款批次。此后，付款批次的清算处理将在内部启动，并最终通过 webhook 指示流程完成。

信息

现金对账和资产组合更新将由 API 自动完成。

清算流程​

创建批次

插入资产

关闭批次

清算流程