跳到主要内容

商业票据书写 + Boleto + 核销系统集成路线图

同质化路线图描述了集成合作伙伴在进入生产环境发行商业票据、boleto 及执行核销之前，需要在 QI Tech 沙盒环境（测试环境）中测试的所有功能和特性。

本路线图描述了产品所涉及的所有资源和功能。

注意

所有测试必须强制在 QI Tech 沙盒环境（测试环境）中进行。 在沙盒环境中执行的操作均为虚拟金融操作，仅用于 API 功能测试。

书写 API 注册与认证​

代码步骤描述文档链接前提条件
CAB0001*公钥交换与平台运营团队（suporte.dcm@qitech.com.br）进行公钥交换文档链接
CAB0002*调用认证测试从平台团队获取 API 密钥后，完成调用认证测试文档链接

文档链接		CAB0001
CAB0003*Webhooks 配置配置 QI 发送 webhooks 的 URL。文档链接

文档链接

文档链接		CAB0001 和 CAB0002

通过书写系统完成登记的发行人同质化​

代码步骤描述文档链接前提条件
CED0001*发行人基础登记创建发行人，填写基础登记信息。文档链接
CED0002*发行人文件的提交与删除提交和删除与已登记发行人关联的文件文档链接

文档链接		CED0001
CED0003*发行人代表的登记与删除提交和删除与已登记发行人关联的代表文档链接

文档链接		CED0001
CED0004*发行人代表文件的提交与删除提交和删除与已登记发行人的代表关联的文件文档链接

文档链接		CED0001、CED0003
CED0005*发行人银行账户的登记与删除登记和删除与已登记发行人关联的银行账户文档链接

文档链接		CED0001
CED0006*发行人签署人组的登记与删除登记和删除与已登记发行人关联的签署人组文档链接

文档链接		CED0001
CED0007*发行人联系信息的登记与删除登记和删除与已登记发行人关联的联系信息文档链接

文档链接		CED0001
CED0008*提交发行人进行分析本端点用于将发行人状态变更为分析中，送入校验流程。文档链接CED0001、CED0002、CED0003、CED0004、CED0005、CED0006、CED0007
CED0009*变更发行人登记变更发行人以允许编辑文档链接CED0001、CED0002、CED0003、CED0004、CED0005、CED0006、CED0007
CED0010*列出已登记的发行人列出已登记的出让人，可按 CNPJ、名称筛选文档链接
CED0011*发行人详情通过 issuer_key 查看某个已登记发行人的详细信息文档链接

投资人同质化​

注意

对于投资人同质化流程，投资人的登记将由书写团队在初始配置时完成，并将键值提供给相关团队。

在初始配置阶段完成登记的投资人同质化​

代码步骤描述文档链接前提条件
INV1001*列出已登记的投资人列出已登记的基金，可按 CNPJ、名称筛选文档链接
INV1002*投资人详情通过 investor_key 查看某个已登记投资人的详细信息文档链接

商业票据发行​

完成发行人和投资人的登记后，即可发行商业票据。为此存在若干发行流程组合，具体如下。

代码步骤描述文档链接前提条件
COM0001*财务条件模拟模拟一笔操作的财务条件与还款流文档链接
COM0002*商业票据操作登记根据财务数据和投资人数据创建一笔新的商业票据操作。文档链接COM0001
COM0003关联方的登记与删除登记和删除与某笔操作关联的关联方文档链接COM0002
COM0004关联方代表文件的提交与删除提交和删除与某笔操作关联方代表相关的文件文档链接COM0002、COM0003
COM0005关联方代表签署人组的提交与删除提交和删除与某笔操作关联方代表相关的签署人组文档链接COM0002、COM0003
COM0006预览设立条款依据预定义模板为某笔具体操作生成设立条款草稿。文档链接COM0002
COM0007*变更设立条款模板变更某笔具体操作所使用的设立条款模板文档链接COM0002
COM0008*提交操作进行分析将操作状态变更为"分析中"，送入书写机构的合规校验流程文档链接COM0002、COM0003、COM0004、COM0005、COM0006、COM0007
COM0009*提交已签署的批准会议纪要本端点用于将 SA 或 COP 类型公司在外部签署的批准会议纪要提交至书写系统，提交的 base64 内容将由书写机构分析并批准。文档链接COM0002
COM0010*按筛选条件查询操作使用可选筛选条件查询商业票据操作文档链接COM0002、COM0003、COM0004、COM0005、COM0006、COM0007、COM0008、COM0009
COM0011*按键值查询操作使用唯一键值查询某笔具体操作的完整详情。文档链接COM0002、COM0003、COM0004、COM0005、COM0006、COM0007、COM0008、COM0009

若通过 QI SIGN 签署​

代码步骤描述文档链接前提条件
COM0012*查询操作在 QI SIGN 中的签署链接使用唯一键值，查询某笔具体操作在 QI SIGN 中的全部签署链接。文档链接COM0002、COM0003、COM0004、COM0005、COM0006、COM0007、COM0008、COM0009
COM0013*查询操作在 QI SIGN 中已签署合同的链接使用唯一键值，查询某笔具体操作在 QI SIGN 中的全部已签署文件文档链接COM0002、COM0003、COM0004、COM0005、COM0006、COM0007、COM0008、COM0009

实缴/认购流程​

代码步骤描述文档链接前提条件
INT0001*按键值查询实缴使用唯一键值查询某个实缴流程的详情文档链接

