Roteiro de Homologação Consignado Privado - BOTPAG
*: etapas obrigatórias para entrada em produção
1 - Cadastro e Autenticação APIs 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 |
2- Simulação da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| SID0001* | Simulação de dívida | Simulação das condições da dívida, utilizando variáveis previamente determinadas | Link Documentação | Item 1 |
3 - Emissão de dívida PF
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| EMD0001* | Emissão de dívida Pessoa Física | Emissão da CCB PF. Formada por quatro objetos principais: dados cadastrais do devedor (objeto borrower), dados financeiros da operação (objeto financial), dados bancários para pagamento (disbursement_bank_account) e indicação do cessionário (purchaser_document_number). É essencial o envio de múltiplas datas de desembolso. | Link Documentação | Itens 1 e 2 |
4 - 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 | -- | Item 3 |
| 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 |
5 - Desembolso da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| DES0001* | 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 | Item 4 |
| DES0002* | Leitura do webhook de desembolso da operação | Leitura da resposta assíncrona que indica o sucesso no pagamento da operação. Webhook status: disbursed. Aqui teremos o comprovante de pagamento em PDF. Além do retorno das chaves identificadoras das parcelas e seus respectivos boletos | Link Documentação | DES0001 |
6 - Parcelas da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| INS0001* | Leitura do webhook de parcelas | Leitura da resposta assíncrona que indica a atualização de status das parcelas da dívida. Aqui temos webhook_type: installment.status_change. Webhook status: opened, paid, waiting_payment, paid_early, paid_partial, overdue, paid_partial_overdue e paid_overdue. | Link Documentação | DES0002 |
7 - Reapresentação da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| PAG0001* | Alteração/atualização da data de desembolso | Quando uma operação está cancelada, a atualização da data de desembolso faz com que a operação volte ao status anterior ao cancelamento. | Link Documentação | Item 5 |
| PAG0002* | Alteração dos dados bancários | Mudança dos dados para pagamento da operação, obrigatório um conta de mesma titularidade do devedor | Link Documentação | PAG0001. Obrigatório, caso exista retentativa |
8 - Cancelamento da operação
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| CAN0002* | Cancelamento permanente da dívida antes do desembolso | Permite o cancelamento definitivo (status final) da dívida antes do pagamento | Link Documentação | EMD0001 |
| CAN0003* | Leitura do webhook de cancelamento | Leitura da resposta assíncrona do cancelamento da operação. Webhook status: canceled | Link Documentação | CAN0002 |
| CAN0004 | Cancelamento de dívida em até sete dias após o desembolso | Considerando que o tomador do crédito pode realizar o cancelamento da dívida em até 7 dias do desembolso, é possível que ele faça um chargeback do PIX recebido ou paga um QR Code de devolução | Link Documentação | DES0002 |
9 - Boletos da dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| BKS0001 | Solicitar 2ª via de boleto | Emissão de segunda via de boleto, através da chave identificadora do boleto (bank_slip_key), retornada no webhook de desembolso | Link Documentação | DES0002 |
10 - Renegociação de dívida
| Código | Etapa | Descrição | Link | Pré-requisito |
|---|---|---|---|---|
| REN0001 | Simulação de uma renegociação | Permite a simulação parcial ou total de uma renegociação | Link Documentação | DES0002 |
| REN0002 | Criar uma renegociação | Permite a criação de uma renegociação parcial ou total (geração de um boleto de antecipação para pagamentos de parcelas) | Link Documentação | DES0002 |
| REN0003 | Consultar uma renegociação | Verificar as condições de uma renegociação, parcelas que foram afetadas, dados financeiros, vencimento e tipo de pagamento | Link Documentação | REN0002 |
| REN0004 | Listar Renegociações | Verificar uma listagem das condições de mais de uma renegociação | Link Documentação | REN0002 |
| REN0005 | Cancelar uma renegociação | Efetuar o cancelamento de uma renegociação | Link Documentação | REN0002 |
| REN0006 | Pagamento de uma renegociação | Webhooks de atualização de status de uma renegociação. Webhook_type: renegotiation.proposal | Link Documentação | REN0002 |