Skip to main content

Roteiro de Integração de escrituração de notas comerciais

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.

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ódigoEtapaDescriçãoLink DocumentaçãoPré-requisito
CAB0001*Troca de chaves públicasRealizar 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 chamadasApós receber a chave de api com o time de plataformas, finalizar teste de autenticação de chamadasLink Documentação

Link Documentação		CAB0001
CAB0003*Configuração de webhooksRealizar 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​

Atenção

Para o fluxo de homologação do emissor, caso o cliente já tenha realizado a integração com o cadastros de cedentes QI TECH, é possível reutilizar esses cadastros, simplificando a homologação no sistema de escrituração

Homologação do emissor para cadastros feitos no sistema de cedentes QI TECH​

CódigoEtapaDescriçãoLink DocumentaçãoPré-requisito
CED1001*Reaproveitar cadastro cedenteRealizar o reaproveitamento do cadastro de cedente utilizando o CNPJ do mesmo.Link Documentação
CED1002*Listagem dos emissores cadastradosListagem dos cedentes cadastrados, com filtros por CNPJ, nomeLink Documentação
CED1003*Detalhes do emissorVisualizar os detalhes de um emissor cadastrado, por issuer_keyLink Documentação

Homologação do Investidor​

Atenção

Para o fluxo de homologação do investidor, caso o cliente tenha fundos fixos, é possível realizar o cadastro desses no setup, simplificando a integração.

Homologação do investidor para cadastros feitos no setup​

CódigoEtapaDescriçãoLink DocumentaçãoPré-requisito
INV1001*Listagem dos investidores cadastradosListagem dos fundos cadastrados, com filtros por CNPJ, nomeLink Documentação
INV1002*Detalhes do investidorVisualizar os detalhes de um investidor cadastro, por investor_keyLink 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ódigoEtapaDescriçãoLink DocumentaçãoPré-requisito
COM0001Simulação de condições financeirassimular as condições financeiras e o fluxo de pagamentos de uma operaçãoLink Documentação
COM0002*Cadastro de Operação de Nota Comercialcriar uma nova operação de nota comercial com base nos dados financeiros e de investidores.Link DocumentaçãoCOM0001
COM0002
COM003*Enviar Operação para Análisealterar o status de uma operação para "em análise", enviando-a para o processo de validação de compliance pelo escrituradorLink DocumentaçãoCOM0002
COM004*Enviar Contratos AssinadosEste endpoint permite enviar os contratos assinados de forma externa para o sistema de escrituação, enviando um base64 que será analisado e aprovado pelo escriturador.Link DocumentaçãoCOM0002
COM0005Consulta de Operações por Filtrosconsultar operações de nota comercial utilizando filtros opcionaisLink DocumentaçãoCOM0002, COM0003, COM0004
COM0006Consulta de Operação por Chaveconsultar os detalhes completos de uma operação específica, utilizando sua chave única.Link DocumentaçãoCOM0002, COM0003, COM0004

Mapeamento de erros​

Os erros originários das apis de emissores, investidores e nota comercial podem ser encontrados em Link Catálogo de Erros