Consignado Público: Entes Consignantes
Esta é a página de referência dos entes consignantes atendidos pelo Consignado Público: quais existem, como nomeá-los nas rotas, qual perfil de consignação cada um usa e o que cada um exige de diferente. As demais páginas desta seção — e o Manual Cartão Consignado, na fonte public_payroll — apontam para as âncoras daqui.
Os enumeradores de ente e de esfera ainda estão em definição e podem mudar até o lançamento.
Entes atendidos
| Ente | consignment_entity | entity_level | Quem atende | Perfil | |
|---|---|---|---|---|---|
| Governo do Estado de São Paulo | sp | state | Servidores estaduais de São Paulo, ativos e inativos | Perfil 1 | |
| Município de S ão Paulo | sao_paulo_sp | municipal | Servidores municipais de São Paulo | Perfil 1 | Em desenvolvimento |
O par (entity_level, consignment_entity) identifica o ente em toda a API:
POST /public_payroll/state/sp/balance_inquiry
Perfis de consignação
Cada ente mantém a sua folha em uma plataforma de consignação, e as plataformas diferem em três coisas: como identificam o servidor, como informam a margem e quais enumeradores usam. O conjunto dessas três é o que chamamos de perfil.
Entes na mesma plataforma compartilham o perfil e, portanto, os mesmos payloads — o perfil é documentado uma vez, aqui, e a tabela de entes diz qual perfil cada ente usa.
- Perfil 1
O servidor é identificado pelo órgão em que trabalha e pela matrícula que tem nesse órgão. A margem é apurada por cargo e consolidada no nível da matrícula.
Identificação do servidor
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| agency | string | Enumerador do órgão do servidor — a unidade pagadora dentro do ente: secretaria, autarquia, instituto de previdência | Sim |
| registration_number | string | Matrícula do servidor no órgão. Um mesmo CPF pode ter mais de uma | Sim |
{
"employment_relationship": {
"agency": "spprev",
"registration_number": "1234567890123"
}
}
Os dois valores vêm da Consulta de Margem.
A averbação é registrada no nível da matrícula, e o órgão é o que determina o calendário de folha e os limites comerciais da operação.
Estrutura da margem
Abaixo da matrícula existe o provimento: cada cargo concorrente que o servidor ocupa sob a mesma matrícula. A margem é apurada por provimento e por produto — o "balde" de margem que cada tipo de operação consome.
A consulta entrega a margem já consolidada no nível da matrícula, aplicando a regra do ente: somar os provimentos, ou considerar apenas o maior. A regra usada vem no campo rule. Os valores por provimento ficam disponíveis sob demanda, com expand=appointments.
Enumeradores deste perfil
Particularidades por ente
- São Paulo (Estado)
- São Paulo (Município)
| Item | Valor |
|---|---|
consignment_entity | sp |
entity_level | state |
| Perfil | Perfil 1 |
| Regra de margem entre provimentos | Maior provimento — os provimentos não somam |
| Aprovação do servidor | Obrigatória em toda averbação nova |
Aprovação do servidor
Desde 01.05.2026, o Governo do Estado de São Paulo exige que o próprio servidor aprove cada nova averbação no aplicativo do ente, com validação biométrica. A aprovação acontece depois que a averbação é registrada e vale até o fim do mesmo dia: o que não for aprovado nesse prazo é cancelado pelo ente por decurso de prazo.
Duas consequências para a integração:
- A averbação passa por um período de confirmação antes de ser considerada efetiva. Ver Confirmação.
- Averbações enviadas perto do fim do dia são retidas pela QI Tech e submetidas na janela seguinte, para não nascerem sem tempo hábil de aprovação.
Margem entre provimentos
Quando um servidor tem mais de um provimento na mesma matrícula, a margem considerada é a do maior provimento, não a soma. A Consulta de Margem já entrega o valor consolidado com essa regra aplicada, e informa no campo rule qual regra usou.
Órgãos
O enumerador do órgão é o valor enviado em agency.
| Órgão | agency | Calendário de folha |
|---|---|---|
| São Paulo Previdência | spprev | Em construção |
| Demais órgãos | Em construção | Em construção |
Os exemplos desta seção usam spprev.
Tipos de reserva e produtos
Cada tipo de reserva oferecido pelo ente consome a margem de um produto.
| Tipo de reserva | Produto |
|---|---|
payroll_card | credit_card (2) |
benefit_card | Em construção |
payroll_loan | Em construção |
Canais de autorização
Valores aceitos em authorization.channel na consulta de margem.
channel | Onde a anuência é colhida |
|---|---|
| Em construção | Em construção |
Limites comerciais
Prazo máximo e carência máxima da operação são definidos por órgão e por tipo de reserva. Para o cartão consignado, o Manual Cartão Consignado descreve como esses limites são aplicados na contratação.
Em desenvolvimento. Órgãos, tipos de reserva, produtos e canais de autorização deste ente são publicados aqui quando ele for habilitado.