Skip to main content

Payment details

The payment object states who receives the expense and where the money goes. It is sent on creation and on invoice submission, which accepts only some of these fields. The payment method goes in payment_method, outside the object.

payment attributes​

FieldTypeRequiredDescription
targetobjectYesPayee.
target.namestringYesPayee name.
target.document_numberstringYesCPF (000.000.000-00) or CNPJ (00.000.000/0000-00, alphanumeric accepted) with punctuation. See who can receive.
target_accountobjectConditionalDestination account. Required on transfer without vendor_bank_account_key; one of the options for pix.
target_account.account_numberstringYesAccount number, from 1 to 20 digits, not all zeros.
target_account.account_branchstringYesBranch, 4 digits, not all zeros.
target_account.account_digitstringYesCheck digit, 1 numeral.
target_account.financial_institution_codestringConditionalBank code, 3 digits, not all zeros. Provide this or the ISPB.
target_account.financial_institution_ispbstringConditionalBank ISPB, 8 digits. If omitted, it is filled in from the code.
target_account.account_typestringNoAccount type, from 1 to 255 characters.
vendor_bank_account_keystringNoVendor bank account of the contract (UUID). Fills in target_account or target_pix_key with the registered data. Only with a contract, only on transfer or pix, and not together with target_account, target_pix_key or pix_qrcode.
target_pix_keystringConditionalPix key, from 1 to 77 characters. Only on pix.
pix_qrcodestringConditionalPix QR Code (copy and paste), from 1 to 255 characters. Only on pix; the QR Code's receiver and amount must match the payee and the amount.
bank_slipobjectNoBank slip to pay on bank_slip. Can be provided later, when submitting the invoice; the expense is only paid once it is provided.
bank_slip.digitable_linestringYesDigitable line, 47 or 48 characters.
source_accountobjectConditionalRequired on automatic_debit.
source_account.account_keystringYesFund account to be debited.
conciliation_metadataobjectConditionalAutomatic debit reconciliation data: fee_type, conciliation_value, conciliation_field, external_key, reference_key, all strings. Required, with fee_type, on bankslip_fee with automatic_debit.

Destination by payment method​

payment_methodDestination
transfertarget_account or vendor_bank_account_key. Does not accept target_pix_key or pix_qrcode.
pixExactly one of target_account, target_pix_key, pix_qrcode and vendor_bank_account_key.
bank_slipbank_slip.digitable_line, on creation or when submitting the invoice.
automatic_debitsource_account.account_key.

Who can receive​

Casetarget.document_number must be
Expense with a contract, without vendor_bank_account_keyThe CPF or CNPJ of the contract's vendor.
Reimbursement to the manager (reimbursement_recipient: manager)The CNPJ of the fund's manager.
Reimbursement to the consultant (reimbursement_recipient: consultant)The CNPJ of a consultant with an active link to the fund.
cvm_taxCVM (29.507.878/0001-08) or a QI Tech group company (62.285.390/0001-40, 32.402.502/0001-35).
cetip_taxB3 (09.358.105/0001-91) or a QI Tech group company.
selic_taxCentral Bank (00.038.166/0001-05) or a QI Tech group company.
anbima_taxANBIMA (root 34.271.171) or a QI Tech group company.
  • On a reimbursement, only the reimbursement rule applies.
  • With vendor_bank_account_key, the payee is not compared with the vendor.
  • The same rules apply when the payee is changed on invoice submission.

Errors​

These errors come from the call that receives payment, along with that call's own errors.

StatuscodeWhen it happens
400QIT000001Invalid body: missing required payment field.
400EXP000178vendor_bank_account_key on an expense without a contract.
400EXP000179vendor_bank_account_key together with another destination (target_account, target_pix_key or pix_qrcode).
400EXP000180The vendor_bank_account_key account does not belong to the contract's vendor.
400EXP000181The vendor's account is inactive.
400EXP000182The account does not suit the payment method (for example, an account with only a Pix key on transfer).
400EXP000183financial_institution_code does not match any bank.
400EXP000208The payee is not the contract's vendor.
400EXP000209The reimbursement payee is not the manager.
400EXP000210The reimbursement payee is not a consultant linked to the fund.
400EXP000211The payee of the CVM, ANBIMA, CETIP or SELIC fee is neither the entity nor the QI Tech group.
400EXP000004The payee's CPF or CNPJ is invalid.
400EXP000175transfer with target_pix_key or pix_qrcode.
400EXP000036Missing destination: transfer without an account, or pix with none of the options.
400EXP000104pix with more than one destination.
400EXP000107The Pix QR Code's receiver is not the payee.
400EXP000108The Pix QR Code amount differs from the expense amount.
400EXP000030automatic_debit without source_account.
400EXP000099bankslip_fee on automatic_debit without conciliation_metadata.
400EXP000053bankslip_fee on automatic_debit without conciliation_metadata.fee_type.
Example
{
"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"
}

Authentication, permission and host errors: see API Errors.