Consignado do Exército — Introdução
API para originação de CCB consignado para militares do Exército Brasileiro (ativos, inativos e pensionistas). A reserva de margem é feita via Zetra (eConsig) e o ciclo todo — consulta de margem, emissão, averbação, desembolso e cancelamento — passa por essa plataforma.
| Item | Valor |
|---|---|
| Autoridade pagadora | Exército Brasileiro / Zetra (eConsig) |
Tipo de garantia (collateral_type) | military_payroll |
| Modelo de reserva | Averbação (assíncrona, consentida via documento de autorização) |
| Funcionamento | 24h por dia, todos os dias, inclusive feriados |
| Modalidades suportadas | Margem Livre (Crédito Novo) e Portabilidade + Refinanciamento |
| Token | Obrigatório na consulta de margem (senha do sistema militar) |
| Instrumento | CCB (via POST /debt) |
Os webhooks da QI Tech não devem ser mapeados de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.
Fluxo End-to-End
Em margem livre o desembolso vai direto pra conta externa do militar. Em refinanciamento, portabilidade e compra de dívida o desembolso vai pra uma conta interna em nome do militar (aberta pelo parceiro via POST /account) — daí a QI quita o contrato externo, repassa o troco e faz a conciliação. Ver Conta Interna para Desembolso.
Modalidades
A operação se divide em quatro modalidades, escolhidas no operation_type e collateral_data:
| Modalidade | operation_type / reservation_type | Quando usar | Doc |
|---|---|---|---|
| Margem Livre (Crédito Novo) | operation_type: structured_operation / reservation_type: new_credit | Militar com margem disponível; sem dívida externa nem refin de operação ativa | → Margem Livre |
| Refinanciamento | operation_type: refinancing / reservation_type: refinancing + operation_key | Renegociar operação QI ativa (prazo/taxa), eventualmente liberando troco | → Port + Refin |
| Portabilidade (com ou sem troco) | operation_type: refinancing / reservation_type: refinancing + original_contract_number | Trazer dívida de outro banco; pode incluir troco | → Port + Refin |
| Compra de dívida (port enrustida) | operation_type: debt_purchase + operation_type: refinancing (dupla) | Trazer N dívidas externas; QI emite uma dupla debt_purchase + refinancing por contrato externo, com desembolso em conta interna em nome do militar | → Port + Refin |
Pré-requisitos
Antes de qualquer requisição (Consulta, Emissão, etc):
- Upload do consentimento do militar via
POST /upload→ retornadocument_key. Ver Upload de Documentos. - Conhecer o token (senha do sistema militar Zetra) do borrower — é obrigatório no payload de
POST /military_payroll/balance.
Referência por área
- Consulta de Margem — endpoint
/military_payroll/balance+ token Zetra - Margem Livre — Simulação + Emissão para
new_credit - Portabilidade + Refinanciamento — Simulação + Emissão para
refinancing+ payloads de compra de dívida (debt_purchase+refinancingport-enrustido) - Formalização — 5 modelos: QI Sign, PDF, opt-in, zip, selfie
- Conta Interna para Desembolso — POST
/accountem nome do militar + uso em compra de dívida + ações pós-desembolso - Assinatura em Lote — agrupar várias operações num único envelope QI Sign (
POST /document/document_batch) - Cancelamento, Desaverbação e Reversal — pré + pós-desembolso + reversal automático
- Webhooks — todos os eventos assíncronos + payloads
- Mapa de Status — enumeradores consolidados
- Mocks (Sandbox) — dados de teste e cenários end-to-end