Commercial Notes Bookkeeping + Boletos + Settlement System Integration Guide
The homologation guide describes all the resources and functionalities that need to be tested by the integration partner in QI Tech's sandbox environment (testing environment), before going into production environment for the issuance of commercial notes, boletos and settlements.
This guide describes all the resources and functionalities involved in the product.
Attention
All tests must be mandatorily performed in QI Tech's Sandbox environment (testing environment). Operations performed in Sandbox environment are fictional financial operations, serving only for API functionality testing.
Bookkeeping API Registration and Authentication
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| CAB0001* | Public key exchange | Perform public key exchange with the platform operations team (suporte.dcm@qitech.com.br) | Documentation Link | |
| CAB0002* | Call authentication test | After receiving the API key from the platforms team, complete call authentication test | Documentation Link Documentation Link | CAB0001 |
| CAB0003* | Webhook configuration | Configure the URL for QI webhook sending. | Documentation Link Documentation Link Documentation Link | CAB0001 and CAB0002 |
Issuer homologation for registrations made through the bookkeeping system
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| CED0001* | Basic issuer registration | Create the issuer, informing the basic registration information. | Documentation Link | |
| CED0002* | Sending and removing Issuer Documents | Sending and removing documents associated with a previously registered issuer | Documentation Link Documentation Link | CED0001 |
| CED0003* | Registering and removing Issuer Representatives | Sending and removing representatives associated with a previously registered issuer | Documentation Link Documentation Link | CED0001 |
| CED0004* | Sending and removing Issuer Representative Documents | sending and removing documents associated with a representative of a previously registered issuer | Documentation Link Documentation Link | CED0001, CED0003 |
| CED0005* | Registering and removing Issuer Bank Account | registering and removing a bank account associated with a previously registered issuer | Documentation Link Documentation Link | CED0001 |
| CED0006* | Registering and removing Issuer Signer Groups | registering and removing signer groups associated with a previously registered issuer | Documentation Link Documentation Link | CED0001 |
| CED0007* | Registering and removing Issuer Contact Information | registering and removing contact information associated with a previously registered issuer | Documentation Link Documentation Link | CED0001 |
| CED0008* | Submitting the Issuer for Analysis | This endpoint allows changing the status of an issuer to analysis, sending it into the validation process. | Documentation Link | CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007 |
| CED0009* | Amending the Issuer Registration | amend the issuer to allow editing | Documentation Link | CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007 |
| CED0010* | List of registered issuers | List of registered assignors, with filters by CNPJ, name | Documentation Link | |
| CED0011* | Issuer details | View the details of a registered issuer, by issuer_key | Documentation Link |
Investor Homologation
Attention
For the investor homologation flow, the investor registration will be performed by the bookkeeping team at setup time and the key will be provided to the team.
Investor homologation for registrations made during setup
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| INV1001* | List of registered investors | List of registered funds, with filters by CNPJ, name | Documentation Link | |
| INV1002* | Investor details | View the details of a registered investor, by investor_key | Documentation Link |
Commercial note issuance
After the issuer and investor registrations, commercial notes can be issued. For this, there are some combinations of issuance flows, which are covered below.
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| COM0001* | Simulation of financial conditions | simulate the financial conditions and the payment flow of an operation | Documentation Link | |
| COM0002* | Commercial Note Operation Registration | create a new commercial note operation based on the financial and investor data. | Documentation Link | COM0001 |
| COM0003 | Registering and Removing Related Parties | registering and removing parties related to an operation | Documentation Link | COM0002 |
| COM0004 | Sending and Removing Documents of Related Party Representatives | sending and removing documents associated with representatives of parties related to an operation | Documentation Link | COM0002, COM0003 |
| COM0005 | Sending and Removing Signer Groups of Related Party Representatives | sending and removing signer groups associated with representatives of parties related to an operation | Documentation Link | COM0002, COM0003 |
| COM0006 | Preview Constitutive Term | generation of a draft of the Constitutive Term for a specific operation, using a predefined template. | Documentation Link | COM0002 |
| COM0007* | Change Constitutive Term Template | changing the Constitutive Term template for a specific operation | Documentation Link | COM0002 |
| COM0008* | Submit Operation for Analysis | change the status of an operation to "under analysis", sending it to the compliance validation process by the bookkeeper | Documentation Link | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007 |
| COM0009* | Submit Signed Approval Minutes | This endpoint allows sending the approval minutes of SA or COP type companies, signed externally, to the bookkeeping system, sending a base64 that will be analysed and approved by the bookkeeper. | Documentation Link | COM0002 |
| COM0010* | Query Operations by Filters | query commercial note operations using optional filters | Documentation Link | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
| COM0011* | Query Operation by Key | query the complete details of a specific operation, using its unique key. | Documentation Link | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
If signing is via QI SIGN
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| COM0012* | Query the Operation's QI SIGN Signature Links | query all the signature links of a specific operation via QI SIGN, using its unique key. | Documentation Link | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
| COM0013* | Query the Link of the Operation's Contracts Signed via QI SIGN | query all the signed documents of a specific operation via QI SIGN, using its unique key | Documentation Link | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
Settlement/Subscription process
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| INT0001* | Query Settlement by Key | query the details of a settlement process using its unique key | Documentation Link |
Error mapping
Errors originating from the issuer, investor and commercial note APIs can be found in Error Catalog Link
Boleto issuance
BaaS API Registration and Authentication
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| CAB0001* | Registration in the Sandbox environment | Register on the QI Tech platform in the Sandbox environment (sandbox.qitech.app) | cs@qitech.com.br | |
| CAB0002* | Token validation in Sandbox | Validate the QI Token in Sandbox | Download the Token Inclusion Manual | CAB0001 |
| CAB0003* | Public key exchange | Perform the public key exchange within the QI Tech platform in sandbox (sandbox.qitech.app) | Documentation Link | CAB0001 and CAB0002 |
| CAB0004* | Call authentication test | Complete the call authentication test | Step by Step Documentation Link | CAB0003 |
| CAB0005* | Webhook configuration | Configure the URL for QI webhook sending, through the QI Tech platform in sandbox (sandbox.qitech.app) | Documentation Link | CAB0001 and CAB0002 |
QI Conta
| Code | Step | Description | Documentation Link | Prerequisites |
|---|---|---|---|---|
| QIC0001* | Query account data | Query data such as balance, owner data, opening date, among others | Documentation Link | CAB0003 |
Account movements
| Code | Step | Description | Link | Prerequisites |
|---|---|---|---|---|
| QIC0008* | Statement Query | Query the statement of an account | Documentation Link | CAB0003 |
| QIC0009* | Transfer receipt request | Request a transfer receipt | Documentation Link | CAB0003 |
| QIC0010* | Reading transaction webhooks | Successfully receive all transaction webhooks | Documentation Link | CAB0003 |
| QIC0011* | Query the list of financial institutions | Query the list of financial institutions enabled to receive TED and Pix | Documentation Link | CAB0003 |
Boletos
Pix Key Management
Creating and Deleting a Pix Key
| Code | Step | Description | Link | Prerequisites |
|---|---|---|---|---|
| PIX0001* | Pix key creation | Create a Pix key of type cpf, cnpj, random, e-mail and phone | Documentation Link | |
| PIX0010* | List the Pix keys of a QI Conta | List Pix keys linked to a QI Conta | Documentation Link | PIX0001 |
Wallet Management
| Code | Step | Description | Link | Prerequisites |
|---|---|---|---|---|
| CRT0001* | Wallet creation | Create a wallet for specific payment, settlement, protest configurations, etc. | Documentation Link | |
| CRT0002* | Edit wallet | Edit the default configurations. | Documentation Link | CRT0002 |
Boleto Management
| No. | Step | Description | Link | Prerequisites |
|---|---|---|---|---|
| BOL0001 | Registration of a single collection boleto (standard) | Register a collection boleto | Documentation Link | CAB0002 or CAB0003 |
| BOL0002 | Registration of a single collection boleto (instant) | Register a collection boleto | Documentation Link | CAB0002 or CAB0003 |
| BOL0003 | Batch boleto registration | Register collection boletos in batch | Documentation Link | CAB0002 or CAB0003 |
| BOL0004 | Apply a rebate to the amount of a boleto | Apply a rebate to the amount of a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0005 | Cancel Rebate | Cancel a rebate on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0006 | Extend the due date of a boleto | Send a term extension for a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0007 | Include a discount on a boleto | Include a discount on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0008 | Include interest on a boleto | Include interest on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0009 | Include a penalty on a boleto | Include a penalty on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0010 | Settle a boleto | Settle a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0011 | Query boletos by key | Query boletos by key | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0012 | List Boletos | List boletos | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0013 | Collection wallet query | Query a collection wallet | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0014 | Boleto Webhooks | Read the webhook for a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
Protests
| No. | Step | Description | Link | Prerequisites |
|---|---|---|---|---|
| BOL0015 | Protest request | Request the protest of a boleto | Documentation Link | CAB0002 or CAB0003 |
| BOL0016 | Withdrawal of a protest request (suspension) | Withdraw a protest request, keeping the boleto registered | Documentation Link | BOL0015 |
| BOL0017 | Withdrawal of a protest request, with settlement of the boleto | Withdraw a protest request, settling the boleto | Documentation Link | BOL0015 |
| BOL0018 | Protest removal (cancellation) | Cancel a confirmed protest (accepted by the notary office) | Documentation Link | BOL0015 |
| BOL0019 | List protests | List the protests of an account's wallet | Documentation Link | BOL0015 |
| BOL0020 | Query protest by key | Query the protest information of a boleto | Documentation Link | BOL0015 |
| BOL0021 | Query protest instrument | Query the protest instrument (official document issued by the notary office) | Documentation Link | BOL0015 |
Boleto Conciliation
| No. | Step | Description | Link | Prerequisites |
|---|---|---|---|---|
| CON0001 | List settlement groups | List the settlement groups of the settled boletos | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| CON0002 | List settlements | List the boletos of the settlement groups | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| CON0003 | Boleto Webhooks | Read the webhook for a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
QI DTVM Integration - Instalment settlement
| No. | Step | Description | Link | Prerequisites |
|---|---|---|---|---|
| BAX0001 | Payment Batch Creation | Creation of the Payment Batch for the instalments | Documentation Link | |
| BAX0002 | Insertion of settlements | Settle instalments | Documentation Link | BAX0001 |