Pular para o conteúdo principal

Roteiro de Integração — API de Escrituração de Notas Comerciais (NC) com Auto-Assinatura

Este roteiro descreve todos os recursos e funcionalidades que precisam ser testados pelo parceiro integrador no ambiente de Sandbox da QI Tech, antes da entrada em ambiente de produção para emissão de notas comerciais (NC).

Trata-se de uma versão personalizada do roteiro padrão de integração de NC da QI Tech, adaptada para o fluxo de emissão totalmente automatizado: uma vez que o emissor esteja cadastrado, aprovado e habilitado para auto-assinatura, todas as emissões seguintes ocorrem de ponta a ponta via API, sem etapa manual de assinatura.

Atenção

Todos os testes devem ser obrigatoriamente realizados no ambiente de Sandbox da QI Tech. As operações realizadas em ambiente de Sandbox são operações financeiras fictícias, servindo apenas para teste de funcionalidade das APIs.


1. Escopo e fases

O fluxo é dividido em seis fases. As fases 0 a 4 se apoiam em funcionalidades já disponíveis na API. A fase de habilitação da auto-assinatura (Fase 2) depende de novo desenvolvimento do lado da QI Tech. A Fase 6 é dividida em duas: a transferência de recursos para a conta de liquidação da WL (6.1) utiliza endpoints de BaaS que já existem e podem ser homologados hoje; o pagamento ao fornecedor (6.2) depende de novo desenvolvimento.

LegendaSignificado
Disponível hoje — pode ser homologado em Sandbox imediatamente
🆕Novo desenvolvimento — contrato do endpoint a ser publicado; a homologação começa após a liberação
⚙️Executado pela QI Tech (sem ação do integrador, mas o integrador precisa observar o status resultante)
*Etapa obrigatória para o aceite da homologação
Premissa de sequenciamento

A auto-assinatura só é configurada após a aprovação do cadastro do emissor. O termo de adesão que a autoriza é assinado dentro do pacote da primeira emissão. A partir da segunda emissão, a assinatura do lado do emissor é totalmente automática. A Fase 2 é, portanto, um portão único por emissor, e não uma etapa por operação.


2. Fluxo ponta a ponta


3. Fase 0 — Cadastro e autenticação na API

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
CAB0001*Troca de chave públicaRealizar a troca de chave pública com o time de operações da plataforma (suporte.dcm@qitech.com.br)Documentação
CAB0002*Teste de autenticaçãoApós o recebimento da chave de API, realizar os testes de autenticação de chamadaDocumentação

Documentação
CAB0001
CAB0003*Configuração de webhooksConfigurar a URL para a qual a QI Tech enviará os webhooksDocumentação

Documentação

Documentação
CAB0001, CAB0002
Atenção

Neste fluxo, a configuração de webhooks é obrigatória, e não opcional. Como a análise, a aprovação e a assinatura são automáticas, o integrador não possui nenhum ponto de conferência manual — os webhooks são a única forma de acompanhar o avanço da operação sem polling.


4. Fase 1 — Homologação do emissor

Atenção

Caso o cliente já tenha realizado a integração com os cadastros de cedente da QI Tech, é possível reutilizar esses cadastros, o que simplifica consideravelmente a homologação no sistema.

4.1 Fase 1A — Emissor cadastrado no sistema de cedentes da QI Tech

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
CED1001*Reutilizar cadastro de cedenteReutilizar um cadastro de cedente existente por CNPJDocumentaçãoCAB0002
CED1002*Listar emissores cadastradosListar os emissores cadastrados, filtrando por CNPJ ou nomeDocumentaçãoCED1001
CED1003*Detalhes do emissorConsultar os detalhes de um emissor cadastrado pela issuer_keyDocumentaçãoCED1001

4.2 Fase 1B — Emissor cadastrado pelo sistema

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
CED0001*Cadastro básico do emissorCriar o emissor com seus dados cadastrais básicosDocumentaçãoCAB0002
CED0002*Upload / remoção de documentos do emissorAnexar e remover documentos associados a um emissor cadastradoDocumentação

