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
| Field | Type | Required | Description |
|---|---|---|---|
target | object | Yes | Payee. |
target.name | string | Yes | Payee name. |
target.document_number | string | Yes | CPF (000.000.000-00) or CNPJ (00.000.000/0000-00, alphanumeric accepted) with punctuation. See who can receive. |
target_account | object | Conditional | Destination account. Required on transfer without vendor_bank_account_key; one of the options for pix. |
target_account.account_number | string | Yes | Account number, from 1 to 20 digits, not all zeros. |
target_account.account_branch | string | Yes | Branch, 4 digits, not all zeros. |
target_account.account_digit | string | Yes | Check digit, 1 numeral. |
target_account.financial_institution_code | string | Conditional | Bank code, 3 digits, not all zeros. Provide this or the ISPB. |
target_account.financial_institution_ispb | string | Conditional | Bank ISPB, 8 digits. If omitted, it is filled in from the code. |
target_account.account_type | string | No | Account type, from 1 to 255 characters. |
vendor_bank_account_key | string | No | Vendor 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_key | string | Conditional | Pix key, from 1 to 77 characters. Only on pix. |
pix_qrcode | string | Conditional | Pix 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_slip | object | No | Bank 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_line | string | Yes | Digitable line, 47 or 48 characters. |
source_account | object | Conditional | Required on automatic_debit. |
source_account.account_key | string | Yes | Fund account to be debited. |
conciliation_metadata | object | Conditional | Automatic 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_method | Destination |
|---|---|
transfer | target_account or vendor_bank_account_key. Does not accept target_pix_key or pix_qrcode. |
pix | Exactly one of target_account, target_pix_key, pix_qrcode and vendor_bank_account_key. |
bank_slip | bank_slip.digitable_line, on creation or when submitting the invoice. |
automatic_debit | source_account.account_key. |
Who can receive
| Case | target.document_number must be |
|---|---|
Expense with a contract, without vendor_bank_account_key | The 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_tax | CVM (29.507.878/0001-08) or a QI Tech group company (62.285.390/0001-40, 32.402.502/0001-35). |
cetip_tax | B3 (09.358.105/0001-91) or a QI Tech group company. |
selic_tax | Central Bank (00.038.166/0001-05) or a QI Tech group company. |
anbima_tax | ANBIMA (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.
| Status | code | When it happens |
|---|---|---|
| 400 | QIT000001 | Invalid body: missing required payment field. |
| 400 | EXP000178 | vendor_bank_account_key on an expense without a contract. |
| 400 | EXP000179 | vendor_bank_account_key together with another destination (target_account, target_pix_key or pix_qrcode). |
| 400 | EXP000180 | The vendor_bank_account_key account does not belong to the contract's vendor. |
| 400 | EXP000181 | The vendor's account is inactive. |
| 400 | EXP000182 | The account does not suit the payment method (for example, an account with only a Pix key on transfer). |
| 400 | EXP000183 | financial_institution_code does not match any bank. |
| 400 | EXP000208 | The payee is not the contract's vendor. |
| 400 | EXP000209 | The reimbursement payee is not the manager. |
| 400 | EXP000210 | The reimbursement payee is not a consultant linked to the fund. |
| 400 | EXP000211 | The payee of the CVM, ANBIMA, CETIP or SELIC fee is neither the entity nor the QI Tech group. |
| 400 | EXP000004 | The payee's CPF or CNPJ is invalid. |
| 400 | EXP000175 | transfer with target_pix_key or pix_qrcode. |
| 400 | EXP000036 | Missing destination: transfer without an account, or pix with none of the options. |
| 400 | EXP000104 | pix with more than one destination. |
| 400 | EXP000107 | The Pix QR Code's receiver is not the payee. |
| 400 | EXP000108 | The Pix QR Code amount differs from the expense amount. |
| 400 | EXP000030 | automatic_debit without source_account. |
| 400 | EXP000099 | bankslip_fee on automatic_debit without conciliation_metadata. |
| 400 | EXP000053 | bankslip_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.