Dados de pagamento
O objeto payment diz quem recebe a despesa e para onde o dinheiro vai. Ele é enviado no lançamento e no envio da nota fiscal, que aceita só parte destes campos. O meio de pagamento vem em payment_method, fora do objeto.
Atributos de payment
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
target | object | Sim | Favorecido. |
target.name | string | Sim | Nome do favorecido. |
target.document_number | string | Sim | CPF (000.000.000-00) ou CNPJ (00.000.000/0000-00, alfanumérico aceito) com pontuação. Ver quem pode receber. |
target_account | object | Condicional | Conta de destino. Obrigatório em transfer sem vendor_bank_account_key; uma das opções de pix. |
target_account.account_number | string | Sim | Número da conta, de 1 a 20 dígitos, não todos zero. |
target_account.account_branch | string | Sim | Agência, 4 dígitos, não todos zero. |
target_account.account_digit | string | Sim | Dígito, 1 algarismo. |
target_account.financial_institution_code | string | Condicional | Código do banco, 3 dígitos, não todos zero. Informe este ou o ISPB. |
target_account.financial_institution_ispb | string | Condicional | ISPB do banco, 8 dígitos. Sem ele, é preenchido a partir do código. |
target_account.account_type | string | Não | Tipo da conta, de 1 a 255 caracteres. |
vendor_bank_account_key | string | Não | Conta bancária do fornecedor do contrato (UUID). Preenche target_account ou target_pix_key com os dados cadastrados. Só com contrato, só em transfer ou pix, e não junto com target_account, target_pix_key ou pix_qrcode. |
target_pix_key | string | Condicional | Chave Pix, de 1 a 77 caracteres. Só em pix. |
pix_qrcode | string | Condicional | QR Code Pix (copia e cola), de 1 a 255 caracteres. Só em pix; o recebedor e o valor do QR Code precisam bater com o favorecido e o valor. |
bank_slip | object | Não | Boleto a pagar em bank_slip. Pode ser informado depois, no envio da nota fiscal; a despesa só é paga com ele. |
bank_slip.digitable_line | string | Sim | Linha digitável, 47 ou 48 caracteres. |
source_account | object | Condicional | Obrigatório em automatic_debit. |
source_account.account_key | string | Sim | Conta do fundo que será debitada. |
conciliation_metadata | object | Condicional | Dados de conciliação do débito automático: fee_type, conciliation_value, conciliation_field, external_key, reference_key, todos string. Obrigatório, com fee_type, em bankslip_fee com automatic_debit. |
Destino por meio de pagamento
payment_method | Destino |
|---|---|
transfer | target_account ou vendor_bank_account_key. Não aceita target_pix_key nem pix_qrcode. |
pix | Exatamente um entre target_account, target_pix_key, pix_qrcode e vendor_bank_account_key. |
bank_slip | bank_slip.digitable_line, no lançamento ou no envio da nota fiscal. |
automatic_debit | source_account.account_key. |
Quem pode receber
| Caso | target.document_number precisa ser |
|---|---|
Despesa com contrato, sem vendor_bank_account_key | O CPF ou CNPJ do fornecedor do contrato. |
Reembolso à gestora (reimbursement_recipient: manager) | O CNPJ da gestora do fundo. |
Reembolso à consultoria (reimbursement_recipient: consultant) | O CNPJ de uma consultoria com vínculo ativo com o fundo. |
cvm_tax | CVM (29.507.878/0001-08) ou empresa do grupo QI Tech (62.285.390/0001-40, 32.402.502/0001-35). |
cetip_tax | B3 (09.358.105/0001-91) ou empresa do grupo QI Tech. |
selic_tax | Banco Central (00.038.166/0001-05) ou empresa do grupo QI Tech. |
anbima_tax | ANBIMA (raiz 34.271.171) ou empresa do grupo QI Tech. |
- No reembolso, vale só a regra do reembolso.
- Com
vendor_bank_account_key, o favorecido não é comparado com o fornecedor. - As mesmas regras valem quando o favorecido é trocado no envio da nota fiscal.
Erros
Estes erros vêm da chamada que recebe o payment, junto com os erros próprios dela.
| Status | code | Quando acontece |
|---|---|---|
| 400 | QIT000001 | Corpo inválido: campo obrigatório de payment ausente. |
| 400 | EXP000178 | vendor_bank_account_key em despesa sem contrato. |
| 400 | EXP000179 | vendor_bank_account_key junto com outro destino (target_account, target_pix_key ou pix_qrcode). |
| 400 | EXP000180 | A conta de vendor_bank_account_key não é do fornecedor do contrato. |
| 400 | EXP000181 | A conta do fornecedor está inativa. |
| 400 | EXP000182 | A conta não serve para o meio de pagamento (por exemplo, uma conta só com chave Pix em transfer). |
| 400 | EXP000183 | financial_institution_code não corresponde a nenhum banco. |
| 400 | EXP000208 | O favorecido não é o fornecedor do contrato. |
| 400 | EXP000209 | O favorecido do reembolso não é a gestora. |
| 400 | EXP000210 | O favorecido do reembolso não é uma consultoria vinculada ao fundo. |
| 400 | EXP000211 | O favorecido da taxa CVM, ANBIMA, CETIP ou SELIC não é a entidade nem o grupo QI Tech. |
| 400 | EXP000004 | O CPF ou CNPJ do favorecido é inválido. |
| 400 | EXP000175 | transfer com target_pix_key ou pix_qrcode. |
| 400 | EXP000036 | Falta o destino: transfer sem conta, ou pix sem nenhuma das opções. |
| 400 | EXP000104 | pix com mais de um destino. |
| 400 | EXP000107 | O recebedor do QR Code Pix não é o favorecido. |
| 400 | EXP000108 | O valor do QR Code Pix difere do valor da despesa. |
| 400 | EXP000030 | automatic_debit sem source_account. |
| 400 | EXP000099 | bankslip_fee em automatic_debit sem conciliation_metadata. |
| 400 | EXP000053 | bankslip_fee em automatic_debit sem 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"
}
Erros de autenticação, permissão e host: veja Erros da API.