Documentação
CED0001
CED0003*Cadastro / remoção de representantes do emissorAdicionar e remover representantes associados a um emissor cadastradoDocumentação

Documentação
CED0001
CED0004*Upload / remoção de documentos de representantesAnexar e remover documentos associados a um representante de um emissor cadastradoDocumentação

Documentação
CED0001, CED0003
CED0005*Cadastro / remoção de conta bancária do emissorAdicionar e remover uma conta bancária associada a um emissor cadastradoDocumentação

Documentação
CED0001
CED0006*Cadastro / remoção de grupos de assinantes do emissorAdicionar e remover grupos de assinantes associados a um emissor cadastradoDocumentação

Documentação
CED0001, CED0003
CED0007*Cadastro / remoção de informações de contato do emissorAdicionar e remover informações de contato associadas a um emissor cadastradoDocumentação

Documentação
CED0001
CED0008*Envio do emissor para análiseMover o emissor para o status de análise, enviando-o ao processo de validaçãoDocumentaçãoCED0001 → CED0007
CED0009*Alteração do cadastro do emissorReabrir o emissor para ediçãoDocumentaçãoCED0001 → CED0007
CED0010*Listar emissores cadastradosListar os emissores cadastrados, filtrando por CNPJ ou nomeDocumentaçãoCED0001
CED0011*Detalhes do emissorConsultar os detalhes de um emissor cadastrado pela issuer_keyDocumentaçãoCED0001
Portão para a Fase 2

O grupo de assinantes cadastrado em CED0006 define qual representante assinará em nome do emissor. Esse mesmo representante é quem assina o termo de adesão da auto-assinatura na Fase 2 e cuja alçada o certificado privado representa. Cadastre-o corretamente antes de enviar o emissor para análise — uma alteração posterior exige repetir a Fase 2.


5. Fase 2 — Habilitação da auto-assinatura 🆕

Esta fase é a nova funcionalidade que viabiliza o fluxo automatizado. Ela ocorre uma única vez por emissor, após a aprovação do cadastro do emissor, e resulta em um certificado privado da QI Tech com escopo exclusivo aos documentos de NC desta integração.

O que o termo de adesão autoriza. Ele concede à QI Tech um mandato limitado para emitir e custodiar um certificado privado interno, liberado na CertifiQI, a ser utilizado exclusivamente para assinar os documentos deste fluxo de NC em nome do emissor — nunca para qualquer outro documento, produto ou contraparte. É assinado uma única vez, com biometria de reconhecimento facial, pelo representante cadastrado em CED0006.

Quando é assinado. O termo é incluído no pacote da primeira emissão. A primeira operação, portanto, ainda possui uma etapa de assinatura humana; a partir da segunda operação, a assinatura do lado do emissor é totalmente automática.

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
ASG0001*Consultar elegibilidade para auto-assinaturaLer o bloco signature_configuration do emissor para confirmar que ele está aprovado e elegível à habilitação de auto-assinaturaDocumentação (pendente de publicação)CED0011 ou CED1003🆕
ASG0002*Solicitar habilitação de auto-assinaturaSolicitar a habilitação para um emissor aprovado, indicando o grupo de assinantes e o representante que assinará o termo de adesão. Retorna uma auto_signature_key no status pending_agreementDocumentação (pendente de publicação)ASG0001, CED0006🆕
ASG0003*Consultar link de assinatura do termo de adesãoConsultar o link pelo qual o representante assina o termo de adesão com reconhecimento facial. Na primeira emissão, esse link é entregue como parte do pacote de assinatura da operaçãoDocumentação (pendente de publicação)ASG0002🆕
ASG0004*Webhook — termo de adesão assinadoReceber o webhook que confirma que o termo de adesão foi assinado e validadoDocumentação (pendente de publicação)CAB0003, ASG0003🆕
ASG0005Emissão do certificado privadoA QI Tech cria o certificado privado e o libera na CertifiQI, com escopo restrito aos documentos de NC deste emissor. Hoje é manual (uma única vez por emissor, executado pela QI Tech); a automação via API está no roadmap e não bloqueia o go-liveASG0004⚙️ 🆕
ASG0006*Consultar status da auto-assinaturaConsultar a habilitação pela auto_signature_key ou pela issuer_key e confirmar a transição para active. Nenhuma NC pode depender da assinatura automática antes de esse status ser atingidoDocumentação (pendente de publicação)ASG0002🆕
ASG0007*Webhook — auto-assinatura ativaReceber o webhook que sinaliza que o certificado está disponível e o emissor está habilitado para assinatura automáticaDocumentação (pendente de publicação)CAB0003, ASG0005🆕
ASG0008Consultar termo de adesão assinadoConsultar o documento do termo de adesão assinado para registro e trilha de auditoria do próprio integradorDocumentação (pendente de publicação)ASG0004🆕
ASG0009Revogar auto-assinaturaRevogar a habilitação e o certificado associado — necessário quando o representante muda, quando o grupo de assinantes é alterado ou a pedido do emissor. Após a revogação, as emissões voltam ao fluxo de assinatura manual até que a Fase 2 seja repetidaDocumentação (pendente de publicação)ASG0006🆕

