简介
欢迎使用 QI Tech Banking API!此 API 为银行和数字账户操作提供欺诈预防功能,例如转账分析、账单支付和 Boleto 支付。
以下,您可以看到使用 cUrl 的 API 实现。这样,您就有了示例,可以根据自己喜欢的编程语言进行适当调整。
遇到问题?
我们不是躲在 API 后面的公司!请联系我们的支持团队,我们将尽快回复。如果您需要快速回复,请随时致电我们!
我们热爱反馈
即使您已经解决了问题,或者问题非常简单(甚至是您发现的一个错别字或不当的组织方式),也请给我们发电子邮件,这样我们可以让文档变得越来越实用,下一个人就不必经历您所经历的痛苦!
环境
我们为客户提供两个环境。API 的基本 URL 为:
- 生产环境 -
https://api.caas.qitech.app/ - 沙盒环境 -
https://api.sandbox.caas.qitech.app/
不得在 QI Tech 沙盒环境中使用真实的个人和/或法人数据。
沙盒环境中的分析
在沙盒环境中,分析不计费,并根据简化的规则进行响应。 对于 wire_transfers、bankslips、bill_payments 和 pix 的情况,返回的响应将基于请求中发送的操作金额(amount):
| 最小值 | 最大值 | 决策 |
|---|---|---|
| 16000 | - | 自动挑战* |
| 10000 | 15999 | 自动批准 |
| 6000 | 9999 | 转人工分析 |
| 0 | 5999 | 自动拒绝 |
* 自动挑战仅适用于 pix 服务。
对于 withdrawal 和 deposit 的情况,返回的响应将基于请求中发送的操作金额(amount):
| 最小值 | 最大值 | 决策 |
|---|---|---|
| 10000 | - | 自动批准 |
| 0 | 9999 | 自动拒绝 |
对于 DICT 操作,返回的响应将基于请求中发送的 DICT 绑定密钥(dict_key):
| DICT 中的密钥 | 决策 |
|---|---|
| "Approve_dict_key" | 自动批准 |
| 任何其他字符串 | 转人工分析 |
| "Reprove_dict_key" | 自动拒绝 |
仅限 HTTPS
出于安全原因,与 QI Tech API 的所有通信必须使用 HTTPS 协议。为避免因疏忽或其他原因发出 HTTP 调用,此服务器仅提供使用 TLS 1.2 通信的 443 端口。使用其他协议发出的调用将自动被拒绝。
流程 - 转账
转账分析流程在两种情况下启动:
- PSP 用户正在执行转账
- PSP 用户正在接收转账
在这两种情况下,都必须调用 wire_transfer 端点,可能的结果状态为:
| 枚举值 | 描述 |
|---|---|
| automatically_approved | 自动批准 |
| automatically_reproved | 自动拒绝 |
| in_manual_analysis | 转人工分析 |
| pending | 银行转账对象正在处理中。 |
如果转账转为人工分析,分析师须批准或拒绝该转账。此时,可以生成 Webhook 向 PSP 通知状态变化,或 PSP 可通过 Polling 跟踪转账进度。在这两种情况下,可以返回以下状态:
| 枚举值 | 描述 |
|---|---|
| manually_approved | 人工批准 |
| manually_reproved | 人工拒绝 |
流程 - Boletos
Boleto 分析流程在两种情况下启动:
- PSP 用户正在执行 Boleto 支付
- PSP 用户正在接收 Boleto 支付
在这两种情况下,都必须调用 bankslip 端点,可能的结果状态为:
| 枚举值 | 描述 |
|---|---|
| automatically_approved | 自动批准 |
| automatically_reproved | 自动拒绝 |
| in_manual_analysis | 转人工分析 |
| pending | Boleto 对象正在处理中。 |
如果 Boleto 支付转为人工分析,分析师须批准或拒绝该支付。此时,可以生成 Webhook 向 PSP 通知状态变化,或 PSP 可通过 Polling 跟踪支付进度。在这两种情况下,可以返回以下状态:
| 枚举值 | 描述 |
|---|---|
| manually_approved | 人工批准 |
| manually_reproved | 人工拒绝 |
流程 - 账单支付
账单支付分析流程在以下情况下启动:
- PSP 用户正在执行账单支付
在这种情况下,必须调用 bill_payment 端点,可能的结果状态为:
| 枚举值 | 描述 |
|---|---|
| automatically_approved | 自动批准 |
| automatically_reproved | 自动拒绝 |
| in_manual_analysis | 转人工分析 |
| pending | 账单支付对象正在处理中。 |
如果账单支付转为人工分析,分析师须批准或拒绝该支付。此时,可以生成 Webhook 向 PSP 通知状态变化,或 PSP 可通过 Polling 跟踪支付进度。在这两种情况下,可以返回以下状态:
| 枚举值 | 描述 |
|---|---|
| manually_approved | 人工批准 |
| manually_reproved | 人工拒绝 |
流程 - 取款
取款分析流程在以下情况下启动:
- PSP 用户正在执行取款
在这两种情况下,都必须调用 withdrawal 端点,可能的结果状态为:
| 枚举值 | 描述 |
|---|---|
| automatically_approved | 自动批准 |
| automatically_reproved | 自动拒绝 |
如果取款转为人工分析,分析师须批准或拒绝该取款。此时,可以生成 Webhook 向 PSP 通知状态变化,或 PSP 可通过 Polling 跟踪支付进度。在这两种情况下,可以返回以下状态:
| 枚举值 | 描述 |
|---|---|
| manually_approved | 人工批准 |
| manually_reproved | 人工拒绝 |
流程 - PIX 交易
PIX 支付流程在两种情况下启动:
- 集成到 QI Tech 的 PSP 用户正在执行支付
- 从另一个 PSP 接收支付
在这两种情况下,都必须调用支付端点,可能的结果状态为:
| 枚举值 | 描述 |
|---|---|
| automatically_approved | 自动批准 |
| automatically_reproved | 自动拒绝 |
| in_manual_analysis | 转人工分析 |
如果支付转为人工分析,分析师须批准或拒绝该支付。此时,可以生成 Webhook 向 PSP 通知状态变化,或 PSP 可通过 Polling 跟踪支付进度。在这两种情况下,可以返回以下状态:
| 枚举值 | 描述 |
|---|---|
| manually_approved | 人工批准 |
| manually_reproved | 人工拒绝 |
流程 - DICT 变更
DICT 变更流程在两种情况下启动:
- 集成到 QI Tech 的 PSP 用户向集成到 QI Tech 的 PSP 请求注册/变更/可携带性/申领
- 集成到 QI Tech 的 PSP 收到可携带性/申领
对于由 PSP 用户发起的注册,在 DICT 中进行变更之前,必须通过 QI Tech 的验证 API 执行密钥验证流程。如果验证由 PSP 自己执行,也可以在向 QI Tech 的请求中发送此信息。
要启动该流程,在这两种情况下,集成到 QI Tech 的 PSP 都必须在相应端点调用,响应以下状态之一:
| 枚举值 | 描述 |
|---|---|
| automatically_approved | 自动批准 |
| automatically_reproved | 自动拒绝 |
| in_manual_analysis | 转人工分析 |
如果变更转为人工分析,分析师须批准或拒绝该变更。此时,可以生成 Webhook 向 PSP 通知状态变化,或 PSP 可通过 Polling 跟踪变更进度。在这两种情况下,可以返回以下状态:
| 枚举值 | 描述 |
|---|---|
| manually_approved | 人工批准 |
| manually_reproved | 人工拒绝 |
认证
要认证一次调用,请使用以下代码:
# 在 shell 中,您只需在每个请求中添加适当的 header
curl "api_endpoint_here"
-H "Authorization: EXAMPLE_API_KEY"
请将 API Key 'EXAMPLE_API_KEY' 替换为您从我们支持团队获取的密钥。
我们使用 API Key 来允许访问我们的 API。它可能已经通过电子邮件发送给您。如果您尚未收到密钥,请发送电子邮件至 suporte.caas@qitech.com.br。
我们的 API 期望在所有发送到服务器的请求中,以如下 header 的形式接收 API Key:
Authorization: EXAMPLE_API_KEY
您必须将 EXAMPLE_API_KEY 替换为从支持团队收到的 API Key。