Pular para o conteúdo principal

Manual de Garantia Veicular

API em desenvolvimento

A API ainda está em fase de desenvolvimento, sendo assim, este manual está sujeito a alterações.

Atenção!

Os webhooks da QI Tech não devem ser mapeados de forma estrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

É possível consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Este manual descreve o fluxo completo de uma operação de crédito com garantia veicular (gravame). O registro de gravame no SNG/B3, o registro do contrato no DETRAN/Registradora, o envio de imagem e o cancelamento são realizados internamente pela QI Tech. O processo é acompanhado via endpoints de consulta (GET) e webhooks.

Pré-requisitos​

  1. Possuir credenciais de acesso à API QI Tech (veja Primeiros Passos);
  2. Ter concluído a homologação em ambiente sandbox;
  3. Veículo deve possuir informações válidas de chassi, RENAVAM (quando já emplacado) e UF de licenciamento.

Visão Geral do Fluxo​

  1. Simular — Envie POST /debt_simulation com collateral_type: "vehicle" (ver Simulação e Emissão);
  2. Criar a operação — Envie POST /debt incluindo os dados do veículo no objeto collaterals (ver Simulação e Emissão);
  3. QI Tech registra o gravame — Após a assinatura do contrato, a QI Tech envia automaticamente a inclusão de gravame ao SNG/B3. Webhooks enviados: pending_reservation_confirmation → reserved;
  4. Desembolso — Após a confirmação do gravame (reserved), a QI Tech realiza o desembolso (transferência de recursos) para a conta informada;
  5. QI Tech registra o contrato — A QI Tech envia automaticamente o registro de contrato ao DETRAN/Registradora. Webhooks enviados: pending_registration_confirmation → registered;
  6. QI Tech envia a imagem do contrato — A QI Tech realiza o envio da imagem ao DETRAN/Registradora;
  7. Acompanhar o progresso — Consulte a reserva (gravame) e registro (contrato) a qualquer momento via endpoints GET (ver Consultas);
  8. Receber notificações — Os webhooks de gravame usam o tipo laas.vehicle_collateral.reservation.status_change (SNG/B3) e os de contrato usam laas.vehicle_collateral.contract.status_change (DETRAN) (ver Webhooks).
URLs Base

Homologação: Fornecida pela QI Tech durante o onboarding.
Produção: Fornecida pela QI Tech após homologação.

Códigos HTTP

200 = Sucesso · 201 = Criado · 400 = Falha na validação (ver body) · 401 = Não autorizado · 403 = Requisição indevida · 404 = Não encontrado · 500 = Erro interno