5.1 Máquina de status da habilitação

StatusSignificadoComportamento de assinatura de uma nova NC
not_requestedEmissor aprovado, mas nunca submetido à habilitaçãoAssinatura manual (QI SIGN)
pending_agreementHabilitação solicitada; termo de adesão ainda não assinadoAssinatura manual — o termo viaja no pacote desta operação
pending_certificateTermo assinado; certificado em emissão pela QI TechAssinatura manual — segurar novas emissões até active
activeCertificado liberado na CertifiQIAutomática
revokedHabilitação revogadaAssinatura manual (QI SIGN)
Requisito de homologação

O integrador deve demonstrar, em Sandbox, que seu sistema lê o status da habilitação antes de criar uma operação e roteia corretamente nos dois sentidos: assinatura automática quando active e o fallback do QI SIGN (COM0015 / COM0016) em todos os demais status. Uma integração que assume active vai quebrar na primeira emissão de todo emissor novo.


6. Fase 3 — Homologação do investidor

Atenção

Caso o cliente opere com fundos fixos, estes podem ser cadastrados durante o setup, o que simplifica consideravelmente a integração. Para este fluxo, o caminho de fundos fixos é a configuração esperada.

6.1 Investidores cadastrados durante o setup — caminho recomendado

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
INV1001*Listar investidores cadastradosListar os fundos cadastrados, filtrando por CNPJ ou nomeDocumentaçãoCAB0002
INV1002*Detalhes do investidorConsultar os detalhes de um investidor cadastrado pela investor_keyDocumentaçãoCAB0002

6.2 Investidores cadastrados pelo sistema — apenas se não forem utilizados fundos fixos

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
INV0001*Cadastro básico do investidorCriar o investidor com seus dados cadastrais básicosDocumentaçãoCAB0002
INV0002*Upload / remoção de documentos do investidorAnexar e remover documentos associados a um investidor cadastradoDocumentação

Documentação
INV0001
INV0003*Cadastro / remoção de representantes do investidorAdicionar e remover representantes associados a um investidor cadastradoDocumentação

Documentação
INV0001
INV0004*Upload / remoção de documentos de representantesAnexar e remover documentos associados a um representante de um investidor cadastradoDocumentação

Documentação
INV0001, INV0003
INV0005*Cadastro / remoção de conta bancária do investidorAdicionar e remover uma conta bancária associada a um investidor cadastradoDocumentação

Documentação
INV0001
INV0006*Cadastro / remoção de grupos de assinantes do investidorAdicionar e remover grupos de assinantes associados a um investidor cadastradoDocumentação

Documentação
INV0001
INV0007*Cadastro / remoção de informações de contato do investidorAdicionar e remover informações de contato associadas a um investidor cadastradoDocumentação

