Roteiro de Homologação - FGTS
*: etapas obrigatórias para entrada em produção
1 - Cadastro e Autenticação API LaaS
| 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) | https://sandbox.qitech.com.br/register | |
| 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 |
Atenção
O item 1 é um passo obrigatório para todos os itens posteriores.
2 - Upload de documentos
| Nº | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| UPL0001* | Upload de documentos | Gerar chave identificadora do documento dentro da QI Tech | Link Documentação | CAB0004 |
3 - Consulta de saldo do cliente
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| ABS0001* | Consultar saldo disponível | Realização da consulta de saldo do cliente, busca dos valores disponíveis para saque do cliente | Link Documentação | CAB0004 e CAB0005 |
| ABS0002* | Webhook de consulta de saldo | Leitura da resposta assíncrona da consulta de saldo. Webhook available_balance | Link Documentação | ABS0001 |
| ABS0003* | Simulação do cenário de sucesso e insucesso na consulta de saldo | Teste de sucesso (retorno de períodos com valores nas parcelas) e teste de insucesso (retorno de erro e períodos vazios). | Link Documentação | ABS0001 e ABS0002 |
| ABS0004* | Acompanhamento e ações em relação à consulta de saldo | A resposta da consulta deve desencadear uma ação por parte do correspondente, de forma a orientar o cliente assertivamente e evitar o acúmulo de requsições perdidas em nossas filas. | Link Documentação | ABS0003 |
4 - Simulação de dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| SID0001* | Simulação de valor máximo | Simulação das condições da dívida, utilizando todos os valores dos períodos disponíveis para saque | Link Documentação | ABS0002 |
| SIM0002* | Simulação de valor desejado | Simulação das condições da dívida, utilizando um valor alvo. Dessa forma, retornaremos os valores dos períodos que serão utilizados para se obter o valor desejado. | Link Documentação | ABS0002 |
5 - Emissão de dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| EMD0001* | Emissão de dívida | Emissão da CCB. Formada por quatro objetos principais: dados cadastrais do devedor (objeto borrower), dados financeiros da operação (objeto financial), dados de garantia (collaterals, parcelas retornadas na consulta de saldo) e dados bancários para pagamento (disbursement_bank_account.) | Link Documentação | SID0001 ou SIM0002 |
6 - Formalização de dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| FOR0001* | Formalização da dívida | A assinatura da CCB será disparada automaticamente do lado da QI SCD via QI Sign, após a emissão da dívida | -- | EMD0001 |
| FOR0002* | Leitura do webhook de assinatura finalizada | Leitura da resposta assíncrona da formalização da operação. Webhook status signature_finished | Link Documentação | FOR0001 |
7 - Averbação e desaverbação
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| COL0001* | Leitura do webhook de collateral constituído | Leitura da resposta assíncrona que indica a averbação do saldo do cliente. Webhook credit_operation.collateral | Link Documentação | |
| COL0002* | Simulação dos cenários de sucesso e insucesso na averbação do saldo de um cliente. | Temos um mock de casos de insucesso para serem testados, eles usam uma lógica aplicada aos primeiros números do documento do tomador em sandbox | Link Documentação | |
| COL0003* | Acompanhamento e mapeamento dos status das reservas | O objeto "last_response" traz os dados da última tentativa de reserva ou liberação (averbação ou desaverbação) realizada pela QI na Caixa. | Link Documentação |
8 - Pagamento da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| PAG0001* | Escolha da data de desembolso | Após o cumprimento de todos os requisitos para pagamento da operação (envio de documentos, assinatura e averbação), deve-se obrigatoriamente escolher uma data de desembolso para que a operação seja paga, dentro do range de desembolso. | Link Documentação | |
| PAG0002* | Leitura do webhook de desembolso da operação | Leitura da resposta assíncrona que indica o pagamento da operação. Webhook disbursed. Aqui teremos o comprovante de pagamento em PDF. | Link Documentação |
9 - Reapresentação da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| PAG0001* | Alteração/atualização da data de desembolso | A escolha da data de desembolso, é um requisito para pagamento da operação. Quando uma operação está cancelada, a atualização da data de desembolso faz com que a operação volte ao status que estava antes do cancelamento. | Link Documentação | |
| PAG0002* | Alteração dos dados bancários | Mudança dos dados para pagamento da operação. Essa alteração não altera a CCB, mas a QI como emissor da dívida, garante o pagamento para uma conta de mesma titularidade do devedor. | Link Documentação |
10 - Cancelamento da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| CAN0001* | Cancelamento permanente da operação | Permite a Instituição Fiduciária realizar, junto ao Agente Operador do FGTS, o cancelamento de uma reserva de valores de saque aniversário do Trabalhador utilizados como garantia para uma operação fiduciária. Além de colocar um status final na operação. | Link Documentação | |
| CAN0002* | Leitura do webhook de cancelamento permanente | Permite a Instituição Fiduciária realizar, junto ao Agente Operador do FGTS, o cancelamento de uma reserva de valores de saque aniversário do Trabalhador utilizados como garantia para uma operação fiduciária. Além de colocar um status final na operação. | Link Documentação |