Roteiro de Integração de escrituração de notas comerciais + Boletos + Sistema de baixas OMIE
O roteiro de homologação descreve todos os recursos e funcionalidades que precisam ser testados pelo parceiro integrador no ambiente de sandbox da QI Tech (ambiente de testes), antes da entrada em ambiente de produção para emissão de notas comerciais, boletos e baixas OMIE.
Este roteiro descreve todos os recursos e funcionalidades envolvidos no produto.
Atenção
Todos os testes devem ser obrigatoriamente realizados no ambiente de Sandbox da QI Tech (ambiente de testes). As operações realizadas em ambiente de Sandbox são operações financeiras fictícias, servindo apenas para teste de funcionalidade das APIs.
Cadastro e Autenticação API Escrituração
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| CAB0001* | Troca de chaves públicas | Realizar a troca de chaves públicas com o time operações de plataforma (suporte.dcm@qitech.com.br) | Link Documentação | |
| CAB0002* | Teste de autenticação de chamadas | Após receber a chave de api com o time de plataformas, finalizar teste de autenticação de chamadas | Link Documentação Link Documentação | CAB0001 |
| CAB0003* | Configuração de webhooks | Realizar a configuração da url para envio dos webhooks por parte da QI. | Link Documentação Link Documentação Link Documentação | CAB0001 e CAB0002 |
Homologação do emissor para cadastros feitos pelo sistema de escrituração
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| CED0001* | Cadastro Básico do emissor | Criar o emissor, informando as informações básicas do cadastro. | Link Documentação | |
| CED0002* | Envio e remoção de Documentos do Emissor | Envio e remoção de documentos associados a um emissor previamente cadastrado | Link Documentação Link Documentação | CED0001 |
| CED0003* | Cadastro e remoção de Representantes do Emissor | Envio e remoção de representantes associados a um emissor previamente cadastrado | Link Documentação Link Documentação | CED0001 |
| CED0004* | Envio e remoção de Documentos do Representante do Emissor | envio e remoção de documentos associados a um representante de um emissor previamente cadastrado | Link Documentação Link Documentação | CED0001, CED0003 |
| CED0005* | Cadastro e remoção de Conta Bancária do Emissor | cadastro e remoção de conta bancária associada a um emissor previamente cadastrado | Link Documentação Link Documentação | CED0001 |
| CED0006* | Cadastro e remoção de Grupos de Assinantes do Emissor | cadastro e remoção de grupos de assinantes associados a um emissor previamente cadastrado | Link Documentação Link Documentação | CED0001 |
| CED0007* | Cadastro e remoção de Informações de Contato do Emissor | cadastro e remoção de informações de contato associadas a um emissor previamente cadastrado | Link Documentação Link Documentação | CED0001 |
| CED0008* | Envio para Análise do Emissor | Este endpoint permite alterar o status de um emissor para análise, enviando-o para o processo de validação. | Link Documentação | CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007 |
| CED0009* | Alteração de Cadastro do Emissor | alterar emissor para permitir edição | Link Documentação | CED0001, CED0002, CED0003, CED0004, CED0005, CED0006, CED0007 |
| CED0010* | Listagem dos emissores cadastrados | Listagem dos cedentes cadastrados, com filtros por CNPJ, nome | Link Documentação | |
| CED0011* | Detalhes do emissor | Visualizar os detalhes de um emissor cadastrado, por issuer_key | Link Documentação |
Homologação do Investidor
Atenção
Para o fluxo de homologação do investidor, será realizado o cadastro do investidor pelo time de escrituração no momento de setup e a chave será fornecida ao time OMIE.
Homologação do investidor para cadastros feitos no setup
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| INV1001* | Listagem dos investidores cadastrados | Listagem dos fundos cadastrados, com filtros por CNPJ, nome | Link Documentação | |
| INV1002* | Detalhes do investidor | Visualizar os detalhes de um investidor cadastro, por investor_key | Link Documentação |
Emissão de nota comercial
Após os cadastros de emissores e investidores, é possível realizar a emissão de notas comerciais. Para isso, existem algumas combinações de fluxos de emissão, que serão contempladas abaixo.
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| COM0001* | Simulação de condições financeiras | simular as condições financeiras e o fluxo de pagamentos de uma operação | Link Documentação | |
| COM0002* | Cadastro de Operação de Nota Comercial | criar uma nova operação de nota comercial com base nos dados financeiros e de investidores. | Link Documentação | COM0001 |
| COM0003* | Cadastro e Remoção de Partes Relacionadas | cadastro e a remoção de partes relacionadas a uma operação | Link Documentação | COM0002 |
| COM0004* | Envio e Remoção de Documentos de Representantes de Partes Relacionadas | envio e a remoção de documentos associados a representantes de partes relacionadas a uma operação | Link Documentação | COM0002, COM0003 |
| COM0005* | Envio e Remoção de Grupos de Assinantes de Representantes de Partes Relacionadas | envio e a remoção de grupos de assinantes associados a representantes de partes relacionadas a uma operação | Link Documentação | COM0002, COM0003 |
| COM0006 | Pré-visualizar Termo Constitutivo | geração de uma minuta do Termo Constitutivo para uma operação específica, utilizando um template predefinido. | Link Documentação | COM0002 |
| COM0007* | Alterar Template do Termo Constitutivo | alteração do template do Termo Constitutivo para uma operação específica | Link Documentação | COM0002 |
| COM0008* | Envio de documentos | envio de documentos associados a uma operação. O "document_key" retornado poderá ser utilizado, por exemplo, no sistema de garantias | Link Documentação | COM0002 |
| COM0009* | Envio de Garantia na Operação | adição de garantias associadas a uma operação | Link Documentação | COM0002, COM0008 |
| COM0010* | Cadastro e Remoção de Partes Relacionadas de um contrato/Garantia | cadastro e a remoção de partes relacionadas de um contrato/garantia específicos da operação | Link Documentação | COM0002, COM0003 |
| COM0011* | Enviar Operação para Análise | alterar o status de uma operação para "em análise", enviando-a para o processo de validação de compliance pelo escriturador | Link Documentação | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
| COM0012* | Enviar Atas de Aprovação Assinadas | Este endpoint permite enviar as atas de aprovação de empresas do tipo SA ou COP assinadas de forma externa para o sistema de escrituação, enviando um base64 que será analisado e aprovado pelo escriturador. | Link Documentação | COM0002 |
| COM0013* | Consulta de Operações por Filtros | consultar operações de nota comercial utilizando filtros opcionais | Link Documentação | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
| COM0014* | Consulta de Operação por Chave | consultar os detalhes completos de uma operação específica, utilizando sua chave única. | Link Documentação | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
Caso assinatura seja via QI SIGN
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| COM0015* | Consulta dos Links para assinatura via QI SIGN da Operação | consultar todos os links para assinatura de uma operação específica via QI SIGN, utilizando sua chave única. | Link Documentação | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
| COM0016* | Consulta do Link dos contratos assinados via QI SIGN da Operação | consultar todos os documentos assinados de uma operação específica via QI SIGN, utilizando sua chave única | Link Documentação | COM0002, COM0003, COM0004, COM0005, COM0006, COM0007, COM0008, COM0009 |
Processo de integralização/Subscrição
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| INT0001* | Consulta de Integralização por Chave | consultar os detalhes de um processo de integralização utilizando sua chave única | Link Documentação | |
| INT0002* | Consulta de Subscrição | consultar uma subcrição em andamento | Link Documentação | INT0001 |
| INT0003 | Cadastro de Subscrição | registrar a intenção de um investidor em subscrever uma quantidade específica de cotas de uma integralização (útil caso seja necessário deslocar a data de uma subscrição) | Link Documentação | INT0001, INT0002 |
| INT0004 | Cancelar subscrição | cancelar subscrição (útil caso seja necessário deslocar a data de uma subscrição) | Link Documentação | INT0001, INT0002 |
Mapeamento de erros
Os erros originários das apis de emissores, investidores e nota comercial podem ser encontrados em Link Catálogo de Erros
Emissão de boletos
Cadastro e Autenticação API BaaS
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| CAB0001* | Cadastro no ambiente de Sandbox | Realizar o cadastro na plataforma da QI Tech no ambiente de Sandbox (sandbox.qitech.app) | cs@qitech.com.br | |
| CAB0002* | Validaç ão de token em Sandbox | Realizar a validação do QI Token em Sandbox | Download Manual de Inclusão do Token | CAB0001 |
| CAB0003* | Troca de chaves públicas | Realizar a troca de chaves públicas dentro da plataforma da QI Tech em sandbox (sandbox.qitech.app) | Link Documentação | CAB0001 e CAB0002 |
| CAB0004* | Teste de autenticação de chamadas | Finalizar teste de autenticação de chamadas | Passo a Passo Link Documentação | CAB0003 |
| CAB0005* | Configuração de webhooks | Realizar a configuração da url para envio dos webhooks por parte da QI, através da plataforma da QI Tech em sandbox (sandbox.qitech.app) | Link Documentação | CAB0001 e CAB0002 |
QI Conta
| Código | Etapa | Descrição | Link Documentação | Pré-requisito |
|---|---|---|---|---|
| QIC0001* | Consulta de dados de uma conta | Consultar dados como saldo, dados do titular, data de abertura, dentre outros | Link Documentação | CAB0003 |
Movimentações
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| QIC0008* | Consulta de Extrato | Realizar a consulta do extrato de uma conta | Link Documentação | CAB0003 |
| QIC0009* | Solicitação de comprovante de transferência | Solicitar um comprovante de transferência | Link Documentação | CAB0003 |
| QIC0010* | Leitura de webhooks de transação | Recepcionar com sucesso todos os webhooks de transação | Link Documentação | CAB0003 |
| QIC0011* | Consulta de lista de instituições financeiras | Consultar lista de instituições financeiras habiliatadas para recebimento de TED e Pix | Link Documentação | CAB0003 |
Boletos
Gestão de Chave Pix
Criação e Exclusão de Chave pix
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| PIX0001* | Criação de chave Pix | Realizar a criação de chave Pix do tipo cpf, cnpj, aleatória, e-mail e telefone | Link Documentação | |
| PIX0010* | Listagem de chaves Pix de uma QI Conta | Listar chaves Pix vinculadas a uma QI Conta | Link Documentação | PIX0001 |
Gestão da Carteira
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| CRT0001* | Criação de carteira | Realizar a criação de carteira para configurações específicas de pagamento, baixa, protesto, etc. | Link Documentação | |
| CRT0002* | Editar carteira | Realizar a edição das configurações padrão. | Link Documentação | CRT0002 |
Gestão de Boletos
| Nº | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| BOL0001 | Registro de boleto único de cobrança (padrão) | Realizar o registro de um boleto de cobrança | Link Documentação | CAB0002 ou CAB0003 |
| BOL0002 | Registro de boleto único de cobrança (instantânea) | Realizar o registro de um boleto de cobrança | Link Documentação | CAB0002 ou CAB0003 |
| BOL0003 | Registro de boleto em lote | Realizar o registro de boleto de cobrança em lote | Link Documentação | CAB0002 ou CAB0003 |
| BOL0004 | Realizar abatimento no valor de um boleto | Realizar abatimento no valor de um boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0005 | Cancelar Abatimento | Cancelar abatimento em um boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0006 | Estender vencimento de um boleto | Enviar extensão de prazo de um boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0007 | Incluir desconto em um boleto | Incluir desconto em um boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0008 | Incluir juros em um boleto | Incluir juros em um boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0009 | Incluir multa em um boleto | Incluir multa em um boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0010 | Realizar baixa de um boleto | Baixar um boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0011 | Consultar boletos por chave | Consultar boletos por chave | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0012 | Listar Boletos | Listar boletos | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0013 | Consulta de carteira de cobrança | Consultar uma carteira de cobrança | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
| BOL0014 | Webhooks de Boleto | Realizar a leitura de webhook para boleto | Link Documentação | BOL0001, BOL0002 ou BOL0003 |
Conciliação de Boletos
| Nº | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| CON0001 | Listar grupos de liquidação | Realizar a listagem dos grupos de liquidação dos boletos liquidados | Link Documentação | BOL0001 ou BOL0002 ou BOL0003 |
| CON0002 | Listar liquidações | Realizar a listagem dos boletos dos grupos de liquidação | Link Documentação | BOL0001 ou BOL0002 ou BOL0003 |