Documentação
INV0001
INV0008*Envio do investidor para análiseMover o investidor para o status de análise, enviando-o ao processo de validaçãoDocumentaçãoINV0001 → INV0007
INV0009*Alteração do cadastro do investidorReabrir o investidor para ediçãoDocumentaçãoINV0001 → INV0007
INV0010*Listar investidores cadastradosListar os fundos cadastrados, filtrando por CNPJ ou nomeDocumentaçãoINV0001
INV0011*Detalhes do investidorConsultar os detalhes de um investidor cadastrado pela investor_keyDocumentaçãoINV0001

7. Fase 4 — Emissão da NC

Com emissores e investidores cadastrados, as notas comerciais podem ser emitidas. A emissão via API é a premissa central desta integração: o fluxo por tela não funciona no volume pretendido.

7.1 Criação da operação

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
COM0001*Simular condições financeirasSimular as condições financeiras e o cronograma de pagamento de uma operaçãoDocumentaçãoCAB0002
COM0002*Criar operação de NCCriar uma nova operação de nota comercial a partir dos dados financeiros e do investidorDocumentaçãoCOM0001, CED0011/CED1003, INV1002
COM0003*Cadastro / remoção de partes relacionadasAdicionar e remover partes relacionadas a uma operaçãoDocumentaçãoCOM0002
COM0004*Upload / remoção de documentos de representantes de partes relacionadasAnexar e remover documentos associados a representantes de partes relacionadasDocumentaçãoCOM0002, COM0003
COM0005*Cadastro / remoção de grupos de assinantes de partes relacionadasAdicionar e remover grupos de assinantes associados a representantes de partes relacionadasDocumentaçãoCOM0002, COM0003
COM0006Prévia do Termo ConstitutivoGerar uma minuta do Termo Constitutivo de uma operação a partir de um template predefinidoDocumentaçãoCOM0002
COM0007*Alterar template do Termo ConstitutivoAlterar o template do Termo Constitutivo utilizado por uma operaçãoDocumentaçãoCOM0002
COM0008*Upload de documentosRealizar o upload de documentos associados a uma operação. A document_key retornada pode ser utilizada, por exemplo, no sistema de garantiasDocumentaçãoCOM0002
COM0009*Cadastro de garantiasAdicionar garantias associadas a uma operaçãoDocumentaçãoCOM0002, COM0008
COM0010*Cadastro / remoção de partes relacionadas de um contrato ou garantiaAdicionar e remover partes relacionadas a um contrato ou garantia específica da operaçãoDocumentaçãoCOM0002, COM0003
COM0011*Envio da operação para análiseMover a operação para "em análise", enviando-a ao processo de validação de complianceDocumentaçãoCOM0002 → COM0009
COM0012*Envio de ata de aprovação assinadaEnviar a ata de aprovação assinada externamente para emissores SA ou COP, em payload base64, analisada e aprovadaDocumentaçãoCOM0002
COM0013*Consulta de operações por filtroConsultar operações de nota comercial utilizando filtros opcionaisDocumentaçãoCOM0002 → COM0009
COM0014*Consulta de operação por chaveConsultar os detalhes completos de uma operação específica pela sua chave únicaDocumentaçãoCOM0002 → COM0009

7.2 Assinatura — caminho automático (emissor com auto-assinatura active) 🆕

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
COM0020*Aprovação automáticaCom a auto-assinatura ativa e as condições operacionais previamente aprovadas, a operação passa de análise para aprovada sem intervenção manual. O integrador observa a transição via webhookDocumentação (pendente de publicação)COM0011, ASG0006⚙️ 🆕
COM0021*Assinatura automática do Termo ConstitutivoA QI Tech assina o Termo Constitutivo em nome do emissor utilizando o certificado privado liberado na CertifiQI. Nenhum link de assinatura é gerado para o emissorDocumentação (pendente de publicação)COM0020⚙️ 🆕
COM0022*Webhook — operação assinadaReceber o webhook que confirma que todas as assinaturas da operação foram concluídasDocumentaçãoCAB0003, COM0021🆕
COM0023*Consulta de documentos assinadosConsultar os documentos assinados da operação pela sua chave única, incluindo o relatório de evidências de assinaturaDocumentaçãoCOM0022

