跳到主要内容

API 错误

IaaS API 的所有错误响应都使用相同的响应体。HTTP 状态码和 code 说明发生了什么；code 的前缀说明错误发生在哪个领域。

错误响应体格式​

字段类型说明
titlestring错误的简短名称，英文。
descriptionstring英文说明。在校验错误中，会指出校验失败的字段。
translationstring葡萄牙语说明。
codestring三个字母表示领域，后跟六位数字。请在错误处理中使用此字段。

示例：没有写入权限的管理人集成调用 POST。

{
  "title": "Manager does not have permission to access this endpoint",
  "description": "Manager does not have permission to access this endpoint",
  "translation": "Gestor nao tem permissão para acessar esse endpoint",
  "code": "MIT000017"
}

请根据 HTTP 状态码和 code 处理错误。title、description 和 translation 的文本可能会变化。

code 前缀​

前缀错误发生的位置
MIT管理人主机（manager-api）：认证、权限和路由。
CIT顾问主机（consultant-api）：认证、权限和路由。
AIT转让方主机（assignor-api）：认证、权限和路由。
QIT通用错误，可出现在任何主机或服务：路由不存在、方法不被接受、请求体无效、内部错误。
SET资产结算（/settlement）。
TRC应收账款转让（/trade_receivables）。
TRF转让文件（/trade_receivables_files）。
TRR资产出售与回购（/trade_resolve）。
TTR公共债券交易单（/trade_treasury）。
ASR转让方准入（/assignor_registry）。
ASS转让方（/assignor）。
ACT转让合同（/assignment_contract）。
AAM应收账款补充协议（/asset_amendment）。
ADF资产文件（/asset_document_files）。
BSCBoleto（/bankslip_collection）。
CSH账户与对账单（/cash_account）。
TSF内部转账（/transfer）。
TRV交易冲正（/transaction_reversal）。
CMP投资组合构成（/composition）。
WLT投资组合（/wallet）。
EXP费用（/expense）。
IVR投资者登记（/investor_registry）。
IAD加入协议（/investor_adhesion）。
QTA份额（/quota）。
QOF发行控制（/quota_offering_control）。
TFQ作为资产的基金份额（/trade_fund_quota）。

400 且 code 为 QIT000001 表示请求体无效：有问题的字段会在 description 中给出。

认证​

请求头、API 密钥和签名相关的错误（*000007 至 *000016 以及 *000020）及其修正方法，请参阅认证测试。

权限与路由​

请求通过认证后，主机会检查您的集成是否可以调用该路由。缺少权限时返回 401，而不是 403：当 code 为以下之一时，不要去排查签名错误。

状态code发生情形处理方式
401MIT000017管理人集成没有该路由所需的权限：读取、写入或两者。查看端点页面“适用范围”中的权限，以及集成页面 权限（Permissões） 中的状态。参见开通集成权限。
401CIT000018顾问与该基金（fund_class_key）没有有效关联，或在该基金中没有该路由所需的权限。检查 fund_class_key 以及“适用范围”中标明的权限。顾问的权限按基金授予。如果权限显示为 由集成团队开通，则无法在门户中配置：请发送邮件至 integracao.dtvm@qitech.com.br 申请开通。
401AIT000017转让方集成没有该路由所需的读取或写入权限。请联系 integracao.dtvm@qitech.com.br。
400*000009集成已停用。重新启用集成（方法）或联系集成团队。
404QIT000404该主机未开放此路径。对于已文档化的路由，几乎都是使用了其他角色的基础 URL：请查看页面的“适用范围”以及您角色的基础 URL。同时检查不含 base_url 的路径。
405QIT000405该路径在主机上存在，但不支持此方法。请在端点页面核对方法。

重发与重复​

如发生错误，请重发请求。如果资源已存在，创建请求会返回重复错误，而不会再创建一个：请查询已存在的资源。

创建重复 code状态如何查询已存在的资源
付款批次（结算）SET000009409批次查询，使用批次的 external_id。
批次内的结算SET000013400结算查询，使用结算的 external_id。
出售或回购批次TRR000015409GET /trade_resolve/fund_class/{fund_class_key}/assignment/{assignment_external_id}，仅在转让方主机上开放。管理人和顾问没有该查询。
公共债券交易单TTR000044409GET /trade_treasury/fund_class/{fund_class_key}/operations，在列表中查找您的 external_id。
公共债券交易单：务必发送 external_id

在公共债券交易单中，external_id 是可选的。请务必发送：没有它，API 无法识别已创建的交易单。

内部错误​

500 且 code 为 QIT000500 表示 QI 一方的错误。如果持续出现，请将请求（不含私钥）、UTC 时间和 code 发送至 integracao.dtvm@qitech.com.br。