错误映射​

来自发行人、投资人和商业票据 API 的错误，可在错误目录链接中查阅

Boleto 发行

BaaS API 注册与认证​

代码步骤描述文档链接前提条件
CAB0001*在沙盒环境中注册在 QI Tech 平台的沙盒环境（sandbox.qitech.app）中完成注册cs@qitech.com.br
CAB0002*在沙盒中验证 token在沙盒中完成 QI Token 的验证下载 Token 接入手册CAB0001
CAB0003*公钥交换在 QI Tech 平台的沙盒环境（sandbox.qitech.app）中完成公钥交换文档链接CAB0001 和 CAB0002
CAB0004*调用认证测试完成调用认证测试分步指引

文档链接		CAB0003
CAB0005*Webhooks 配置通过 QI Tech 平台的沙盒环境（sandbox.qitech.app）配置 QI 发送 webhooks 的 URL文档链接CAB0001 和 CAB0002

QI Conta​

代码步骤描述文档链接前提条件
QIC0001*查询账户数据查询余额、持有人数据、开户日期等信息文档链接CAB0003

账户变动​

代码步骤描述链接前提条件
QIC0008*对账单查询查询某个账户的对账单文档链接CAB0003
QIC0009*申请转账回单申请一份转账回单文档链接CAB0003
QIC0010*读取交易 webhooks成功接收所有交易 webhooks文档链接CAB0003
QIC0011*查询金融机构清单查询可接收 TED 与 Pix 的金融机构清单文档链接CAB0003

Boleto​

Pix 密钥管理​

Pix 密钥的创建与删除​

代码步骤描述链接前提条件
PIX0001*创建 Pix 密钥创建 cpf、cnpj、随机、电子邮件和电话类型的 Pix 密钥文档链接
PIX0010*列出某个 QI Conta 的 Pix 密钥列出绑定到某个 QI Conta 的 Pix 密钥文档链接PIX0001

钱包管理​

代码步骤描述链接前提条件
CRT0001*创建钱包创建钱包，用于付款、核销、抗议等特定配置。文档链接
CRT0002*编辑钱包编辑默认配置。文档链接CRT0002

Boleto 管理​

编号步骤描述链接前提条件
BOL0001登记单笔托收 boleto（标准）登记一笔托收 boleto文档链接CAB0002 或 CAB0003
BOL0002登记单笔托收 boleto（即时）登记一笔托收 boleto文档链接CAB0002 或 CAB0003
BOL0003批量登记 boleto批量登记托收 boleto文档链接CAB0002 或 CAB0003
BOL0004对 boleto 金额进行减免对 boleto 金额进行减免文档链接BOL0001、BOL0002 或 BOL0003
BOL0005取消减免取消某笔 boleto 上的减免文档链接BOL0001、BOL0002 或 BOL0003
BOL0006延长 boleto 到期日为某笔 boleto 提交展期文档链接BOL0001、BOL0002 或 BOL0003
BOL0007为 boleto 添加折扣为某笔 boleto 添加折扣文档链接BOL0001、BOL0002 或 BOL0003
BOL0008为 boleto 添加利息为某笔 boleto 添加利息文档链接BOL0001、BOL0002 或 BOL0003
BOL0009为 boleto 添加罚金为某笔 boleto 添加罚金文档链接BOL0001、BOL0002 或 BOL0003
BOL0010核销 boleto核销一笔 boleto文档链接BOL0001、BOL0002 或 BOL0003
BOL0011按键值查询 boleto按键值查询 boleto文档链接BOL0001、BOL0002 或 BOL0003
BOL0012列出 boleto列出 boleto文档链接BOL0001、BOL0002 或 BOL0003
BOL0013查询托收钱包查询某个托收钱包文档链接BOL0001、BOL0002 或 BOL0003
BOL0014Boleto Webhooks读取 boleto 相关的 webhook文档链接BOL0001、BOL0002 或 BOL0003

抗议（Protesto）​

编号步骤描述链接前提条件
BOL0015提出抗议申请对某笔 boleto 提出抗议申请文档链接CAB0002 或 CAB0003
BOL0016撤回抗议申请（中止）撤回抗议申请，同时保留该 boleto 的登记文档链接BOL0015
BOL0017撤回抗议申请并核销 boleto撤回抗议申请，同时核销该 boleto文档链接BOL0015
BOL0018移除抗议（撤销）撤销一项已确认（公证处已受理）的抗议文档链接BOL0015
BOL0019列出抗议列出某个账户钱包中的抗议文档链接BOL0015
BOL0020按键值查询抗议查询某笔 boleto 的抗议信息文档链接BOL0015
BOL0021查询抗议凭证查询抗议凭证（由公证处出具的正式文件）文档链接BOL0015

Boleto 对账​

编号步骤描述链接前提条件
CON0001列出清算组列出已清算 boleto 的清算组文档链接BOL0001、BOL0002 或 BOL0003
CON0002列出清算记录列出各清算组中的 boleto文档链接BOL0001、BOL0002 或 BOL0003
CON0003Boleto Webhooks读取 boleto 相关的 webhook文档链接BOL0001、BOL0002 或 BOL0003

QI DTVM 集成 - 分期核销​

编号步骤描述链接前提条件
BAX0001创建付款批次创建分期的付款批次文档链接
BAX0002插入清算记录对分期进行清算文档链接BAX0001