7.3 Assinatura — fallback manual (QI SIGN)

Obrigatório para a primeira emissão de cada emissor — que carrega o termo de adesão — e para qualquer emissor cujo status de habilitação não seja active.

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
COM0015*Consulta de links de assinatura QI SIGNConsultar todos os links de assinatura de uma operação específica via QI SIGN, pela sua chave únicaDocumentaçãoCOM0002 → COM0009
COM0016*Consulta de links de contratos assinadosConsultar todos os documentos assinados de uma operação específica via QI SIGN, pela sua chave únicaDocumentaçãoCOM0002 → COM0009

8. Fase 5 — Subscrição e integralização

Com a operação assinada, o boletim de subscrição é gerado automaticamente e disponibilizado para assinatura do investidor. Quando o investidor também está habilitado para auto-assinatura, esta etapa também não exige interação humana.

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
INT0001*Consulta de processo de integralização por chaveConsultar os detalhes de um processo de integralização pela sua chave únicaDocumentaçãoCOM0022
INT0002*Consulta de subscriçãoConsultar uma subscrição em andamentoDocumentaçãoINT0001
INT0003Cadastro de subscriçãoCadastrar a intenção de um investidor de subscrever um número específico de cotas — útil quando a data de subscrição precisa ser deslocadaDocumentaçãoINT0001, INT0002
INT0004Cancelamento de subscriçãoCancelar uma subscrição — útil quando a data de subscrição precisa ser deslocadaDocumentaçãoINT0001, INT0002
INT0005*Webhook — boletim de subscrição assinadoReceber o webhook que confirma que o boletim de subscrição foi assinado. Este é o gatilho que o sistema do cliente utiliza para comandar a transferência de recursos da Fase 6.1 (TFI0002)DocumentaçãoCAB0003, INT0002🆕

9. Fase 6 — Transferência de recursos e pagamento 🆕

A Fase 6 possui duas pernas. A primeira (6.1) é disparada pelo próprio sistema do integrador ao receber o webhook de assinatura do boletim de subscrição, e move os recursos para a conta de liquidação da WL. A segunda (6.2) paga o fornecedor a partir dessa conta.

9.1 Perna 1 — Transferência para a conta de liquidação da WL 🆕

Gatilho. O webhook de boletim de subscrição assinado (INT0005) é o evento que autoriza a transferência de recursos. Ao recebê-lo, o sistema do cliente comanda um pagamento na API de BaaS, enviando uma transferência para a conta de liquidação da WL. A QI Tech não inicia essa transferência — é uma ação do lado do integrador, e o webhook é seu único gatilho. Nada nesta perna pode ser disparado antes da chegada do INT0005: uma transferência comandada contra um boletim não assinado não possui operação que a lastreie.

Como origem e destino são QI Contas, trata-se de uma transferência interna (QI Conta → QI Conta), que liquida em tempo real e não depende dos trilhos de Pix ou TED.

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
TFI0001*Consultar a conta de liquidação da WLConsultar a conta de liquidação da WL que receberá os recursos, incluindo seus identificadores e saldoDocumentaçãoCAB0002
TFI0002*Comandar a transferência internaAo receber o INT0005, comandar a transferência da QI Conta de origem para a conta de liquidação da WL. A requisição deve carregar a chave única da operação para que o crédito possa ser conciliado de volta à NCDocumentaçãoINT0005, TFI0001
TFI0003*Consultar a transferênciaConsultar a transferência comandada e confirmar que ela liquidou na conta de liquidação da WLDocumentaçãoTFI0002
TFI0004*Webhook — transação liquidadaReceber o webhook de movimentação que confirma o crédito na conta de liquidação da WL. Este é o gatilho da perna 6.2DocumentaçãoCAB0003, TFI0002
TFI0005Comprovante de transferênciaSolicitar o comprovante da transferência para registro e trilha de auditoria do próprio integradorDocumentaçãoTFI0002
Idempotência

