测试指南 - BaaS 数字账户 Escrow
测试指南描述了集成合作伙伴在进入生产环境之前,需要在 QI Tech 沙盒环境(测试环境)中测试的所有资源和功能。
本指南描述了该产品所涉及的所有资源和功能。
BaaS API 注册与认证
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| CAB0001* | 在沙盒环境注册 | 在 QI Tech 平台 Sandbox 环境(sandbox.qitech.app)完成注册 | cs@qitech.com.br | |
| CAB0002* | 在沙盒验证 token | 在 Sandbox 环境验证 QI Token | 文档链接 | CAB0001 |
| CAB0003* | 交换公钥 | 在 QI Tech 平台 Sandbox 环境(sandbox.qitech.app)完成公钥交换 | 文档链接 | CAB0001 e CAB0002 |
| CAB0004* | 完成 API 调用认证测试 | 完成 API 调用认证测试 | 文档链接 文档链接 | CAB0003 |
| CAB0005* | 配置 webhook | 通过 QI Tech 平台 Sandbox 环境(sandbox.qitech.app)配置 QI 发送 webhook 的 URL | 文档链接 | CAB0001 e CAB0002 |
反欺诈
注册与认证
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| ATF0002* | 获取 onboarding API 密钥 | 向 QI Tech 集成团队获取用于 /onboarding API 的 API 密钥 | suporte.caas@qitech.com.br | |
| ATF0003* | 获取 OCR 移动令牌 | 向 QI Tech 集成团队获取用于 OCR SDK 的移动令牌 | suporte.caas@qitech.com.br | |
| ATF0004* | 获取人脸识别移动令牌 | 向 QI Tech 集成团队获取用于人脸识别 SDK 的移动令牌 | suporte.caas@qitech.com.br | |
| ATF0005* | 获取设备扫描移动令牌 | 向 QI Tech 集成团队获取用于设备扫描 SDK 的移动令牌 | suporte.caas@qitech.com.br |
SDK OCR
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| ATF0007* | 构建 SDK | 定义文件采集的模板和自定义选项,并在您的应用中(QI Tech 客户应用)成功构建 SDK | Android: 文档链接 iOS: 文档链接 | |
| ATF0008* | 发送文件 | 在您的应用中(QI Tech 客户应用)使用 SDK 完成文件采集 | ATF0003 e ATF0007 | |
| ATF0009* | 存储 ocr_key | 存储 SDK 返回的密钥,识别采集文件的类型(例如:cnh_front、cnh_back 等) | Android: 文档链接 iOS: 文档链接 | ATF0008 |
SDK 人脸识别
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| ATF0011* | 构建 SDK | 定义自定义选 项并在您的应用中(QI Tech 客户应用)成功构建 SDK | Android: 文档链接 iOS: 文档链接 | |
| ATF0012* | 活体检测流程 | 在您的应用中(QI Tech 客户应用)使用 SDK 完成活体检测流程 | ATF0004 e ATF0011* | |
| ATF0013* | 存储图像密钥 | 完成活体检测流程后,存储 SDK 返回的 image_key | Android: 文档链接 iOS: 文档链接 | ATF0012 |
SDK 设备扫描
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| ATF0015* | 构建 SDK | 定义您的应用(QI Tech 客户应用)向用户请求的权限,并在您的应用中成功构建 SDK | Android: 文档链接 iOS: 文档链接 | |
| ATF0016* | 存储用户会话 | 存储待扫描设备的用户会话(sessionId) | Android: 文档链接 iOS: 文档链接 | ATF0015 e ATF0017 |
| ATF0017* | 采集信息 | 使用已存 储的 sessionId 实例化 SDK,并在您的应用中(QI Tech 客户应用)调用信息采集方法 | Android: 文档链接 iOS: 文档链接 | ATF0005 e ATF0015 |
反欺诈
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| ATF0019* | 个人客户反欺诈 | 成功完成个人客户的反欺诈流程 | 文档链接 | ATF0002 |
| ATF0020* | 企业客户反欺诈 | 成功完成企业客户的反欺诈流程 | 文档链接 | ATF0002 |
| ATF0021* | 读取异步流程中的分析派生 webhook | 成功接收异步响应流程中的分析派生 webhook | 文档链接 | ATF0019 ou ATF0020 |
平台注册
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| ATF0022* | 注册主用户 | 在 CaaS 平台注册主用户,用于处理转到"人工分析"的派生请求 | suporte.caas@qitech.com.br | ATF0019 ou ATF0020 |
QI Conta
开户
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| QIC0002* | 预留个人账户 | 申请预留持有人为自然人的账户 | 文档链接 | CAB0005 e CAB0006 |
| QIC0003* | 开设个人账户 | 完成持有人为自然人的账户开户 | 文档链接 | QIC0002 |
| QIC0004* | 预留企业账户 | 申请预留持有人为法人的账户 | 文档链接 | CAB0005 e CAB0006 |
| QIC0005* | 开设企业账户 | 完成持有人为法人的账户开户 | 文档链接 | QIC0004 |
| QIC0009* | 预留个人 escrow 账户 | 申请预留持有人为自然人的 escrow 账户 | 文档链接 | CAB0005 e CAB0006 |
| QIC0010* | 开设个人 escrow 账户 | 完成持有人为自然人的 escrow 账户开户 | 文档链接 | CAB0005 e CAB0006 |
| QIC0011* | 预留企业 escrow 账户 | 申请预留持有人为法人的 escrow 账户 | 文档链接 | CAB0005 e CAB0006 |
| QIC0012* | 开设企业 escrow 账户 | 完成持有人为法人的 escrow 账户开户 | 文档链接 | CAB0005 e CAB0006 |
| QIC0006* | 读取开户 webhook | 正确读取开户 webhook | 第 1.2. 或 1.3 条: 文档链接 | QIC0003 ou QIC0005 |
| QIC0007* | 列出账户 | 列出已开设账户 | 文档链接 | QIC0003 ou QIC0005 |
| QIC0008* | 查询账户数据 | 查询账户余额、持有人数据、开户日期等信息 | 文档链接 | QIC0003 ou QIC0005 |
交易
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| QIC0008* | 查询对账单 | 查询账户对账单 | 文档链接 | QIC0003 ou QIC0005 |
| QIC0009* | 申请转账凭证 | 申请转账凭证 | 文档链接 | |
| QIC0010* | 读取交易 webhook | 成功接收所有交易 webhook | 文档链接 | QIC0003 ou QIC0005 |
| QIC0011* | 查询金融机构列表 | 查询可接收 TED 和 Pix 的金融机构列表 | 文档链接 | QIC0003 ou QIC0005 |
文件上传
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| UDD0001* | 上传文件 | 通过文件 API 上传文件 | 文档链接 |
TED
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| TED0001* | TED 转出 | 进行 TED 转账 | 文档链接 | QIC0003 ou QIC0005 |
| TED0002* | 模拟 TED 转出退回 | 模拟从 QI 账户发出的 TED 转出退款 | 第 3 条: 文档链接 | TED0003 |
| TED0003* | 模拟 TED 转入 | 模拟 TED 转入到 QI 账户 | 第 2 条: 文档链接 | QIC0003 ou QIC0005 |
| TED0004* | 列出 TED 交易 | 列出 TED 入账/出账交易 | 文档链接 | QIC0003 ou QIC0005 |
| TED0004* | 查询 TED 交易 | 查询一笔 TED 交易 | 文档链接 | QIC0003 ou QIC0005 |
| TED0006* | 读取 TED webhook | 成功接收 TED webhook | 文档链接 | QIC0003 ou QIC0005 |
内部转账
| 编号 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| TFI0001 | 账户借记内部转账 | 从 QI 账户发起转账,目标为另一个 QI 账户 | 文档链接 | QIC0003 ou QIC0005 |
| TFI0002 | 模拟账户贷记内部转账 | 模拟目标 QI 账户从另一个 QI 账户收款 | 第 1 条: 文档链接 | QIC0003 ou QIC0005 |
票据
票据管理
| 编号 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| 编号 | 步骤 | 描述 | 链接 | 前置条件 |
| --- | --- | --- | --- | --- |
| BOL0001 | 登记单张标准收款票据 | 登记一张收款票据 | 文档链接 | CAB0002 ou CAB0003 |
| BOL0002 | 登记单张即时收款票据 | 登记一张收款票据 | 文档链接 | CAB0002 ou CAB0003 |
| BOL0003 | 批量登记收款票据 | 批量登记收款票据 | 文档链接 | CAB0002 ou CAB0003 |
| BOL0004 | 开具标准单张票据 | 开具标准单张票据 | 文档链接 | CAB0002 ou CAB0003 |
| BOL0005 | 开具即时单张票据 | 开具即时单张票据 | 文档链接 | CAB0002 ou CAB0003 |
| BOL0006 | 批量开具票据 | 批量开具票据 | 文档链接 | CAB0002 ou CAB0003 |
| BOL0007 | 对票据进行折扣减额 | 对票据进行折扣减额 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0008 | 取消票据折扣减额 | 取消票据折扣减额 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0009 | 延长票据到期日 | 延长票据到期日 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0010 | 添加票据折扣 | 添加票据折扣 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0011 | 添加票据利息 | 添加票据利息 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0012 | 添加票据罚金 | 添加票据罚金 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0013 | 核销票据 | 核销票据 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0014 | 通过密钥查询票据 | 通过密钥查询票据 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0015 | 列出票据 | 列出票据 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0016 | 查询收款钱包 | 查询收款钱包 | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
| BOL0017 | 票据 webhook | 读取票据 webhook | 文档链接 | BOL0001, BOL0002 ou BOL0003 |
票据支付
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| BOL0009* | 查询可打印条形码 | 查询银行票据的可打印条形码 | 文档链接 | |
| BOL0010* | 支付票据 | 支付银行票据 | 文档链接 | QIC0003 ou QIC0005 |
| BOL0012* | 查询协议票据条形码 | 查询协议票据的可打印条形码 | 文档链接 | |
| BOL0013* | 支付协议票据 | 支付协议票据 | 文档链接 | QIC0003 ou QIC0005 |
Pix
Pix 转账
| 代码 | 步骤 | 描述 | 文档链接 | 前置条件 |
|---|---|---|---|---|
| PIX0002* | Pix 转出 | 从 QI 账户使用银行信息(手动 Pix)或 Pix 密钥发起 Pix 转账 | 文档链接 | CAB0001 |
| PIX0035 | 查询 Pix 转账 | 获取一笔转账的数据 | 文档链接 | PIX0002 |
| PIX0003* | 模拟 Pix 转出退款 | 模拟 Pix 转出退款 | 文档链接 - 第 2 条 | PIX0002 |
| PIX0004* | 模拟 Pix 转入 | 模拟 Pix 转入到 QI 账户 | 文档链接 -> 第 1 条 | |
| PIX0037* | 读取待处理交易 webhook | 成功接收待处理交易 webhook | [文档链接][(/documentation/baas/pix/webhooks) | PIX0002 |
| PIX0038* | 读取 Pix 转入 webhook | 成功接收 Pix 转入 webhook | 文档链接 | PIX0004 |
| PIX0039 | 读取 Pix 退款 webhook | 成功接收 Pix 退款 webhook | 文档链接 | PIX0003 |
| PIX0040 | 申请退还已收 Pix | 申请退还已收 Pix | 文档链接 | PIX0003 |
| PIX0041 | 列出账户的 Pix 转账 | 列出账户的 Pix 转账 | 文档链接 | PIX0003 |
Pix 密钥管理
Pix 密钥的创建与删除
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| PIX0008* | 创建 Pix 密钥 | 创建 CPF、CNPJ、随机、邮件和电话类型的 Pix 密钥 | 文档链接 | |
| QIC0003 ou QIC0005 | ](/documentation/baas/pix/consultar_chave_pix) | |||
| PIX0009 | 删除 Pix 密钥 | 删除一个 Pix 密钥 | 文档链接 | PIX0008 |
| PIX0010* | 列出 QI 账户的 Pix 密钥 | 列出绑定到 QI 账户的 Pix 密钥 | 文档链接 | PIX0008 |
Pix 密钥可携带性
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| PIX0013* | 创建 Pix 密钥转入可携带性申请 | 创建 CPF、CNPJ、邮件、电话和随机类型 Pix 密钥的转入可携带性申请 | 文档链接 | QIC0003 ou QIC0005 |
| PIX0014* | 重新发送电话/邮箱类型 Pix 密钥转入可携带性申请的双因素认证 | 为处于待处理状态(pending_claimer_validation)的 Pix 密钥转入可携带性申请重新发送短信(电话类型 Pix 密钥)或邮件(邮件类型 Pix 密钥) | 文档链接 | PIX0013 |
| PIX0015* | 删除 Pix 密钥转入可携带性申请 | 删除待处理的 Pix 密钥转入可携带性申请 | 文档链接 | PIX0013 |
| PIX0016* | 读取 Pix 密钥转入可携带性申请完成 webhook | 正确读取 Pix 密钥转入可携带性申请完成 webhook,测试所有可能的完成状态(concluded、cancelled 和 failed) | Webhook: 文档链接 | PIX0013 |
| PIX0017* | 模拟 Pix 密钥转出可携带性申请 | 模拟 Pix 密钥转出可携带性申请的到达 | 第 5 条: 文档链接 | PIX0013 |
| PIX0018* | 批准和拒绝 Pix 密钥转出可携带性申请 | 批准 Pix 密钥转出可携带性申请 | 文档链接 | PIX0017 |
| PIX0019* | 重新发送 Pix 密钥转出可携带性申请的双因素认证 | 重新发送 Pix 密钥转出可携带性申请的双因素认证 | Enum "pending_donator_validation" 文档链接 | PIX0018 |
| PIX0020* | 读取 Pix 密钥转出可携带性申请完成 webhook | 正确读取 Pix 密钥转出可携带性申请完成 webhook,测试所有可能的完成状态(concluded、cancelled 和 failed) | 文档链接 | PIX0018 |
Pix QR 码管理
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| PIX0022* | 创建静态 Pix QR 码 | 生成静态 QR 码 | 文档链接 | PIX0008 |
| PIX0023 | 创建动态 Pix QR 码 | 生成带到期日的动态 QR 码及即时动态 QR 码(带过期秒数) | 文档链接 | PIX0008 |
| PIX0024 | 删除动态 Pix QR 码 | 删除 Pix QR 码 | 文档链接 | PIX0023 |
| PIX0025 | 列出动态 Pix QR 码 | 列出 动态 Pix QR 码 | 文档链接 | PIX0023 |
| PIX0026 | 读取即时动态 Pix QR 码过期 webhook | 成功接收即时动态 Pix QR 码过期 webhook | 文档链接 | PIX0023 |
Pix QR 码支付
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|
| PIX0029* | 支付静态 Pix QR 码 | 支付静态 Pix QR 码 | 文档链接 | PIX0022 | | PIX0030* | 支付动态 Pix QR 码 | 支付动态 Pix QR 码 | 文档链接 | PIX0022 | | PIX0027* | 解码 Pix QR 码 | 解码静态 Pix QR 码、带到期日动态 QR 码和即时动态 QR 码 | 文档链接 | PIX0022 e PIX0023 |
Pix 限额管理
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| PIX0032* | 申请修改 Pix 限额 | 为 QI 账户发起 Pix 限额修改申请 | 文档链接 | QIC0003 ou QIC0005 |
| PIX0033 | 列出 Pix 限额修改申请 | 列出 QI 账户的 Pix 限额修改申请 | 文档链接 | PIX0032 |
| PIX0034* | 查询已用 Pix 限额 | 查询 QI 账户已用 Pix 限额 | 文档链接 | QIC0003 ou QIC0005 |
费率管理
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| GTF0001* | 申请修改费率 | 修改账户费率 | 文档链接 | QIC0003 ou QIC0005 |
| GTF0002* | 查询费率 | 查询账户已注册的费率 | 文档链接 | QIC0003 ou QIC0005 |
卡片管理
创建卡片
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| GDC0001* | 创建虚拟卡 | 创建虚拟卡 | 文档链接 | QIC0003 ou QIC0005 |
| GDC0002* | 创建实体卡 | 创建实体卡 | 文档链接 | QIC0003 ou QIC0005 |
卡片查询
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| GDC0003* | 通过密钥查询卡片 | 查询卡片 | 文档链接 | GDC0001 ou GDC0002 |
| GDC0004* | 列出卡片 | 列出卡片 | 文档链接 | GDC0001 ou GDC0002 |
| GDC0005* | 查询卡片数据 | 查询卡片数据 | 文档链接 | GDC0001 ou GDC0002 |
| GDC0006* | 查询 PCI 密码 | 查询 PCI 密码 | 文档链接 | GDC0001 ou GDC0002 |
| GDC0007* | 查询配送数据 | 查询配送数据 | 文档链接 | GDC0001 ou GDC0002 |
更新卡片数据
| 代码 | 步骤 | 描述 | 链接 | 前置条件 |
|---|---|---|---|---|
| GDC0008* | 更新卡片状态 | 更新卡片状态 | 文档链接 | GDC0001 ou GDC0002 |
| GDC0009* | 激活实体卡 | 激活实体卡 | 文档链接 | GDC0001 ou GDC0002 |
| GDC0010* | 修改密码 | 修改卡片密码 | 文档链接 | GDC0001 ou GDC0002 |
| GDC0011* | 配置卡片非接触功能 | 配置卡片非接触功能 | 文档链接 | GDC0002 |