Pular para o conteúdo principal

Roteiro de Homologação Vivo - Empréstimo Pessoal e Buy Now Pay Later

*: etapas obrigatórias para entrada em produção

1 - Cadastro e Autenticação APIs LaaS​

CódigoEtapaDescriçãoLink DocumentaçãoPré-requisito
CAB0001*Cadastro no ambiente de SandboxRealizar 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 SandboxRealizar a validação do QI Token em SandboxDownload Manual de Inclusão do TokenCAB0001
CAB0003*Troca de chaves públicasRealizar a troca de chaves públicas dentro da plataforma da QI Tech em sandbox (sandbox.qitech.app)Link DocumentaçãoCAB0001 e CAB0002
CAB0004*Teste de autenticação de chamadasFinalizar teste de autenticação de chamadasPasso a Passo

Link Documentação		CAB0003
CAB0005*Configuração de webhooksRealizar 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çãoCAB0001 e CAB0002

2- Simulação da dívida​

CódigoEtapaDescriçãoLinkPré-requisito
SID0001*Simulação de dívidaSimulação das condições da dívida, utilizando variáveis previamente determinadasLink DocumentaçãoItem 1

3 - Emissão de dívida (PF)​

CódigoEtapaDescriçãoLinkPré-requisito
EMD0001*Emissão de dívida PFEmissã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). Para o produto BNPLLink DocumentaçãoItens 1 e 2
EMD0002Implementação de dados adicionaisDados para preenchimento da CCB geradaPayload alinhado em paraleloObrigatório, se definido a utilização.

4 - Formalização de dívida​

CódigoEtapaDescriçãoLinkPré-requisito
FOR0001Formalização da dívidaA assinatura da CCB será via opt-in, com o envio do máximo de evidências possível--Item 3
FOR0002*Leitura do webhook de assinatura finalizadaLeitura da resposta assíncrona da formalização da operação. Webhook status signature_finishedLink DocumentaçãoFOR0001

        Request

ENDPOINT
debt/[DEBT_KEY]/signed
MÉTODO
POST
Request Body
{
    "type": "data-signature",
    "signatures": [
        {
            "signed_object": {
                "raw_text": "Lorem ipsum dolor sit amet, consectetur a...."
            },
            "authenticity": {
                "timestamp": "2024-07-31T19:56:27",
                "ip_address": "192.168.1.22",
                "fingerprint": {
                    "lat": "-23.6698999",
                    "long": "-46.5401819",
                    "name": "Andre 1",
                    "model": "Chrome",
                    "localeHashValue": "hash cliente"
                },
                "session_id": "7edd8a8b-e25a-49ce-8fc3-593dc5984dd9",
                "signer": {
                    "name": "TESTE DE SENA LIMA",
                    "email": "teste2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "61766976204"
                },
                "authentication_type": "selfie"
            }
        }
    ]
}

        Response

MÉTODO
POST
ENDPOINT
debt/[DEBT_KEY]/signed
Response Body
{
  "data": {},
  "event_datetime": "2023-01-17 17:17:28",
  "key": "4630cd58-ab00-49b3-b8cb-cb0f4a5af7a4",
  "status": "signature_received",
  "webhook_type": "debt"
}

5 - Desembolso da dívida​

CódigoEtapaDescriçãoLinkPré-requisito
DES0001*Leitura do webhook de desembolso da operaçãoLeitura 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 boletosLink Documentaçãoitem 4

6 - Reapresentação da dívida​

CódigoEtapaDescriçãoLinkPré-requisito
PAG0001Alteração/atualização da data de desembolsoQuando 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çãoItem 5
PAG0002Alteração dos dados bancáriosMudança dos dados para pagamento da operação, obrigatório um conta de mesma titularidade do devedorLink DocumentaçãoPAG0001. Obrigatório, caso exista retentativa

8 - Cancelamento da operação​

CódigoEtapaDescriçãoLinkPré-requisito
CAN0002*Cancelamento da dívida antes do desembolsoPermite o cancelamento da dívida antes do pagamentoLink DocumentaçãoEMD0001
CAN0003*Leitura do webhook de cancelamentoLeitura da resposta assíncrona do cancelamento da operação. Webhook status: canceledLink DocumentaçãoCAN0002
CAN0004Cancelamento de dívida em até sete dias após o desembolsoConsiderando 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çãoLink DocumentaçãoDES0002

9 - Boletos da dívida​

CódigoEtapaDescriçãoLinkPré-requisito
BKS0001Webhook de confirmação de emissão de boletosEmissão de segunda via de boleto, através da chave identificadora do boleto (bank_slip_key), retornada no webhook de desembolsoLink DocumentaçãoDES0002
BKS0002Solicitar 2ª via de boletoEmissão de segunda via de boleto, através da chave identificadora do boleto (bank_slip_key), retornada no webhook de desembolsoLink DocumentaçãoDES0002

10 - Renegociação de dívida​

CódigoEtapaDescriçãoLinkPré-requisito
REN0001Simulação de uma renegociaçãoPermite a simulação parcial ou total de uma renegociaçãoLink DocumentaçãoDES0002
REN0002Criar uma renegociaçãoPermite a criação de uma renegociação parcial ou total (geração de um boleto de antecipação para pagamentos de parcelas)Link DocumentaçãoDES0002
REN0003Consultar uma renegociaçãoVerificar as condições de uma renegociação, parcelas que foram afetadas, dados financeiros, vencimento e tipo de pagamentoLink DocumentaçãoREN0002
REN0004Listar RenegociaçõesVerificar uma listagem das condições de mais de uma renegociaçãoLink DocumentaçãoREN0002
REN0005Cancelar uma renegociaçãoEfetuar o cancelamento de uma renegociaçãoLink DocumentaçãoREN0002
REN0006Pagamento de uma renegociaçãoWebhooks de atualização de status de uma renegociação. Webhook_type: renegotiation.proposalLink DocumentaçãoREN0002