O webhook pode ser entregue mais de uma vez. O integrador deve chavear a transferência pela operação, de modo que um INT0005 reentregue não comande uma segunda transferência para a mesma NC. A conciliação entre a chave da operação e a transação creditada é responsabilidade do integrador.

TFI0002 — Comandar a transferência interna

ENDPOINT
/account/ACCOUNT_KEY/ted
MÉTODO
POST

A ACCOUNT_KEY é a QI Conta de origem que será debitada. O target_account é a conta de liquidação da WL — no caminho interno, seu ispb é o da própria QI Tech (32402502), o que faz a transferência liquidar conta a conta em vez de sair pelo trilho de TED.

Request Body
{
"request_control_key": "0c3d2a3e-c121-464e-b5a4-8e69e0c17bbd",
"target_account": {
"account_branch": "0001",
"account_number": "2359934",
"account_digit": "2",
"owner_document_number": "09080702000105",
"owner_name": "Conta de Liquidação WL",
"ispb": "32402502",
"account_type": "checking_account"
},
"transaction_amount": 150000.00
}
A request_control_key é a chave de idempotência

Derive-a de forma determinística a partir da chave da operação de NC, em vez de gerar um UUID novo a cada tentativa. Um INT0005 reentregue que produza a mesma request_control_key é rejeitado como duplicidade, em vez de pagar a conta de liquidação duas vezes.

Response Body — 201
{
"request_control_key": "0c3d2a3e-c121-464e-b5a4-8e69e0c17bbd",
"ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"created_at": "2021-10-22T20:30:23.459Z",
"ted_status": "sent",
"transaction_amount": 150000.00,
"fee_amount": 0.0,
"transaction_key": "46804f32-101e-4702-8fbc-c2dbc4c2caec"
}

TFI0004 — Webhook de confirmação do crédito

O crédito na conta de liquidação da WL chega como um webhook account_transaction, com data.amount positivo e source_sub_type = internal_funds_transfer. Faça o casamento de data.transaction_key com a transaction_key retornada pelo TFI0002 para fechar o ciclo de volta à operação de NC.

WEBHOOK_TYPE
account_transaction
Webhook Body
{
"key": "<ACCOUNT-KEY>",
"data": {
"amount": 150000.00,
"origin": {
"name": "Conta de Origem",
"branch": "0001",
"document": "32402502000135",
"account_key": "5d068423-6094-49e4-b15b-7740038295a8",
"account_digit": "5",
"account_number": "00002"
},
"timestamp": "2022-09-02T21:36:33.446120",
"destination": {
"name": "Conta de Liquidação WL",
"branch": "0001",
"document": "09080702000105",
"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
"account_digit": "2",
"account_number": "2359934"
},
"reference_key": "983b4a28-7de6-4e71-97ef-60fb50c7b013",
"reference_type": "movement_request",
"account_balance": 150000.00,
"source_sub_type": "internal_funds_transfer",
"transaction_key": "46804f32-101e-4702-8fbc-c2dbc4c2caec",
"source_sub_type_str": "Transferência Interna"
},
"datetime": "2022-09-02T21:36:33.446120",
"webhook_type": "account_transaction"
}
Não mapeie os webhooks de forma restrita

Campos adicionais podem ser incluídos aos payloads dos webhooks da QI Tech a qualquer momento. Faça um parsing defensivo — uma integração que rejeita campos desconhecidos vai quebrar em uma release futura.

9.2 Perna 2 — Pagamento ao fornecedor 🆕

A conta de liquidação do emissor é aberta gratuitamente pela QI Tech no momento da emissão e é referenciada no pacote de assinatura da NC. Pagar o fornecedor a partir da conta de liquidação do próprio emissor preserva a relação comercial: o fornecedor vê o pagamento chegando do seu próprio cliente.

