付款数据
payment 对象说明由谁收取该费用、款项付往何处。它在录入和发送发票时发送,其中发送发票只接受部分字段。付款方式在对象之外的 payment_method 中提供。
payment 属性
| 字段 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
target | object | 是 | 收款人。 |
target.name | string | 是 | 收款人名称。 |
target.document_number | string | 是 | 带标点的 CPF(000.000.000-00)或 CNPJ(00.000.000/0000-00,接受字母数字格式)。参见谁可以收款。 |
target_account | object | 条件必填 | 收款账户。transfer 且未提供 vendor_bank_account_key 时必填;也是 pix 的可选方式之一。 |
target_account.account_number | string | 是 | 账号,1 至 20 位数字,不能全为零。 |
target_account.account_branch | string | 是 | 支行号,4 位数字,不能全为零。 |
target_account.account_digit | string | 是 | 校验位,1 位数字。 |
target_account.financial_institution_code | string | 条件必填 | 银行代码,3 位数字,不能全为零。须提供此字段或 ISPB。 |
target_account.financial_institution_ispb | string | 条件必填 | 银行 ISPB,8 位数字。不提供时根据银行代码自动填充。 |
target_account.account_type | string | 否 | 账户类型,1 至 255 个字符。 |
vendor_bank_account_key | string | 否 | 合同供应商的供应商银行账户(UUID)。使用已登记的数据填充 target_account 或 target_pix_key。仅限有合同的费用,仅限 transfer 或 pix,且不能与 target_account、target_pix_key 或 pix_qrcode 同时提供。 |
target_pix_key | string | 条件必填 | Pix 密钥,1 至 77 个字符。仅限 pix。 |
pix_qrcode | string | 条件必填 | Pix 二维码(复制粘贴码),1 至 255 个字符。仅限 pix;二维码的收款方和金额必须与收款人和金额一致。 |
bank_slip | object | 否 | bank_slip 方式下要支付的 Boleto。可稍后在发送发票时提供;费用只有在提供后才会支 付。 |
bank_slip.digitable_line | string | 是 | 数字行,47 或 48 个字符。 |
source_account | object | 条件必填 | automatic_debit 时必填。 |
source_account.account_key | string | 是 | 将被扣款的基金账户。 |
conciliation_metadata | object | 条件必填 | 自动扣款的对账数据:fee_type、conciliation_value、conciliation_field、external_key、reference_key,均为 string。bankslip_fee 使用 automatic_debit 时必填,且须包含 fee_type。 |
各付款方式的收款目标
payment_method | 收款目标 |
|---|---|
transfer | target_account 或 vendor_bank_account_key。不接受 target_pix_key 和 pix_qrcode。 |
pix | target_account、target_pix_key、pix_qrcode 和 vendor_bank_account_key 中恰好一个。 |
bank_slip | bank_slip.digitable_line,在录入时或发送发票时提供。 |
automatic_debit | source_account.account_key。 |
谁可以收款
| 情形 | target.document_number 必须是 |
|---|---|
有合同的费用,未提供 vendor_bank_account_key | 合同供应商的 CPF 或 CNPJ。 |
向管理人报销(reimbursement_recipient: manager) | 基金管理人的 CNPJ。 |
向顾问报销(reimbursement_recipient: consultant) | 与该基金有有效关联的顾问的 CNPJ。 |
cvm_tax | CVM(29.507.878/0001-08)或 QI Tech 集团公司(62.285.390/0001-40、32.402.502/0001-35)。 |
cetip_tax | B3(09.358.105/0001-91)或 QI Tech 集团公司。 |
selic_tax | 巴西央行(00.038.166/0001-05)或 QI Tech 集团公司。 |
anbima_tax | ANBIMA(根号 34.271.171)或 QI Tech 集团公司。 |
- 报销时只适用报销规则。
- 使用
vendor_bank_account_key时,不会将收款人与供应商比对。 - 在发送发票时更换收款人,同样适用这些规则。
错误
这些错误由接收 payment 的调用返回,与该调用自身的错误一起出现。
| 状态 | code | 发生情形 |
|---|---|---|
| 400 | QIT000001 | 请求体无效:缺少 payment 的必填字段。 |
| 400 | EXP000178 | 无合同的费用提供了 vendor_bank_account_key。 |
| 400 | EXP000179 | vendor_bank_account_key 与其他收款目标(target_account、target_pix_key 或 pix_qrcode)同时提供。 |
| 400 | EXP000180 | vendor_bank_account_key 的账户不属于合同供应商。 |
| 400 | EXP000181 | 该供应商账户已停用。 |
| 400 | EXP000182 | 该账户不适用于该付款方式(例如在 transfer 中使用仅有 Pix 密钥的账户)。 |
| 400 | EXP000183 | financial_institution_code 没有对应任何银行。 |
| 400 | EXP000208 | 收款人不是合同供应商。 |
| 400 | EXP000209 | 报销的收款人不是管理人。 |
| 400 | EXP000210 | 报销的收款人不是与该基金关联的顾问。 |
| 400 | EXP000211 | CVM、ANBIMA、CETIP 或 SELIC 费用的收款人既不是相应机构,也不是 QI Tech 集团。 |
| 400 | EXP000004 | 收款人的 CPF 或 CNPJ 无效。 |
| 400 | EXP000175 | transfer 带有 target_pix_key 或 pix_qrcode。 |
| 400 | EXP000036 | 缺少收款目标:transfer 未提供账户,或 pix 未提供任何一种方式。 |
| 400 | EXP000104 | pix 提供了多个收款目标。 |
| 400 | EXP000107 | Pix 二维码的收款方不是该收款人。 |
| 400 | EXP000108 | Pix 二维码的金额与费用金额不同。 |
| 400 | EXP000030 | automatic_debit 未提供 source_account。 |
| 400 | EXP000099 | bankslip_fee 在 automatic_debit 下未提供 conciliation_metadata。 |
| 400 | EXP000053 | bankslip_fee 在 automatic_debit 下未提供 conciliation_metadata.fee_type。 |
Exemplo
{
"title": "Payment Target Must Be Contract Vendor",
"description": "The payment target must be the vendor of the contract 0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d (document 44.555.666/0001-81).",
"translation": "O favorecido do pagamento deve ser o fornecedor do contrato 0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d (documento 44.555.666/0001-81).",
"code": "EXP000208"
}
认证、权限和主机相关错误:参见 API 错误。