Consignado Público: Visão Geral
Consignado Público é a consignação em folha de servidores públicos estaduais e municipais. O ente consignante — o estado ou o município que paga a folha — mantém o registro da margem consignável de cada servidor, e é nele que a QI Tech reserva a parcela mensal que garante a operação.
Esta seção documenta um produto em construção. As páginas marcadas como em desenvolvimento ainda não têm conteúdo, e o que já está publicado pode mudar até o lançamento.
O cartão consignado de servidor público é contratado pelo Manual Cartão Consignado, na fonte public_payroll — esta seção contém a referência de margem, entes e averbação que aquele manual consulta. Além disso, o fluxo de averbação do crédito consignado sem ser de cartão se encontra aqui.
Como uma operação é endereçada
Uma operação de Consignado Público é endereçada em dois passos.
A rota nomeia o ente. A esfera — state ou municipal — e o enumerador do ente são os dois primeiros segmentos:
/public_payroll/{entity_level}/{consignment_entity}/...
O corpo identifica o servidor. Quais campos fazem isso depende do ente: cada ente mantém a sua folha em uma plataforma de consignação, e as plataformas não identificam o servidor da mesma forma. Umas exigem o órgão pagador, outras uma senha do servidor, outras apenas a matrícula.
É por isso que a seção trabalha com perfis de consignação. Ver Perfis de consignação e, para os campos de cada perfil, Entes Consignantes.
Perfis de consignação
Um perfil é o conjunto do que varia entre plataformas de consignação:
- Como o servidor é identificado — quais campos o corpo precisa carregar.
- Como a margem é informada — a estrutura do documento de consulta, e se ele detalha a margem por cargo, por produto ou em um valor único.
- Quais enumeradores valem — produtos, situações de margem, tipos de vínculo e motivos de recusa são definidos pela plataforma, não pela QI Tech.
Entes na mesma plataforma compartilham um perfil, e portanto compartilham exatamente os mesmos payloads. Cada perfil é documentado uma vez; a tabela de entes diz qual perfil cada ente usa.
A jornada de uma contratação
- Consulta de margem — descobre os vínculos do CPF no ente e a margem disponível em cada um. Assíncrona. Ver Consulta de Margem.
- Simulação — calcula as condições da operação a partir da margem. Em desenvolvimento.
- Emissão — cria a operação e o instrumento de crédito. Em desenvolvimento.
- Formalização — assinatura e documentos do servidor. Em desenvolvimento.
- Averbação — reserva a margem no ente. É a etapa que pode falhar por margem insuficiente e, em alguns entes, depende da aprovação do próprio servidor. Ver Reserva de Margem.
- Desembolso — liberação do valor contratado. Em desenvolvimento.
Cada mudança de status é notificada por webhook. Ver Webhooks.
Conteúdo desta seção
| Página | Conteúdo | |
|---|---|---|
| Entes Consignantes | Entes atendidos, perfis de consignação e particularidades de cada ente | |
| Consulta de Margem | Descoberta de vínculos e margem disponível | |
| Reserva de Margem | Acompanhamento da averbação, cancelamento e comprovante | |
| Crédito Novo | Simulação, emissão e formalização | Em desenvolvimento |
| Portabilidade | Transferência de operação de outra instituição | Em desenvolvimento |
| Refinanciamento | Renegociação de operação ativa | Em desenvolvimento |
| Webhooks | Notificações de mudança de status | |
| Enumeradores | Status, motivos, produtos e tipos de reserva |
Glossário
| Termo | Significado |
|---|---|
Ente consignante (consignment_entity) | O governo estadual ou municipal que paga a folha e mantém o registro de margem consignável. |
| Vínculo | A relação do servidor com o ente que sustenta a consignação. Como ele é identificado depende do perfil do ente. |
| Margem consignável | Valor mensal do salário ou provento que pode ser comprometido com consignações. |
| Averbação | Registro da operação no ente, que reserva a margem e ordena o desconto em folha. |
| Desaverbação | Remoção de uma averbação existente, liberando a margem. |
Consulta de margem (balance_inquiry) | Pergunta ao ente sobre os vínculos e a margem de um CPF. O resultado é uma fotografia, com validade no mês da observação. |
| Perfil de consignação | O que varia entre plataformas de consignação: identificação do servidor, estrutura do documento de margem e enumeradores. |
Comprovante (protocol) | Recibo que prova que uma averbação ou desaverbação foi executada no ente. |