CódigoEtapaDescriçãoDocumentaçãoPré-requisitoStatus
PAY0001*Consultar a conta de liquidação do emissorConsultar a conta de liquidação aberta para o emissor na emissão, incluindo seus identificadores e saldoDocumentação (a confirmar)COM0022🆕
PAY0002*Confirmar recursos disponíveisConfirmar que os recursos transferidos na perna 6.1 liquidaram na conta de liquidaçãoDocumentaçãoTFI0004
PAY0003*Iniciar pagamento a terceirosDisparar o pagamento da conta de liquidação do emissor para o fornecedor via API de BaaS. Estimativa de 4 semanas de desenvolvimentoDocumentação (pendente de publicação)PAY0002🆕
PAY0004*Consultar status do pagamentoConsultar o status de um pagamento pela sua chave únicaDocumentação (a confirmar)PAY0003🆕
PAY0005*Webhook — pagamento liquidadoReceber o webhook que confirma que o fornecedor foi pagoDocumentação (a confirmar)CAB0003, PAY0003🆕
Escopo da fase 1

Uma NC por pagamento. O split de pagamento — uma nota financiando vários pagamentos a fornecedores — não é suportado nesta fase e está previsto para a fase 2 do projeto. O integrador deve modelar suas requisições de acordo: uma operação, um beneficiário.


10. Resumo dos webhooks

Como o fluxo elimina todos os pontos de conferência manual, estes são os eventos que o integrador precisa consumir para acompanhar uma operação de ponta a ponta.

EventoFaseO que ele libera
Status do emissor alterado1Portão de aprovação — habilita a solicitação da Fase 2
Termo de adesão assinado2Início da emissão do certificado
Auto-assinatura ativa2Todas as emissões seguintes podem ocorrer automaticamente
Status da operação alterado4Visibilidade sobre análise → aprovada
Operação assinada4Geração do boletim de subscrição
Boletim de subscrição assinado5Gatilho da transferência de recursos para a conta de liquidação da WL (TFI0002)
Movimentação de conta (internal_funds_transfer)6.1Recursos confirmados na conta de liquidação da WL — libera o pagamento ao fornecedor
Pagamento liquidado6.2Fecha o ciclo

11. Pontos em aberto a serem fechados antes do go-live

#Ponto em abertoResponsávelImpacto
1Confirmar as condições operacionais da NC — número de parcelas, formas de pagamento e template de contrato. A auto-assinatura precisa cobrir todos os modos operacionais utilizados pelo cliente; qualquer coisa fora do conjunto previamente aprovado cai no fluxo de assinatura manualClienteBloqueia a definição do escopo da auto-assinatura
2Definir a forma de pagamento ao fornecedor: Pix/QR code ou boleto. Pix/QR é direto; boleto exige um desenvolvimento significativamente maiorCliente + QI TechDimensiona o desenvolvimento da Fase 6
3Pagamento a terceiros a partir da conta de liquidação — estimativa de 4 semanas de desenvolvimentoQI TechBloqueia a Fase 6
4Criação do certificado via API — hoje é manual (uma única vez por emissor, executado pela QI Tech); prazo em avaliação. Não bloqueia o go-liveQI TechAfeta a escalabilidade do onboarding, não as primeiras operações
5Publicação dos contratos dos endpoints da Fase 2 (ASG) e do comportamento de aprovação/assinatura automática (COM0020–COM0022)QI TechBloqueia a homologação da Fase 2
6Split de pagamento confirmado como escopo da fase 2Cliente + QI TechDefine a fronteira da fase 1
7Confirmar qual QI Conta é debitada como origem da transferência da perna 6.1, e se a conta de liquidação da WL é a mesma conta referenciada no pacote de assinatura da NC ou uma conta separadaCliente + QI TechDefine a ACCOUNT_KEY e o target_account do TFI0002

12. Mapeamento de erros

Os erros originados das APIs de emissor, investidor e nota comercial estão catalogados no Catálogo de Erros.

Os erros específicos de auto-assinatura — tentativa de emissão com a habilitação fora de active, certificado revogado, condição operacional fora do escopo aprovado ou divergência entre o grupo de assinantes e o titular do certificado — serão adicionados ao mesmo catálogo quando os endpoints ASG forem publicados.