Homologation Roadmap - BaaS Digital Escrow Account
The homologation roadmap describes all the resources and functionalities that need to be tested by the integrating partner in QI Tech's sandbox environment (testing environment), before entering the product's production environment.
This roadmap describes all the resources and functionalities involved in the product.
BaaS API Registration and Authentication
| Code | Step | Description | Documentation Link | Prerequisite |
|---|---|---|---|---|
| CAB0001* | Sandbox environment registration | 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 | Documentation Link | CAB0001 |
| CAB0003* | Public key exchange | Exchange public keys within the QI Tech platform in sandbox (sandbox.qitech.app) | Documentation Link | CAB0001 and CAB0002 |
| CAB0004* | Call authentication test | Complete call authentication test | Documentation Link Documentation Link | CAB0003 |
| CAB0005* | Webhook configuration | Configure the URL for webhook delivery by QI, through the QI Tech platform in sandbox (sandbox.qitech.app) | Documentation Link | CAB0001 and CAB0002 |
QI Account
Account Opening
| Code | Step | Description | Documentation Link | Prerequisite |
|---|---|---|---|---|
| QIC0002* | Individual account reservation | Request the reservation of an account whose holder is an individual | Documentation Link | CAB0005 and CAB0006 |
| QIC0003* | Individual account opening | Perform the opening of an account whose holder is an individual | Documentation Link | QIC0002 |
| QIC0004* | Legal entity account reservation | Request the reservation of an account whose holder is a legal entity | Documentation Link | CAB0005 and CAB0006 |
| QIC0005* | Legal entity account opening | Perform the opening of an account whose holder is a legal entity | Documentation Link | QIC0004 |
| QIC0009* | Individual escrow account reservation | Request the reservation of an escrow account whose holder is an individual | Documentation Link | CAB0005 and CAB0006 |
| QIC0010* | Individual escrow account opening | Perform the opening of an escrow account whose holder is an individual | Documentation Link | CAB0005 and CAB0006 |
| QIC0011* | Legal entity escrow account reservation | Request the reservation of an escrow account whose holder is a legal entity | Documentation Link | CAB0005 and CAB0006 |
| QIC0012* | Legal entity escrow account opening | Perform the opening of an escrow account whose holder is a legal entity | Documentation Link | CAB0005 and CAB0006 |
| QIC0006* | Account opening webhook reading | Read account opening webhooks correctly | Item 1.2. or 1.3: Documentation Link | QIC0003 or QIC0005 |
| QIC0007* | List accounts | List open accounts | Documentation Link | QIC0003 or QIC0005 |
| QIC0008* | Query account data | Query data such as balance, holder data, opening date, among others | Documentation Link | QIC0003 or QIC0005 |
Transactions
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| QIC0008* | Statement Query | Perform account statement query | Documentation Link | QIC0003 or QIC0005 |
| QIC0009* | Transfer receipt request | Request a transfer receipt | Documentation Link | |
| QIC0010* | Transaction webhook reading | Successfully receive all transaction webhooks | Documentation Link | QIC0003 or QIC0005 |
| QIC0011* | Financial institutions list query | Query the list of financial institutions enabled to receive TED and Pix | Documentation Link | QIC0003 or QIC0005 |
Document Upload
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| UDD0001* | Document upload | Upload a document through our document API | Documentation Link |
TED
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| TED0001* | TED Out Transfer | Perform TED transfer | Documentation Link | QIC0003 or QIC0005 |
| TED0002* | TED Out chargeback simulation | Simulate the chargeback of a TED Out sent from a QI Account | Item 3: Documentation Link | TED0003 |
| TED0003* | TED In simulation | Simulate a TED In entry to a QI account | Item 2: Documentation Link | QIC0003 or QIC0005 |
| TED0004* | List TED transactions | List incoming/outgoing TED transactions | Documentation Link | QIC0003 or QIC0005 |
| TED0004* | TED transaction query | Query a TED transaction | Documentation Link | QIC0003 or QIC0005 |
| TED0006* | TED webhook reading | Successfully receive a TED webhook | Documentation Link | QIC0003 or QIC0005 |
Internal Transfer
| No | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| TFI0001 | Internal Transfer with account debit | Command a transfer from a QI Account, with the transfer destination being another QI Account | Documentation Link | QIC0003 or QIC0005 |
| TFI0002 | Internal Transfer simulation with account credit | Simulate receiving funds in the target QI Account, originating from another QI Account | Item 1: Documentation Link | QIC0003 or QIC0005 |
Boletos
Boleto Management
| No | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| No | Step | Description | Link | Prerequisite |
| --- | --- | --- | --- | --- |
| BOL0001 | Single collection boleto registration | Register a collection boleto | Documentation Link | CAB0002 or CAB0003 |
| BOL0002 | Single instant collection boleto registration | Register an instant collection boleto | Documentation Link | CAB0002 or CAB0003 |
| BOL0003 | Batch boleto registration | Register collection boleto in batch | Documentation Link | CAB0002 or CAB0003 |
| BOL0004 | Standard Single Boleto Issuance | Issue a standard single boleto | Documentation Link | CAB0002 or CAB0003 |
| BOL0005 | Instant Single Boleto Issuance | Issue an instant single boleto | Documentation Link | CAB0002 or CAB0003 |
| BOL0006 | Batch Issuance | Issue boletos in batch | Documentation Link | CAB0002 or CAB0003 |
| BOL0007 | Perform discount on boleto amount | Perform discount on boleto amount | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0008 | Cancel Discount | Cancel discount on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0009 | Extend boleto due date | Send due date extension for a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0010 | Include discount on a boleto | Include discount on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0011 | Include interest on a boleto | Include interest on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0012 | Include fine on a boleto | Include fine on a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0013 | Perform boleto write-off | Write off a boleto | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0014 | Query boletos by key | Query boletos by key | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0015 | List Boletos | List boletos | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0016 | Collection portfolio query | Query a collection portfolio | Documentation Link | BOL0001, BOL0002 or BOL0003 |
| BOL0017 | Boleto Webhooks | Read boleto webhook | Documentation Link | BOL0001, BOL0002 or BOL0003 |
Boleto Payment
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| BOL0009* | Typeable line or Bar Code query | Query a typeable line of a bank boleto | Documentation Link | |
| BOL0010* | Perform boleto payment | Pay a bank boleto | Documentation Link | QIC0003 or QIC0005 |
| BOL0012* | Typeable line or Bar Code query for agreement boleto | Query a typeable line of an agreement boleto. | Documentation Link | |
| BOL0013* | Perform agreement boleto payment | Pay an agreement boleto | Documentation Link | QIC0003 or QIC0005 |
Pix
Pix Transfer
| Code | Step | Description | Documentation Link | Prerequisite |
|---|---|---|---|---|
| PIX0002* | Pix Out Transfer | Perform a Pix transfer from a QI Account using bank data (manual pix) or Pix key | Documentation Link | CAB0001 |
| PIX0035 | Pix transfer query | Retrieve transfer data | Documentation Link | PIX0002 |
| PIX0003* | Pix Out refund simulation | Simulate a Pix Out refund. | Documentation Link - Item 2 | PIX0002 |
| PIX0004* | Pix In simulation | Simulate a Pix In credit to a QI Account. | Documentation Link -> Item 1 | |
| PIX0037* | Pending transaction webhook reading | Successfully receive a pending transaction webhook | [Link Documentação][(/documentation/baas/pix/webhooks) | PIX0002 |
| PIX0038* | Pix In webhook reading | Successfully receive an incoming Pix transfer webhook | Documentation Link | PIX0004 |
| PIX0039 | Pix Chargeback webhook reading | Successfully receive a Pix chargeback webhook | Documentation Link | PIX0003 |
| PIX0040 | Request chargeback of a received Pix | Request chargeback of a received Pix | Documentation Link | PIX0003 |
| PIX0041 | List account Pix transfers | List account Pix transfers | Documentation Link | PIX0003 |
Pix Key Management
Pix Key Creation and Deletion
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| PIX0008* | Pix key creation | Create Pix key of type cpf, cnpj, random, email and phone | Documentation Link | |
| QIC0003 or QIC0005 | ](/documentation/baas/pix/consultar_chave_pix) | |||
| PIX0009 | Pix key deletion | Delete a Pix key | Documentation Link | PIX0008 |
| PIX0010* | List Pix keys of a QI Account | List Pix keys linked to a QI Account | Documentation Link | PIX0008 |
Pix Key Portability
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| PIX0013* | Creating Pix Key Portability In Request | Create a Pix Key Portability In request for CPF, CNPJ, Email, Phone and Random type keys | Documentation Link | QIC0003 or QIC0005 |
| PIX0014* | 2fa resend for Email or Phone type Pix Key Portability In Request | Request SMS resend (Phone type Pix Key) or Email (Email type Pix Key) for a pending Pix Key Portability In Request (pending_claimer_validation) | Documentation Link | PIX0013 |
| PIX0015* | Pix Key Portability In Request deletion | Delete a pending Pix Key Portability In Request | Documentation Link | PIX0013 |
| PIX0016* | Pix Key Portability In completion webhook reading | Correctly read the completion webhook of a Pix Key Portability In Request. Testing all possible completion statuses (concluded, cancelled and failed) | Webhook: Documentation Link | PIX0013 |
| PIX0017* | Pix Key Portability Out Request simulation | Simulate the arrival of a Pix Key Portability Out Request | Item 5: Documentation Link | PIX0013 |
| PIX0018* | Pix Key Portability Out Request approval and rejection | Approve a Pix Key Portability Out Request | Documentation Link | PIX0017 |
| PIX0019* | 2fa resend for Pix Key Portability Out Request | Request 2fa resend for a Pix Key Portability Out Request | Enum "pending_donator_validation" Documentation Link | PIX0018 |
| PIX0020* | Pix Key Portability Out completion webhook reading | Correctly read the completion webhook of a Pix Key Portability Out Request. Testing all possible completion statuses (concluded, cancelled and failed) | Documentation Link | PIX0018 |
Pix QR Code Management
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| PIX0022* | Static Pix QR Code creation | Generate Static QR Code | Documentation Link | PIX0008 |
| PIX0023 | Dynamic Pix QR Code creation | Generate Dynamic QR Code with expiration (expiration date) and generate Instant Dynamic QR Code (with expiration seconds). | Documentation Link | PIX0008 |
| PIX0024 | Dynamic Pix QR Code deletion | Delete Pix QR Code | Documentation Link | PIX0023 |
| PIX0025 | List Dynamic Pix QR Codes | List Dynamic Pix QR Codes | Documentation Link | PIX0023 |
| PIX0026 | Instant Dynamic Pix QR Code expiration webhook reading | Successfully receive an Instant Dynamic Pix QR Code expiration webhook | Documentation Link | PIX0023 |
Pix QR Code Payment
| Code | Step | Description | Link | Prerequisite |
|---|
| PIX0029* | Static Pix QR Code payment | Pay a Static Pix QR Code | Documentation Link | PIX0022 | | PIX0030* | Dynamic Pix QR Code payment | Pay a Dynamic Pix QR Code | Documentation Link | PIX0022 | | PIX0027* | Pix QR Code decoding | Decode a Static, Dynamic with expiration and Instant Dynamic Pix QR Code | Documentation Link | PIX0022 and PIX0023 |
Pix Limit Management
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| PIX0032* | Pix limit change request | Request Pix limit change for a QI Account | Documentation Link | QIC0003 or QIC0005 |
| PIX0033 | List Pix limit change requests | List Pix limit change requests for a QI Account | Documentation Link | PIX0032 |
| PIX0034* | Consumed Pix limit query | Query consumed Pix limit for a QI Account | Documentation Link | QIC0003 or QIC0005 |
Fee Management
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| GTF0001* | Fee change request | Change account fees | Documentation Link | QIC0003 or QIC0005 |
| GTF0002* | Fee query | Query fees registered on an account | Documentation Link | QIC0003 or QIC0005 |
Card Management
Card Creation
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| GDC0001* | Virtual Card creation | Create a virtual card | Documentation Link | QIC0003 or QIC0005 |
| GDC0002* | Physical Card creation | Create a physical card | Documentation Link | QIC0003 or QIC0005 |
Card Query
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| GDC0003* | Query card by key | Query a card | Documentation Link | GDC0001 or GDC0002 |
| GDC0004* | List cards | List cards | Documentation Link | GDC0001 or GDC0002 |
| GDC0005* | Search card data | Search card data | Documentation Link | GDC0001 or GDC0002 |
| GDC0006* | Search PCI Password | Search PCI Password | Documentation Link | GDC0001 or GDC0002 |
| GDC0007* | Query delivery data | Query delivery data | Documentation Link | GDC0001 or GDC0002 |
Update card data
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| GDC0008* | Update card status | Update card status | Documentation Link | GDC0001 or GDC0002 |
| GDC0009* | Activate physical card | Activate a physical card | Documentation Link | GDC0001 or GDC0002 |
| GDC0010* | Change Password | Change card password | Documentation Link | GDC0001 or GDC0002 |
| GDC0011* | Configure card contactless | Configure card contactless | Documentation Link | GDC0002 |