0% acharam este documento útil (0 voto)

114 visualizações151 páginas

ManualWebServiceverso2020 Cleaned

1. O documento descreve as operações disponíveis em um web service para gestão da margem consignável de servidores. 2. Fornece detalhes sobre 15 operações como consultar autorizações, iniciar contrato, renovar contrato e alterar valores. 3. Inclui parâmetros de entrada e saída, exemplos de requisições SOAP e listas de erros possíveis para cada operação.

Enviado por

mausien

Direitos autorais

Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.

Formatos disponíveis

Baixe no formato PDF, TXT ou leia on-line no Scribd

0% acharam este documento útil (0 voto)

114 visualizações151 páginas

ManualWebServiceverso2020 Cleaned

Enviado por

mausien

Direitos autorais

Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.

Formatos disponíveis

Baixe no formato PDF, TXT ou leia on-line no Scribd

Você está na página 1/ 151

Gestão de Margem Consignável do

Servidor
Web Service

Atualizado em 07/12/19
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

07/12/19 – Alterações realizadas:

1 - Retirado o parâmetro de entrada “emailsParaNotifiaiaoAnneniia” da

operação “inilnirContratoPortabilidade”.

2 - Alteração da obrigatoriedade dos parâmetros “nrlAieite” e “nrlReinsa” de

OBRIGATÓRIO para NÃO OBRIGATÓRIO na operação “renovarContratoV2”.

3 - Adiiionado o parâmetro de saída “dtValidadeAnneniia” na operação

“ionsnltarContrato”.

2
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Sumário
1. Introdnção..................................................................................................................... 1
2. Criação de VPN.............................................................................................................. 1
3. Integração..................................................................................................................... 1
4. Operações Disponíveis.................................................................................................. 3
4.1. Legenda.................................................................................................................. 4
4.2. Tipos Personalizados............................................................................................... 5
4.3. Annêniia do Servidor on Pensionista......................................................................6
4.4. Operação ionsnltarAntorizaioesMargemConsignavel (Disponível na Versão V2)...7
4.4.1. Parâmetros de Entrada.................................................................................... 7
4.4.2. Parâmetros de Saída........................................................................................ 8
4.4.3. Lista de erros................................................................................................. 11
4.4.4. Exemplo de Reqnisição SOAP........................................................................11
4.5. Operação inilnirContratoV2 (Disponível na Versão V2)........................................23
4.5.1. Parâmetros de Entrada..................................................................................24
4.5.2. Parâmetros de Saída...................................................................................... 26
4.5.3. Lista de erros................................................................................................. 27
4.5.4. Exemplo de Reqnisição SOAP........................................................................29
4.6. Operação inilnirContratoPortabilidade (Disponível na Versão V2).......................33
4.6.1. Parâmetros de Entrada..................................................................................33
4.6.2. Parâmetros de Saída...................................................................................... 35
4.6.3. Lista de erros................................................................................................. 35
4.6.4. Exemplo de Reqnisição SOAP........................................................................37
4.7. Operação alterarContrato (Disponível na Versão V2)...........................................39
4.7.1. Parâmetros de Entrada..................................................................................40
4.7.2. Parâmetros de Saída...................................................................................... 42
4.7.3. Lista de erros................................................................................................. 42
4.7.4. Exemplo de Reqnisição SOAP........................................................................44
4.8. Operação renovarContratoV2 (Disponível na Versão V2).....................................47
4.8.1. Parâmetros de Entrada..................................................................................48
4.8.2. Parâmetros de Saída...................................................................................... 50
4.8.3. Lista de erros................................................................................................. 50
4.8.4. Exemplo de Reqnisição SOAP........................................................................52
4.9. Operação ionsnltarAnneniiaContratos (Disponível na Versão V2).......................54
4.9.1. Parâmetros de Entrada..................................................................................54
4.9.2. Parâmetros de Saída...................................................................................... 55
4.9.3. Lista de erros................................................................................................. 56
4.9.4. Exemplo de Reqnisição SOAP........................................................................56
4.10. Operação ionsnltarContrato (Disponível na Versão V2).....................................58
4.10.1. Parâmetros de Entrada................................................................................ 58
4.10.2. Parâmetros de Saída.................................................................................... 59
4.10.3. Lista de erros............................................................................................... 61
4.10.4. Exemplo de Reqnisição SOAP......................................................................62
4.11. Operação ionsnltarVininloMargemPorCPF (Disponível na Versão V1)................72
4.11.1. Parâmetros de Entrada................................................................................ 73
4.11.2. Parâmetros de Saída.................................................................................... 73
4.11.3. Lista de erros herdados da Consist..............................................................74
4.11.4. Lista de novos erros..................................................................................... 75
4.11.5. Exemplo de Reqnisição SOAP......................................................................75
4.12. Operação ionsnltarMargemPorCPF (Disponível na Versão V1)...........................76

3
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.12.1. Parâmetros de Entrada................................................................................ 77

4.12.2. Parâmetros de Saída.................................................................................... 77
4.12.3. Lista de erros herdados da Consist..............................................................78
4.12.4. Lista de novos erros..................................................................................... 79
4.12.5. Exemplo de Reqnisição SOAP......................................................................79
4.13. Operação ionsnltarVininloMargemPorCPFV1 (Disponível na Versão V1)...........81
4.13.1. Parâmetros de Entrada................................................................................ 81
4.13.2. Parâmetros de Saída.................................................................................... 82
4.13.3. Lista de erros herdados da Consist..............................................................83
4.13.4. Lista de novos erros..................................................................................... 84
4.13.5. Exemplo de Reqnisição SOAP......................................................................84
4.14. Operação ionsnltarMargemPorCPFV1 (Disponível na Versão V1).......................85
4.14.1. Parâmetros de Entrada................................................................................ 86
4.14.2. Parâmetros de Saída.................................................................................... 86
4.14.3. Lista de erros herdados da Consist..............................................................88
4.14.4. Lista de novos erros..................................................................................... 88
4.14.5. Exemplo de Reqnisição SOAP......................................................................89
4.15. Operação alterarValorPariela (Disponível na Versão V1)...................................90
4.15.1. Parâmetros de Entrada................................................................................ 91
4.15.2. Parâmetros de Saída.................................................................................... 92
4.15.3. Lista de erros herdados da Consist..............................................................92
4.15.4. Lista de novos erros..................................................................................... 93
4.15.5. Exemplo de Reqnisição SOAP......................................................................94
4.16. Operação alterarValorPrazoParielaV1 (Disponível na Versão V1).......................95
4.16.1. Parâmetros de Entrada................................................................................ 96
4.16.2. Parâmetros de Saída.................................................................................... 96
4.16.3. Lista de erros herdados da Consist..............................................................97
4.16.4. Lista de novos erros..................................................................................... 98
4.16.5. Exemplo de Reqnisição SOAP......................................................................98
4.17. Operação ianielarContrato (Disponível nas Versões V1 e V2).........................100
4.17.1. Parâmetros de Entrada.............................................................................. 100
4.17.2. Parâmetros de Saída.................................................................................. 101
4.17.3. Lista de erros herdados da Consist............................................................101
4.17.4. Lista de novos erros................................................................................... 102
4.17.5. Exemplo de Reqnisição SOAP....................................................................102
4.18. Operações ionsnltarContratosPorFnniionario e
ionsnltarContratosPorFnniionarioV1 (Disponíveis nas Versões V1 e V2)...................104
4.18.1. Parâmetros de Entrada.............................................................................. 104
4.18.2. Parâmetros de Saída.................................................................................. 104
4.18.3. Lista de erros herdados da Consist............................................................105
4.18.4. Lista de novos erros................................................................................... 106
4.18.5. Exemplo de Reqnisição SOAP....................................................................106
4.19. Operação enierrarContrato (Disponível nas Versões V1 e V2).........................113
4.19.1. Parâmetros de Entrada.............................................................................. 113
4.19.2. Parâmetros de Saída.................................................................................. 113
4.19.3. Lista de erros herdados da Consist............................................................114
4.19.4. Lista de novos erros................................................................................... 114
4.19.5. Exemplo de Reqnisição SOAP....................................................................115
4.20. Operações inilnirContrato e inilnirContratoV1 (Disponíveis na Versão V1)......116
4.20.1. Parâmetros de Entrada.............................................................................. 116
4.20.2. Parâmetros de Saída.................................................................................. 117
4.20.3. Lista de erros herdados da Consist............................................................118
4.20.4. Lista de novos erros................................................................................... 119

4
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.20.5. Exemplo de Reqnisição SOAP....................................................................120

4.21. Operação renovarContratoCPFV1 (Disponível na Versão V1)............................124
4.21.1. Parâmetros de Entrada.............................................................................. 124
4.21.2. Parâmetros de Saída.................................................................................. 125
4.21.3. Lista de erros herdados da Consist............................................................126
4.21.4. Lista de novos erros................................................................................... 127
4.21.5. Exemplo de Reqnisição SOAP....................................................................128
4.22. Operação renovarContratoV1 (Disponível na Versão V1).................................130
4.22.1. Parâmetros de Entrada.............................................................................. 130
4.22.2. Parâmetros de Saída.................................................................................. 131
4.22.3. Lista de erros herdados da Consist............................................................132
4.22.4. Lista de novos erros................................................................................... 133
4.22.5. Exemplo de Reqnisição SOAP....................................................................134
4.23. Operação ianielarAntorizaiaoCartao (Disponível nas Versões V1 e V2)..........136
4.23.1. Parâmetros de Entrada.............................................................................. 136
4.23.2. Parâmetros de Saída.................................................................................. 136
4.23.3. Lista de erros............................................................................................. 136
4.23.4. Exemplo de Reqnisição SOAP....................................................................137
4.24. Operação ianielarAntorizaiaoCartaoV1 (Disponível nas Versões V1 e V2)......138
4.24.1. Parâmetros de Entrada.............................................................................. 138
4.24.2. Parâmetros de Saída.................................................................................. 138
4.24.3. Lista de erros............................................................................................. 139
4.24.4. Exemplo de Reqnisição SOAP....................................................................139
4.25. Operação ionsnltarVininlosFnniionais (Disponível nas Versões V1 e V2)........140
4.25.1. Parâmetros de Entrada.............................................................................. 140
4.25.2. Parâmetros de Saída.................................................................................. 141
4.25.3. Exemplo de Reqnisição SOAP....................................................................141
4.25.4. Lista de erros............................................................................................. 143
4.26. Lista de todos os erros herdados da Consist.....................................................144
4.27. Lista de todos os erros novos...........................................................................145

5
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

1. Introdução

Este documento tem por objetivo apresentar orientações/documentações técnicas

para realizar integração entre sistemas de informação de consignatárias e o Sistema de
Gestão de Margem Consignável – SIAPEnet via Web Services. O público-alvo deste
documento são as equipes técnicas de TI das consignatárias que realizarão esta integração.

2. Criação de VPN

Todas as consignatárias que desejarem integrar seus respectivos sistemas de

informação ao Sistema de Gestão de Margem Consignável, deverá criar uma VPN com o
SERPRO. E para tanto, se faz necessário o envio dos dados abaixo para o e-mail
consignatarias@serpro.gov.br, com a seguinte descrição no assunto: "[VPN] Informações
para Criação de VPN".
Informar no e-mail:

CNPJ da consignatária;
Razão Social/Nome da consignatária;
Nome completo do representante da consignatária;
Endereço de e-mail do representante da consignatária;
Telefone do representante da consignatária;
Nome completo do representante técnico da consignatária;
Endereço de e-mail do representante técnico da consignatária;
Telefone do representante técnico da consignatária.

3. Integração

A integração ao Sistema de Gestão de Margem Consignável será realizada através

de troca de mensagens XML via Web Service, utilizando o protocolo SOAP (Simple Object
Access Protocol).
A comunicação ocorrerá de forma síncrona, ou seja, toda mensagem SOAP enviada
ao web service será imediatamente processada e o sistema cliente receberá de imediato
uma mensagem de resposta com o resultado deste processamento. Portanto, algumas
operações de manutenção de consignações (inclusão, alteração, etc…) poderão ter efeito
imediato na ficha financeira e na margem consignável do servidor público alvo da ação. As
operações que geram o efeito imediato na ficha financeira dos servidores serão detalhadas
no decorrer deste documento.

1
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Endpoint do Web Service – Ambiente de HOMOLOGAÇÃO:

Versão V2
https://hom5.siapenet.gov.br/wssiapeconsig/consignataria V2

Versão V1 (Descontinuada)
https://hom5.siapenet.gov.br/wssiapeconsig/consignataria

WSDL do Web Service – Ambiente de HOMOLOGAÇÃO:

Versão V2
https://hom5.siapenet.gov.br/wssiapeconsig/consignataria V2?wsdl

Versão V1 (Descontinuada)
https://hom5.siapenet.gov.br/wssiapeconsig/consignataria?wsdl

Endpoint do Web Service – Ambiente de PRODUÇÃO:

Versão V2
https://www5.siapenet.gov.br/wssiapeconsig/consignataria V2

Versão V1 (Descontinuada)
https://www5.siapenet.gov.br/wssiapeconsig/consignataria

WSDL do Web Service – Ambiente de PRODUÇÃO:

Versão V2
https://www5.siapenet.gov.br/wssiapeconsig/consignataria V2?wsdl

Versão V1 (Descontinuada)
https://www5.siapenet.gov.br/wssiapeconsig/consignataria?wsdl

2
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4. Operações Disponíveis

Antes do SERPRO assumir o Sistema de Gestão de Margem Consignável do

Ministério do Planejamento, estas operações, descritas neste tópico, já eram fornecidas pela
antiga empresa prestadora deste serviço (CONSIST). Com a finalidade de causar o menor
impacto possível às consignatárias que já faziam uso destas operações em seus respectivos
sistemas de informação, foram mantidas as mesmas operações e mesmas especificações
de parâmetros de entrada e saída na Versão V1. Posteriormente, foram criadas novas
operações para tratar de evoluções exigidas pelo Ministério da Economia. As novas
operações estão disponíveis na Versão V2 do web service.
As operações disponíveis na Versão V1 são:
• alterarValorParcela;
• alterarValorPrazoParcelaV1;
• cancelarAutorizacaoCartao;
• cancelarAutorizacaoCartaoV1;
• cancelarContrato;
• consultarContratosPorFuncionario;
• consultarContratosPorFuncionarioV1
• consultarMargemPorCPF;
• consultarMargemPorCPFV1;
• consultarVinculoMargemPorCPF;
• consultarVinculoMargemPorCPFV1;
• consultarVinculosFuncionais;
• encerrarContrato;
• incluirContrato;
• incluirContratoV1;
• renovarContratoCPFV1;
• renovarContratoV1.
As operações disponíveis na Versão V2 são (As novas operações estão em
destaque):
• alterarContrato;
• cancelarAutorizacaoCartao;
• cancelarAutorizacaoCartaoV1;
• cancelarContrato;
• consultarContrato;
• consultarContratosPorFuncionario;
• consultarContratosPorFuncionarioV1;

3
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

• consultarAnuenciaContratos;
• consultarAutorizacoesMargemConsignavel;
• encerrarContrato;
• incluirContratoV2;
• incluirContratoPortabilidade;
• renovarContratoV2.
Portanto, as operações “alterarValorParcela”, “alterarValorPrazoParcelaV1”,
“consultarMargemPorCPF”, “consultarMargemPorCPFV1”,
“consultarVinculoMargemPorCPF”, “consultarVinculoMargemPorCPFV1”, “incluirContrato”,
“incluirContratoV1”, “renovarContratoCPFV1” e “renovarContratoV1” foram descontinuadas
na Versão V2.
As operações “cancelarAutorizacaoCartao”, “cancelarAutorizacaoCartaoV1”,
“cancelarContrato”, “consultarContratosPorFuncionario”,
“consultarContratosPorFuncionarioV1” e “encerrarContrato” existentes na Versão V1 foram
mantidas na Versão V2.
Cada uma delas será descrita posteriormente e explicada a diferença entre as
operações que possuem nomes semelhantes.

4.1. Legenda

No detalhamento dos parâmetros de entrada de cada operação do Web Service

existe uma coluna chamada “preenchimento” contendo símbolos para orientar o
preenchimento de cada campo. Segue a relação dos símbolos:

(X) Preenchimento obrigatório.

(O) Preenchimento opcional.

(P) Preenchimento obrigatório para pensionistas e opcional para servidores.

(-) Parâmetro mantido por questões de integridade de interface anterior disponibilizada pela
empresa CONSIST, porém não é utilizado. Informar sempre vazio.

(H) Hold – Preenchimento opcional. Se informado o valor 'S' no campo HOLD, o sistema não
permitirá que nenhuma outra transação afete o valor da margem consignável do servidor
alvo da ação. O tempo parametrizado no sistema atualmente é de 120 segundos, ou seja, o
valor da margem consignável do servidor não sofrerá nenhuma alteração durante esse
tempo. O sistema liberará a margem consignável automaticamente após o tempo
parametrizado ou assim que efetivada alguma transação de manutenção de consignação

4
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

(inclusão, renovação, encerramento, cancelamento) pela mesma consignatária que fez uso
do parâmetro “Hold”.

4.2. Tipos Personalizados

No detalhamento dos parâmetros de entrada e saída de cada operação do Web

Service podem existir tags xml com tipo de domínio personalizado. Segue relação de
possíveis domínios personalizados.

Situação do Servidor:

Código Descrição
01 Normal
02 Desligado
03 Falecido
04 Transferido

Classificação do Vínculo Funcional:

Código Descrição
01 Estável
02 Não estável / Temporário
03 Comissionado

Situação do Contrato:

Código Descrição
03 Ativo
04 Renovado
05 Quitado
06 Encerrado Consignatária
07 Suspenso com Bloqueio de Margem Consignável
08 Suspenso sem Bloqueio de Margem Consignável
09 Portado
10 Aguardando Anuência
11 Anuência Recusada
12 Anuência Expirada
13 Anuência Interrompida por Restrição
14 Aguardando Encerramento do Contrato Portado
15 Portabilidade Cancelada por Prazo
16 Encerrado por Falta de Autorização

5
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Código Identificador do servidor (CIS):

Código Descrição
01 Servidor identificado no momento da operação pela consignatária.
Servidor não identificado no momento da operação, necessário enviar a
02
senha do servidor para consistência.

Código de Origem da transação (COT) para o Código Identificador do servidor (CIS) =

01:

Código Descrição
01 0800 – URA Eletrônica
02 Internet Bank
03 Caixa 24 hs
04 Transação de Caixa
05 Balcão de Agência

Código de Origem da Transação (COT) para o Código Identificador do servidor (CIS) =

02:

Código Descrição
01 0800 com Atendentes.
02 Balcão de agência.
03 Correspondentes Bancários.
99 Outros.

Tipo do Vínculo Funcional

Código Descrição
S Servidor
P Pensionista

4.3. Anuência do Servidor ou Pensionista

Por determinação do Ministério da Economia, as ações de inclusão de um novo

contrato de empréstimo e de renovação de um contrato de empréstimo já existente exigirão
a anuência do servidor ou pensionista, alvo da ação, antes da efetiva averbação do
desconto na ficha financeira.
Para que as instituições financeiras que realizarem estas ações (que exigem a
anuência) ficarem cientes do aceite ou da rejeição do contrato proposto, foram
disponibilizadas neste web service 3 maneiras para que seja possível tomar conhecimento
da decisão do servidor ou pensionista:

6
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

1) Nas operações incluirContratoV2 e renovarContratoV2 foram disponibilizados

parâmetros para informar até 3 e-mails, para que, quando o servidor ou pensionista
aceitar ou rejeitar o contrato proposto, seja disparada uma mensagem para os e-mails
cadastrados para aquele contrato específico, informando a decisão.
2) Nas mesmas operações incluirContratoV2 e renovarContratoV2 foram
disponibilizados parâmetros para informar URLs de uma API, a ser disponibilizada
pela instituição financeira, para que no momento do aceite ou rejeição do contrato
proposto, estas URLs sejam acionadas pelo SERPRO indicando a decisão tomada. A
instituição financeira poderá informar 2 URLs. Uma URL para ser acionada no aceite
e outra URL para ser acionada na rejeição. No momento da decisão do servidor ou
pensionista, o SERPRO realizará uma requisição HTTP com o método POST na URL
adequada à decisão tomada, e esperará pelo código de retorno HTTP 200. O código
HTTP 200 indicará ao SERPRO que a notificação da decisão foi realizada com
sucesso. Qualquer outro código HTTP retornado pela API da instituição financeira
será considerada como falha na notificação. Portanto, nas URLs (cadastradas para os
contratos nestas operações) já deverão conter todas as informações necessárias para
que o contrato específico seja identificado pela API da instituição financeira. O
SERPRO NÃO adicionará qualquer outra informação à URL cadastrada para o
contrato específico.
3) Através da operação “consultarAnuenciaContratos” será possível recuperar todas
as decisões tomadas pelos servidores e pensionistas a partir de uma data e hora
parametrizada na chamada desta operação. Mais detalhes desta operação está
descrita no decorrer deste documento.

4.4. Operação consultarAutorizacoesMargemConsignavel (Disponível na

Versão V2)

Operação responsável em consultar a situação das autorizações concedidas pelos

servidores e/ou pensionistas ao consignatário e os respectivos valores das margens
consignáveis disponíveis para cada tipo de autorização vigente.
O valor da margem consignável disponível somente será recuperada se existir uma
autorização vigente do servidor público para a consignatária realizar a consulta.

4.4.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

cdConsig Numérico(06) Código da consignatária X
cdSenhaConsig Alfanumérico(12) Senha da consignatária X
CPF do servidor ou
nrCpf Alfanumérico(14) X
pensionista

7
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.4.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

Data e hora do processamento da
dtOperacao Data operação no formato DD/MM/AAAA
HH:MM:SS.
nome Alfa(60) Nome do servidor ou pensionista
Tag agrupadora com as informações
vinculoFuncional – Início (Uma ou mais ocorrências) do vínculo funcional do servidor ou
pensionista.
Código do Tipo do Vínculo Funcional
codTipoVinc Alfa(1) - Verificar o item 4.2 Tipos
Personalizados deste documento.
Descrição do Tipo do Vínculo
descTipoVinc Alta(15) Funcional - Verificar o item 4.2 Tipos
Personalizados deste documento.
codOrgao Numérico(5) Código do órgão
nmOrgao Alfa(60) Nome do órgão
cdMatricula Numérico(7) Matrícula do servidor ou pensionista
Órgão (numérico(5)) + Matrícula do
Instituidor (numérico(07)). Informação
orgMatInst Numérico(12)
preenchida somente para vínculos
funcionais de pensionistas.
Código da Classificação do Vínculo
codClassificacao Numérico(2) Funcional - Verificar o item 4.2 Tipos
Personalizados deste documento.
Descrição da Classificação do
Vínculo Funcional - Verificar o item
descClassificacao Alfa(20)
4.2 Tipos Personalizados deste
documento.
Código da unidade pagadora do
vínculo funcional. Formado pelo
cdUpag Numérico(14)
código do órgao(5) + código da
upag(9)
Sigla da unidade federativa da
cdUfUpag Alfa(2) unidade pagadora do vínculo
funcional.
Tag agrupadora com as informações
produto – Início (Uma ou mais ocorrências) do “produto/servico” oferecido pela
consignatária.
cdRubrica Numérico(5) Código da rubrica
dsRubrica Alfa(60) Descrição da rubrica
cdConvenio Numérico(6) Código do convênio
Valor da margem consignável
vlMargemDisp Numérico(13,2) disponível para novos contratos.
Exemplo: 100000 para R$ 1.000,00.
autorizacaoEmprestimo – Início Tag agrupadora com as informações
da autorização para novos contratos
de empréstimo ou renovações de

8
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

contratos de empréstimo.
Informações disponíveis somente
para rubricas de empréstimo.
Indicador da existência ou não de
autorizado Alfa(1) autorização vigente. S – para sim, N
– para não.
Data limite de vigência da
autorização para novos contratos no
dtValidade Data formato DD/MM/AAAA. Retorno vazio
para prazo indeterminado ou quando
não existir autorização vigente.
autorizacaoEmprestimo – Fim
Tag agrupadora com as informações
da autorização para portabilidade de
autorizacaoPortabilidade - Inicio contratos de empréstimo.
Informações disponíveis somente
para rubricas de empréstimo.
Indicador da existência ou não de
autorizado Alfa(1) autorização vigente. S – para sim, N
– para não.
Data limite de vigência da
autorização para portabilidade no
dtValidade Data formato DD/MM/AAAA. Retorno vazio
para prazo indeterminado ou quando
não existir autorização vigente.
contratoPortado - Início
CNPJ da consignatária atual
nrCnpj Numérico(14) detentora do contrato alvo da
portabilidade.
Razão social da consignatária atual
nmConsignataria Alfa(60) detentora do contrato alvo da
portabilidade.
Número do contrato alvo da
nrContrato Alfanumérico(20)
portabilidade.
contratoPortado - Fim
Valor da margem consignável
disponível para a operação de
vlMargemDisp Numérico(13,2) portabilidade do contrato selecionado
pelo servidor. Exemplo: 100000 para
R$ 1.000,00.
autorizacaoPortabilidade - Fim
Tag agrupadora com as informações
da autorização para contratos de
autorizacaoCartao – Início
cartão. Informações disponíveis
somente para rubricas de cartão.
Indicador da existência ou não de
autorizado Alfa(1) autorização vigente. S – para sim, N
– para não.
dtValidade Data Data limite de vigência da
autorização para contratos de cartão

9
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

no formato DD/MM/AAAA. Retorno

vazio para prazo indeterminado ou
quando não existir autorização
vigente.
autorizacaoCartao – Fim
Tag agrupadora com as informações
da autorização para contratos de
autorizacaoDescSindical – Início desconto sindical. Informações
disponíveis somente para rubricas de
desconto sindical.
Indicador da existência ou não de
autorizado Alfa(1) autorização vigente. S – para sim, N
– para não.
Data limite de vigência da
autorização para descontos sindicais
no formato DD/MM/AAAA. Retorno
dtValidade Data
vazio para prazo indeterminado ou
quando não existir autorização
vigente.
autorizacaoDescSindical – Fim
Tag agrupadora com as informações
da autorização para contratos de
mensalidades de associações,
previdência, plano de saúde e
autorizacaoDescMensal - Início
seguros. Informações disponíveis
somente para rubricas de
associações, previdência, plano de
saúde, seguros e cooperativas.
Indicador da existência ou não de
autorizado Alfa(1) autorização vigente. S – para sim, N
– para não.
Data limite de vigência da
autorização para descontos mensais
de associações, planos de saúde,
seguros, previdência e cooperativas
dtValidade Data
no formato DD/MM/AAAA. Retorno
vazio para prazo indeterminado ou
quando não existir autorização
vigente.
autorizacaoDescMensal - Fim
produto – Fim
vinculoFuncional – Fim
cdRetCode Numérico(04) Código de Retorno do serviço
dsRetCode Alfanumérico(220) Mensagem de Retorno do serviço

10
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.4.3. Lista de erros

Código Descrição
0000 Serviço realizado com sucesso.
2035 Servidor inativo.
2048 Servidor falecido.
8010 Consignatária inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

4.4.4. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarAutorizacoesMargemConsignavel>
<consultarAutorizacoesMargemConsignavelRequest>
<cdConsig>115</cdConsig>
<cdSenhaConsig>12345678</cdSenhaConsig>
<nrCpf>99999999999</nrCpf>
</consultarAutorizacoesMargemConsignavelRequest>
</urn:consultarAutorizacoesMargemConsignavel>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada para Bancos:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarAutorizacoesMargemConsignavelResponse
xmlns:ns1="urn:consignataria">
<return>

11
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<nome>João José Silva e Silva</nome>

<vinculoFuncional>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>17000000000001</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34116</cdRubrica>
<dsRubrica>EMPREST BCO OFICIAL - BCO BRAS</dsRubrica>
<cdConvenio>101</cdConvenio>
<vlMargemDisp>100000</vlMargemDisp>
<autorizacaoEmprestimo>
<autorizado>S</autorizado>
<dtValidade>20/11/2019</dtValidade>
</autorizacaoEmprestimo>
<autorizacaoPortabilidade>
<autorizado>S</autorizado>
<dtValidade>20/11/2019</dtValidade>
<contratoPortado>
<nrCnpj>12345678901234</nrCnpj>
<nmConsignataria>CONSIGNATARIA XYZ</nmConsignataria>
<nrContrato>XYZ111</nrContrato>
</contratoPortado>

12
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<vlMargemDisp>250000</vlMargemDisp>
</autorizacaoPortabilidade>
</produto>
<produto>
<cdRubrica>34833</cdRubrica>
<dsRubrica>AMORT CARTAO CREDITO - BCO BRASIL</dsRubrica>
<cdConvenio>142</cdConvenio>
<vlMargemDisp>100000</vlMargemDisp>
<autorizacaoCartao>
<autorizado>S</autorizado>
<dtValidade></dtValidade>
</autorizacaoNovo>
</produto>
</vinculoFuncional>
<vinculoFuncional>
<codTipoVinc>P</codTipoVinc>
<descTipoVinc>Pensionista</descTipoVinc>
<codOrgao>15000</codOrgao>
<nmOrgao>MINISTERIO DA EDUCACAO</nmOrgao>
<cdMatricula>87654321</cdMatricula>
<orgMatInst>150007654321</orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>15000000000020</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34116</cdRubrica>
<dsRubrica>EMPREST BCO OFICIAL - BCO BRAS</dsRubrica>
<cdConvenio>101</cdConvenio>
<autorizacaoEmprestimo>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoEmprestimo>
<autorizacaoPortabilidade>

13
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoPortabilidade>
</produto>
<produto>
<cdRubrica>34833</cdRubrica>
<dsRubrica>AMORT CARTAO CREDITO - BCO BRASIL</dsRubrica>
<cdConvenio>142</cdConvenio>
<autorizacaoCartao>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoNovo>
</produto>
</vinculoFuncional>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarAutorizacoesMargemConsignavelResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Sindicatos:

14
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<vinculoFuncional>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>17000000000001</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34284</cdRubrica>
<dsRubrica>MENSALIDADE SINDICAL - SINPOL/</dsRubrica>
<cdConvenio>123405</cdConvenio>
<autorizacaoDescSindical>
<autorizado>S</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescSindical>
</produto>
</vinculoFuncional>
<vinculoFuncional>
<codTipoVinc>P</codTipoVinc>
<descTipoVinc>Pensionista</descTipoVinc>
<codOrgao>15000</codOrgao>
<nmOrgao>MINISTERIO DA EDUCACAO</nmOrgao>
<cdMatricula>87654321</cdMatricula>
<orgMatInst>150007654321</orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>15000000000020</cdUpag>
<cdUfUpag>DF</cdUfUpag>

15
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<produto>
<cdRubrica>34284</cdRubrica>
<dsRubrica>MENSALIDADE SINDICAL - SINPOL/</dsRubrica>
<cdConvenio>123405</cdConvenio>
<autorizacaoDescSindical>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescSindical>
</produto>
</vinculoFuncional>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarAutorizacoesMargemConsignavelResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Associações:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarAutorizacoesMargemConsignavelResponse
xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<nome>João José Silva e Silva</nome>

<vinculoFuncional>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>

16
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>17000000000001</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34716</cdRubrica>
<dsRubrica>CONTRIB ASSOCIATIVA - ABS/DNER</dsRubrica>
<cdConvenio>123413</cdConvenio>
<autorizacaoDescMensal>
<autorizado>S</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
</vinculoFuncional>
<vinculoFuncional>
<codTipoVinc>P</codTipoVinc>
<descTipoVinc>Pensionista</descTipoVinc>
<codOrgao>15000</codOrgao>
<nmOrgao>MINISTERIO DA EDUCACAO</nmOrgao>
<cdMatricula>87654321</cdMatricula>
<orgMatInst>150007654321</orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>15000000000020</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34716</cdRubrica>
<dsRubrica>CONTRIB ASSOCIATIVA - ABS/DNER</dsRubrica>
<cdConvenio>123413</cdConvenio>

17
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<autorizacaoDescMensal>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
</vinculoFuncional>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarAutorizacoesMargemConsignavelResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Operadoras de Planos de Saúde:

18
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>17000000000001</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34149</cdRubrica>
<dsRubrica>PSAUDE AUTOGESTAO - GEAP</dsRubrica>
<cdConvenio>123413</cdConvenio>
<autorizacaoDescMensal>
<autorizado>S</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
<produto>
<cdRubrica>34148</cdRubrica>
<dsRubrica>CO-PARTIC AUTOGESTAO - GEAP</dsRubrica>
<cdConvenio>123414</cdConvenio>
<autorizacaoDescMensal>
<autorizado>S</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
</vinculoFuncional>
<vinculoFuncional>
<codTipoVinc>P</codTipoVinc>
<descTipoVinc>Pensionista</descTipoVinc>
<codOrgao>15000</codOrgao>
<nmOrgao>MINISTERIO DA EDUCACAO</nmOrgao>
<cdMatricula>87654321</cdMatricula>
<orgMatInst>150007654321</orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>15000000000020</cdUpag>
<cdUfUpag>DF</cdUfUpag>

19
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<produto>
<cdRubrica>34149</cdRubrica>
<dsRubrica>PSAUDE AUTOGESTAO - GEAP</dsRubrica>
<cdConvenio>123413</cdConvenio>
<autorizacaoDescMensal>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
<produto>
<cdRubrica>34148</cdRubrica>
<dsRubrica>CO-PARTIC AUTOGESTAO - GEAP</dsRubrica>
<cdConvenio>123414</cdConvenio>
<autorizacaoDescMensal>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
</vinculoFuncional>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarAutorizacoesMargemConsignavelResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Operadoras de Seguros, Previdência Complementar e

Cooperativas:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarAutorizacoesMargemConsignavelResponse
xmlns:ns1="urn:consignataria">

20
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<nome>João José Silva e Silva</nome>

<vinculoFuncional>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>17000000000001</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34602</cdRubrica>
<dsRubrica>PREMIO SEGURO VIDA - CAPEMISA</dsRubrica>
<cdConvenio>123413</cdConvenio>
<autorizacaoDescMensal>
<autorizado>S</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
<produto>
<cdRubrica>34604</cdRubrica>
<dsRubrica>EMPREST PREV PRIVADA - CAPEMISA</dsRubrica>
<cdConvenio>123414</cdConvenio>
<vlMargemDisp>100000</vlMargemDisp>
<autorizacaoEmprestimo>
<autorizado>S</autorizado>

21
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<dtValidade>20/11/2019</dtValidade>
</autorizacaoEmprestimo>
<autorizacaoPortabilidade>
<autorizado>S</autorizado>
<dtValidade>20/11/2019</dtValidade>
</autorizacaoPortabilidade>
</produto>
</vinculoFuncional>
<vinculoFuncional>
<codTipoVinc>P</codTipoVinc>
<descTipoVinc>Pensionista</descTipoVinc>
<codOrgao>15000</codOrgao>
<nmOrgao>MINISTERIO DA EDUCACAO</nmOrgao>
<cdMatricula>87654321</cdMatricula>
<orgMatInst>150007654321</orgMatInst>
<codClassificacao>1</codClassificacao>
<descClassificacao>Estável</descClassificacao>
<cdUpag>15000000000020</cdUpag>
<cdUfUpag>DF</cdUfUpag>

<produto>
<cdRubrica>34602</cdRubrica>
<dsRubrica>PREMIO SEGURO VIDA - CAPEMISA</dsRubrica>
<cdConvenio>123413</cdConvenio>
<autorizacaoDescMensal>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoDescMensal>
</produto>
<produto>
<cdRubrica>34604</cdRubrica>
<dsRubrica>EMPREST PREV PRIVADA - CAPEMISA</dsRubrica>
<cdConvenio>123414</cdConvenio>
<autorizacaoEmprestimo>
<autorizado>N</autorizado>

22
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<dtValidade></dtValidade>
</autorizacaoEmprestimo>
<autorizacaoPortabilidade>
<autorizado>N</autorizado>
<dtValidade></dtValidade>
</autorizacaoPortabilidade>
</produto>
</vinculoFuncional>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarAutorizacoesMargemConsignavelResponse>
</soap:Body>
</soap:Envelope>

4.5. Operação incluirContratoV2 (Disponível na Versão V2)

Operação responsável em incluir contratos de consignação.

A operação será realizada se a consignatária possuir autorização específica para o
tipo de consignação que está sendo realizada a inclusão, e margem consignável disponível
para comportar o desconto.
Os contratos, do tipo de consignação empréstimo, incluídos por esta operação ficarão
na situação de Aguardando Anuência, ou seja, somente serão efetivados na ficha financeira
do servidor ou pensionista após a aprovação destes, alvos da ação, por meio de
funcionalidade específica do SIGEPE (Sistema de Gestão de Pessoas). O valor do contrato
já ficará provisionado na margem consignável do servidor ou pensionista após a inclusão do
contrato. Este valor será liberado somente se o servidor recusar o contrato ou o prazo para
anuência do contrato tenha expirado.
Os demais tipos de consignações não necessitam da anuência do servidor ou
pensionista, ou seja, ao finalizar a operação com sucesso, o contrato já estará averbado na
ficha financeira do servidor ou pensionista alvo da ação.

4.5.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

cdConsig Numérico(06) Código da consignatária X

23
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

cdSenhaConsig Alfanumérico(12) Senha da consignatária X

CPF do servidor ou
nrCpf Alfanumérico(14) X
pensionista
cdOrgao Numérico(5) Código do órgão X
Matrícula do servidor ou
cdMatricula Numérico(7) X
pensionista
Órgão (numérico(5)) +
orgMatInst Numérico(12) Matrícula do Instituidor P
(numérico(07))
Código do convênio que
identifica o tipo de
cdConvenio Numérico(6) X
produto/serviço alvo da
ação
nrContrato Alfanumérico(20) Número do contrato X
Valor bruto da operação.
Obrigatório somente para
contratos do tipo de
vlBruto Numérico(13,2) consignação de O
empréstimo. Exemplo:
100000 para R$
1.000,00.
Valor líquido creditado ao
servidor ou pensionista
da operação. Obrigatório
somente para contratos
vlLiquido Numérico(13,2) O
do tipo de consignação
de empréstimo. Exemplo:
100000 para R$
1.000,00.
Valor de desconto
mensal. Se for informado
este campo, os campos
“vlPercentual”,
“cdAssuntoCalculo” e
vlDesconto Numérico(13,2) “rubricas” não deverão O
ser informados e vice-
versa.
Exemplo: 100000 para
R$ 1.000,00.
Prazo em meses de
desconto. Informar 0
pzDesconto Numérico(3) X
(zero) para prazo
indeterminado
Taxa de juros mensal do
contrato. Exemplo: 1150
para 11,50%. Obrigatório
txJurosMensal Numérico(5,2) O
somente para contratos
do tipo de consignação
de empréstimo.
iof Numérico(5,2) Valor do IOF cobrado. O

24
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Exemplo: 120 para R$

1,20. Obrigatório
somente para contratos
do tipo de consignação
de empréstimo.
Custo efetivo total do
contrato. Exemplo: 2000
para 20,00%. Obrigatório
cet Numérico(5,2) O
somente para contratos
do tipo de consignação
de empréstimo.
Valor do percentual a ser
utilizado no cálculo do
valor de desconto. Se
informado este campo,
vlPercentual Numérico(5,2) também deverá ser O
informado o campo
“cdAssuntoCalculo”.
Exemplo: 1150 para
11,50 %
Código do assunto de
cálculo a ser utilizado no
cálculo do valor de
desconto. Se informado
este campo, o campo
“vlPercentual” também
cdAssuntoCalculo Numérico(2) deverá ser informado e o O
campo “vlDesconto” não
deverá ser informado. Se
informado o assunto de
cálculo 26, também
deverá ser informado o
campo “rubricas”.
Tag agrupadora com as
rubricas a serem
utilizadas no cálculo do
valor de desconto. Se
informado este campo, o
rubricas - Início campo “vlPercentual” e O
“cdAssuntoCalculo”
também deverão ser
informados. O campo
“vlDesconto” não deverá
ser informado.
cdRubrica (Uma ou mais
Numérico(5) Código da rubrica X
ocorrências)
rubricas - Fim
emailsParaNotificacaoAnuencia – Inicio Tag agrupadora com os O
e-mails que serão
notificados após a

25
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

realização da anuência
do contrato pelo servidor
ou pensionista
email (Uma ou mais
Alfanumérico(100) Email a ser notificado. X
ocorrências)
emailsParaNotificacaoAnuencia – Fim
URL da API disponível da
consignatária para ser
acionada pelo SERPRO
após o aceite do contrato
urlAceite Alfanumérico(250) pelo servidor ou O
pensionista. Obrigatório
somente para a inclusão
de contratos de
empréstimo.
URL da API disponível da
consignatária para ser
acionada pelo SERPRO
após a recusa do
urlRecusa Alfanumérico(250) contrato pelo servidor ou O
pensionista. Obrigatório
somente para a inclusão
de contratos de
empréstimo.
Data limite para o
servidor aceitar ou
rejeitar o contrato
dtValidadeAnuencia Data proposto no formato DD/ O
MM/AAAA. Obrigatório
somente para contratos
de empréstimo.

4.5.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

Data e hora do processamento da
dtOperacao Alfanumérico(19) operação no formato DD/MM/AAAA
HH:MM:SS
nmServ Alfanumérico(60) Nome do servidor
cdBcoServ Numérico(3) Banco do Servidor
cdAgeServ Alfanumérico(20) Agência do Servidor
cdCcsServ Alfanumérico(20) Conta do Servidor
nrContrato Alfanumérico(20) Número do contrato
seqContrato Numérico(1) Número do sequencial do contrato.
cdRetCode Numérico(04) Código de Retorno
dsRetCode Alfanumérico(220) Mensagem de Retorno

26
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.5.3. Lista de erros

Código Descrição
0000 Serviço realizado com sucesso.
0002 Órgão inexistente.
0008 Convênio inexistente.
0024 Número contrato incorreto.
0029 Número contrato existente.
0056 Órgão não está ativo.
0087 Consignatária não autorizada a consignar pelo servidor/pensionista.
Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
2027 Valor da prestação incorreto.
2027 Órgão incorreto.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Convênio incorreto.
2027 Prazo incorreto.
2027 Assunto de cálculo incorreto.
2027 Percentual incorreto.
2027 Rubrica incorreta.
2027 Email incorreto.
2027 Valor bruto incorreto.
2027 Valor líquido incorreto.
2027 Taxa de juros mensal incorreta
2027 CET incorreto
2027 IOF incorreto
2046 CPF não confere com a matrícula.
2109 Valor da prestação não informado.
2109 Órgão não informado.
2109 Matrícula não informada.
2109 Número do contrato não informado.
2109 Convênio não informado.
2109 Prazo não informado.
2109 Percentual não informado.
2109 Assunto de cálculo não informado.
2109 Rubrica não informada.
2109 Valor bruto não informado.
2109 Valor líquido não informado.
2109 Taxa de juros mensal não informada.
2109 CET não informado.
2109 IOF não informado.
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.

27
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

8058 Funcionário não tem margem para essa solicitação.

8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8133 Ação não executada. Número de sequência indisponível.
4008 Rubrica não possui autorização para realizar consignação.
4011 Consignatária sem rubrica associada para este órgão.
4015 Contrato sem rubrica disponível.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização não permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
Já existe uma consignação de cartão vigente. Tipo de consignação permite
4040
somente uma consignação vigente.
4041 Consignação de cartão deve possuir prazo igual a 1.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.
4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.
4051 Consignatária desativada temporariamente.
4070 O valor do percentual de desconto não deve ser informado quando o valor
de desconto estiver preenchido.
O valor do assunto de cálculo deve ser informado quando o valor do
4071
percentual de desconto estiver preenchido.
O valor do desconto ou valor do percentual de desconto deve ser
4072
preenchido.
4073 Valor do percentual inválido
4073 Valor do assunto de cálculo inválido.
4074 Rubrica inválida.
8888 Serviço indisponível.

28
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.5.4. Exemplo de Requisição SOAP

Para operações de empréstimo:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:incluirContratoV2>
<incluirContratoV2Request>
<cdConsig>115</cdConsig>
<cdSenhaConsig>12345678</cdSenhaConsig>
<nrCpf>99999999999</nrCpf>
<cdOrgao>13000</cdOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<vlBruto>6000000</vlBruto>
<vlLiquido>4500000</vlLiquido>
<vlDesconto>100000</vlDesconto>
<pzDesconto>60</pzDesconto>
<txJurosMensal>1150</txJurosMensal>
<iof>120</iof>
<cet>2000</cet>
<emailsParaNotificacaoAnuencia>

<email>teste1@teste.com.br</email>
<email>teste2@teste.com.br</email>
</emailsParaNotificacaoAnuencia>
<urlAceite>https://consignataria.com.br/consignasiape/
12345/698dc19d489c4e4db73e28a713eab07b</urlAceite>
<urlRecusa>https://consignataria.com.br/consignasiape/54321/38851536d87701d2191990e2
4a7f8d4e</urlRecusa>
<dtValidadeAnuencia>30/11/2019</dtValidadeAnuencia>
</incluirContratoV2Request>

29
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</urn:incluirContratoV2>
</soapenv:Body>
</soapenv:Envelope>

Para mensalidades de Associações, Sindicatos, Operadoras de Plano de Saúde,

Operadoras de Previdência Complementar, Cooperativas por valor fixo:

Para mensalidades de Associações, Sindicatos, Operadoras de Plano de Saúde,

Operadoras de Previdência Complementar, Cooperativas por assunto de cálculo e
percentual:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:incluirContratoV2>

30
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Para mensalidades de Associações, Sindicatos, Operadoras de Plano de Saúde,

Operadoras de Previdência Complementar, Cooperativas por rubricas e percentual:

31
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:incluirContratoV2Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<nmServ>João José Silva e Silva</nmServ>
<cdBcoServ>001</cdBcoServ>
<cdAgeServ>045942</cdAgeServ>
<cdCcsServ>327232X</cdCcsServ>
<nrContrato>111</nrContrato>
<seqContrato>1</seqContrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:incluirContratoV2Response>
</soap:Body>
</soap:Envelope>

32
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.6. Operação incluirContratoPortabilidade (Disponível na Versão V2)

Operação responsável em incluir contratos de portabilidade de consignação.

A operação será realizada se a consignatária possuir autorização específica para o
tipo de consignação que está sendo realizada a inclusão, e margem consignável disponível
para comportar o desconto. Esta operação somente é permitida para consignações do tipo
empréstimo.
Os contratos incluídos por esta operação ficarão na situação de “Aguardando
Encerramento do Contrato Portado”, ou seja, somente serão efetivados na ficha financeira
do servidor após a consignatária, atual detentora do contrato a ser portado, encerrar o
contrato portado. Ocorrendo o encerramento do contrato portado, automaticamente o novo
contrato será averbado na ficha financeira do servidor ou pensionista. O valor do contrato já
ficará provisionado na margem consignável do servidor após a inclusão do contrato de
portabilidade. Este valor será liberado da margem consignável somente se a consignatária,
atual detentora do contrato portado, não encerrá-lo dentro de um prazo de 5 dias após a
inclusão da portabilidade.

4.6.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

cdConsig Numérico(06) Código da consignatária X
cdSenhaConsig Alfanumérico(12) Senha da consignatária X
CPF do servidor ou
nrCpf Alfanumérico(14) X
pensionista
cdOrgao Numérico(5) Código do órgão X
Matrícula do servidor ou
cdMatricula Numérico(7) X
pensionista
Órgão (numérico(5)) +
orgMatInst Numérico(12) Matrícula do Instituidor P
(numérico(07))
Código do convênio que
identifica o tipo de
cdConvenio Numérico(6) X
produto/serviço alvo da
ação
nrContrato Alfanumérico(20) Número do contrato X
Valor bruto da operação.
Obrigatório somente para
contratos do tipo de
vlBruto Numérico(13,2) consignação de X
empréstimo. Exemplo:
100000 para R$
1.000,00.
vlLiquido Numérico(13,2) Valor líquido creditado ao X
servidor ou pensionista
da operação. Obrigatório

33
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

somente para contratos

do tipo de consignação
de empréstimo. Exemplo:
100000 para R$
1.000,00.
Valor de desconto
mensal.
vlDesconto Numérico(13,2) X
Exemplo: 100000 para
R$ 1.000,00.
Prazo em meses de
desconto. Informar 0
pzDesconto Numérico(3) X
(zero) para prazo
indeterminado
Taxa de juros mensal do
contrato. Exemplo: 1150
para 1150%. Obrigatório
txJurosMensal Numérico(5,2) X
somente para contratos
do tipo de consignação
de empréstimo.
Valor do IOF cobrado.
Exemplo: 120 para R$
1,20. Obrigatório
iof Numérico(5,2) X
somente para contratos
do tipo de consignação
de empréstimo.
Custo efetivo total do
contrato. Exemplo: 2000
para 20,00%. Obrigatório
cet Numérico(5,2) X
somente para contratos
do tipo de consignação
de empréstimo.
Tag agrupadora com as
contratoPortado – Início informações do contrato X
a ser portado.
CNPJ da consignatária
nrCnpj Numérico(14) atualmente detentora do X
contrato a ser portado.
nrContrato Alfanumérico(20) Número do contrato a ser X
portado.
contratoPortado – Fim
Data de início do
processo de portabilidade
dtInicioProcessoCip Data X
no CIP no formato
DD/MM/AAAA.
Número que identifica o
nrProcessoCip Alfanumérico(20) processo da portabilidade X
no CIP.

34
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.6.2. Parâmetros de Saída

EstruturaAlfanum
Nome da Tag Descrição
érico
Data e hora do processamento da
dtOperacao Alfanumérico(19) operação no formato DD/MM/AAAA
HH:MM:SS
nmServ Alfanumérico(60) Nome do servidor
cdBcoServ Numérico(3) Banco do Servidor
cdAgeServ Alfanumérico(20) Agência do Servidor
cdCcsServ Alfanumérico(20) Conta do Servidor
nrContrato Alfanumérico(20) Número do contrato
seqContrato Numérico(1) Número do sequencial do contrato.
cdRetCode Numérico(04) Código de Retorno
dsRetCode Alfanumérico(220) Mensagem de Retorno

4.6.3. Lista de erros

35
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

2109 Órgão não informado

2109 Matrícula não informada
2109 Número do contrato não informado
2109 Convênio não informado
2109 Prazo não informado
2109 Percentual não informado.
2109 Assunto de cálculo não informado.
2109 Rubrica não informada.
2109 Valor bruto não informado.
2109 Valor líquido não informado.
2109 Taxa de juros mensal não informada.
2109 CET não informado.
2109 IOF não informado.
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8133 Ação não executada. Número de sequência indisponível.
4008 Rubrica não possui autorização para realizar consignação.
4011 Consignatária sem rubrica associada para este órgão.
4015 Contrato sem rubrica disponível.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização não permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
Já existe uma consignação de cartão vigente. Tipo de consignação permite
4040
somente uma consignação vigente.
4041 Consignação de cartão deve possuir prazo igual a 1.
4046 Rubrica possui restrição do tipo suspensão de consignação ativa com o

36
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.
4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.
4051 Consignatária desativada temporariamente.
O valor do percentual de desconto não deve ser informado quando o valor
4070
de desconto estiver preenchido.
O valor do assunto de cálculo ou relação de rubricas deve ser informado
4071
quando o valor do percentual de desconto estiver preenchido.
O valor do desconto ou valor do percentual de desconto deve ser
4072
preenchido.
4073 Valor do percentual inválido
4073 Valor do assunto de cálculo inválido.
4074 Rubrica inválida.
8888 Serviço indisponível.

4.6.4. Exemplo de Requisição SOAP

37
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<iof>120</iof>
<cet>2000</cet>
<contratoPortado>
<nrCnpj>12345678901234</nrCnpj>
<nrContrato>XYZ111</nrContrato>
</contratoPortado>
<emailsParaNotificacaoAnuencia>

<email>teste1@teste.com.br</email>
<email>teste2@teste.com.br</email>
</emailsParaNotificacaoAnuencia>
<dtInicioProcessoCip>27/11/2019</dtInicioProcessoCip>
<nrProcessoCip>A234567890B234567890</nrProcessoCip>
</incluirContratoPortabilidadeRequest>
</urn:incluirContratoPortabilidade>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:incluirContratoPortabilidadeResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<nmServ>João José Silva e Silva</nmServ>
<cdBcoServ>001</cdBcoServ>
<cdAgeServ>045942</cdAgeServ>
<cdCcsServ>327232X</cdCcsServ>
<nrContrato>111</nrContrato>
<seqContrato>1</seqContrato>
<cdRetCode>0000</cdRetCode>

38
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<dsRetCode>Serviço realizado com sucesso.</dsRetCode>

</response>
]]>
</return>
</ns1:incluirContratoPortabilidadeResponse>
</soap:Body>
</soap:Envelope>

4.7. Operação alterarContrato (Disponível na Versão V2)

Operação responsável em alterar contratos de consignação.

Esta operação não necessita de autorização específica para o tipo de consignação
que está sendo realizada a alteração. Contratos do tipo empréstimo somente poderão ter os
valores de desconto e prazo alterados para valores menores em relação aos valores atuais.
Os contratos alterados com sucesso já terão imediatamente os novos valores
atualizados na ficha financeira do servidor ou pensionista alvo da ação.

4.7.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

cdConsig Numérico(06) Código da consignatária X
cdSenhaConsig Alfanumérico(12) Senha da consignatária X
CPF do servidor ou
nrCpf Alfanumérico(14) X
pensionista
cdOrgao Numérico(5) Código do órgão X
Matrícula do servidor ou
cdMatricula Numérico(7) X
pensionista
Órgão (numérico(5)) +
orgMatInst Numérico(12) Matrícula do Instituidor P
(numérico(07))
nrContrato Alfanumérico(20) Número do contrato X
Valor de desconto
mensal. Se for informado
este campo, os campos
“vlPercentual”,
“cdAssuntoCalculo” e
vlDesconto Numérico(13,2) “rubricas” não deverão O
ser informados e vice-
versa.
Exemplo: 100000 para
R$ 1.000,00.

39
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Prazo em meses de
desconto. Informar 0
pzDesconto Numérico(3) X
(zero) para prazo
indeterminado
Valor bruto da operação.
Obrigatório somente para
contratos do tipo de
vlBruto Numérico(13,2) consignação de O
empréstimo. Exemplo:
100000 para R$
1.000,00.
Valor líquido creditado ao
servidor ou pensionista
da operação. Obrigatório
somente para contratos
vlLiquido Numérico(13,2) O
do tipo de consignação
de empréstimo. Exemplo:
100000 para R$
1.000,00.
Taxa de juros mensal do
contrato. Exemplo: 1150
para 11,50%. Obrigatório
txJurosMensal Numérico(5,2) O
somente para contratos
do tipo de consignação
de empréstimo.
Valor do IOF cobrado.
Exemplo: 120 para R$
1,20. Obrigatório
iof Numérico(5,2) O
somente para contratos
do tipo de consignação
de empréstimo.
Custo efetivo total do
contrato. Exemplo: 2000
para 20,00%. Obrigatório
cet Numérico(5,2) O
somente para contratos
do tipo de consignação
de empréstimo.
Valor do percentual a ser
utilizado no cálculo do
valor de desconto. Se
informado este campo,
vlPercentual Numérico(5,2) também deverá ser O
informado o campo
“cdAssuntoCalculo”.
Exemplo: 1150 para
11,50 %
cdAssuntoCalculo Numérico(2) Código do assunto de O
cálculo a ser utilizado no
cálculo do valor de
desconto. Se informado

40
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

este campo, o campo

“vlPercentual” também
deverá ser informado e o
campo “vlDesconto” não
deverá ser informado. Se
informado o assunto de
cálculo 26, também
deverá ser informado o
campo “rubricas”.
Tag agrupadora com as
rubricas a serem
utilizadas no cálculo do
valor de desconto. Se
informado este campo, o
rubricas - Início campo “vlPercentual” e O
“cdAssuntoCalculo”
também deverão ser
informados. O campo
“vlDesconto” não deverá
ser informado.
cdRubrica (Uma ou mais
Numérico(5) Código da rubrica X
ocorrências)
rubricas - Fim

4.7.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

Data e hora do processamento da
dtOperacao Alfanumérico(19) operação no formato DD/MM/AAAA
HH:MM:SS
cdRetCode Numérico(04) Código de Retorno
dsRetCode Alfanumérico(220) Mensagem de Retorno

4.7.3. Lista de erros

41
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

2027 Valor da prestação incorreto.

2027 Órgão incorreto.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Convênio incorreto.
2027 Prazo incorreto.
2027 Assunto de cálculo incorreto.
2027 Percentual incorreto.
2027 Rubrica incorreta.
2027 Email incorreto.
2027 Valor bruto incorreto.
2027 Valor líquido incorreto.
2027 Taxa de juros mensal incorreta.
2027 CET incorreto
2027 IOF incorreto
2046 CPF não confere com a matrícula.
2109 Valor da prestação não informado
2109 Órgão não informado
2109 Matrícula não informada
2109 Número do contrato não informado
2109 Convênio não informado
2109 Prazo não informado
2109 Percentual não informado.
2109 Assunto de cálculo não informado.
2109 Rubrica não informada.
2109 Valor bruto não informado.
2109 Valor líquido não informado.
2109 Taxa de juros mensal não informada.
2109 CET não informado.
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8133 Ação não executada. Número de sequência indisponível.
4008 Rubrica não possui autorização para realizar consignação.
4011 Consignatária sem rubrica associada para este órgão.
4015 Contrato sem rubrica disponível.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização não permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.

42
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4021 Rubrica não é facultativa.

4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
Já existe uma consignação de cartão vigente. Tipo de consignação permite
4040
somente uma consignação vigente.
4041 Consignação de cartão deve possuir prazo igual a 1.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.
4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.
4051 Consignatária desativada temporariamente.
O valor do percentual de desconto não deve ser informado quando o valor
4070
de desconto estiver preenchido.
O valor do assunto de cálculo ou relação de rubricas deve ser informado
4071
quando o valor do percentual de desconto estiver preenchido.
O valor do desconto ou valor do percentual de desconto deve ser
4072
preenchido.
4073 Valor do percentual inválido
4073 Valor do assunto de cálculo inválido.
4074 Rubrica inválida.
8017 Contrato não localizado.
8888 Serviço indisponível.

4.7.4. Exemplo de Requisição SOAP

Para amortização de empréstimos:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:alterarContrato>

43
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Para alterações de mensalidades de de Associações, Sindicatos, Operadoras de Plano

de Saúde, Operadoras de Previdência Complementar, Cooperativas por valor fixo:

44
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Para alterações de mensalidades de de Associações, Sindicatos, Operadoras de Plano

de Saúde, Operadoras de Previdência Complementar, Cooperativas por assunto de
cálculo e percentual:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:alterarContrato>
<alterarContratoRequest>
<cdConsig>115</cdConsig>
<cdSenhaConsig>12345678</cdSenhaConsig>
<nrCpf>99999999999</nrCpf>
<cdOrgao>13000</cdOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<nrContrato>111</nrContrato>
<pzDesconto>0</pzDesconto>
<vlPercentual>515</vlPercentual>
<cdAssuntoCalculo>1</cdAssuntoCalculo>
</alterarContratoRequest>
</urn:alterarContrato>
</soapenv:Body>
</soapenv:Envelope>

45
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Para alterações de mensalidades de de Associações, Sindicatos, Operadoras de Plano

de Saúde, Operadoras de Previdência Complementar, Cooperativas por assunto de
cálculo, rubricas e percentual:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:alterarContrato>
<alterarContratoRequest>
<cdConsig>115</cdConsig>
<cdSenhaConsig>12345678</cdSenhaConsig>
<nrCpf>99999999999</nrCpf>
<cdOrgao>13000</cdOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<nrContrato>111</nrContrato>
<pzDesconto>0</pzDesconto>
<vlPercentual>515</vlPercentual>
<cdAssuntoCalculo>26</cdAssuntoCalculo>
<rubricas>

<cdRubrica>1</cdRubrica>
<cdRubrica>2</cdRubrica>
<cdRubrica>3</cdRubrica>
</rubricas>
</alterarContratoRequest>
</urn:alterarContrato>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:alterarContratoResponse xmlns:ns1="urn:consignataria">

46
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:alterarContratoResponse>
</soap:Body>
</soap:Envelope>

4.8. Operação renovarContratoV2 (Disponível na Versão V2)

Operação responsável em renovar contratos de tipo de consignação empréstimo.

A operação será realizada se a consignatária possuir autorização específica para o
tipo de consignação que está sendo realizada a renovação, e margem consignável
disponível para comportar o desconto.
Os contratos, de empréstimo, incluídos por esta operação ficarão na situação de
Aguardando Anuência, ou seja, somente serão efetivados na ficha financeira do servidor
após a aprovação do servidor ou pensionista, alvo da ação, por meio de funcionalidade
específica do SIGEPE (Sistema de Gestão de Pessoas). O valor do contrato já ficará
provisionado na margem consignável do servidor após a renovação do contrato. Este valor
será liberado somente se o servidor recusar o contrato ou o prazo para anuência do contrato
tenha expirado.

4.8.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

47
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Código do convênio que

identifica o tipo de
cdConvenio Numérico(6) X
produto/serviço alvo da
ação
nrContrato Alfanumérico(20) Número do contrato X
Valor de desconto
mensal.
vlDesconto Numérico(13,2) X
Exemplo: 100000 para
R$ 1.000,00.
Prazo em meses de
desconto. Informar 0
pzDesconto Numérico(3) X
(zero) para prazo
indeterminado
Valor bruto da operação.
Obrigatório somente para
contratos do tipo de
vlBruto Numérico(13,2) consignação de X
empréstimo. Exemplo:
100000 para R$
1.000,00.
Valor líquido creditado ao
servidor ou pensionista
da operação. Obrigatório
somente para contratos
vlLiquido Numérico(13,2) X
do tipo de consignação
de empréstimo. Exemplo:
100000 para R$
1.000,00.
Taxa de juros mensal do
contrato. Exemplo: 1150
para 11,50%. Obrigatório
txJurosMensal Numérico(3,2) X
somente para contratos
do tipo de consignação
de empréstimo.
Valor do IOF cobrado.
Exemplo: 120 para R$
1,20. Obrigatório
iof Numérico(3,2) X
somente para contratos
do tipo de consignação
de empréstimo.
Custo efetivo total do
contrato. Exemplo: 2000
para 20,00%. Obrigatório
cet Numérico(3,2) X
somente para contratos
do tipo de consignação
de empréstimo.
Tag agrupadora com as
informações dos
contratosRenovados – Início X
contratos a serem
renovados.

48
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

nrContrato (Uma ou mais Número do contrato a ser

Alfanumérico(20) X
ocorrências) renovado.
contratosRenovados – Fim
Tag agrupadora com os
e-mails que serão
notificados após a
emailsParaNotificacaoAnuencia – Inicio O
realização da anuência
do contrato pelo servidor
ou pensionista
email (Uma ou mais
Alfanumérico(100) Email a ser notificado. X
ocorrências)
emailsParaNotificacaoAnuencia – Fim
URL da API disponível da
consignatária para ser
acionada pelo SERPRO
urlAceite Alfanumérico(250) O
após o aceite da
renovação pelo servidor
ou pensionista.
URL da API disponível da
consignatária para ser
acionada pelo SERPRO
urlRecusa Alfanumérico(250) O
após a recusa da
renovação pelo servidor
ou pensionista.
Data limite para o
servidor aceitar ou
dtValidadeAnuencia Data rejeitar o contrato X
proposto no formato DD/
MM/AAAA.

4.8.2. Parâmetros de Saída

49
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.8.3. Lista de erros

Código Descrição
0000 Serviço realizado com sucesso.
0002 Órgão inexistente.
0008 Convênio inexistente.
0024 Número contrato incorreto.
0029 Número contrato existente.
0056 Órgão não está ativo.
0087 Consignatária não autorizada a consignar pelo servidor/pensionista.
Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
2027 Valor da prestação incorreto.
2027 Órgão incorreto.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Convênio incorreto.
2027 Prazo incorreto.
2027 Email incorreto.
2027 Valor bruto incorreto.
2027 Valor líquido incorreto.
2027 Taxa de juros mensal incorreta.
2027 CET incorreto.
2027 IOF incorreto
2046 CPF não confere com a matrícula.
2109 Valor da prestação não informado
2109 Órgão não informado
2109 Matrícula não informada
2109 Número do contrato não informado
2109 Convênio não informado
2109 Prazo não informado
2109 Valor bruto não informado.
2109 Valor líquido não informado.
2109 Taxa de juros mensal não informada.
2109 CET não informado.
2109 IOF não informado.
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8133 Ação não executada. Número de sequência indisponível.

50
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4008 Rubrica não possui autorização para realizar consignação.

4011 Consignatária sem rubrica associada para este órgão.
4015 Contrato sem rubrica disponível.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização não permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
Já existe uma consignação de cartão vigente. Tipo de consignação permite
4040
somente uma consignação vigente.
4041 Consignação de cartão deve possuir prazo igual a 1.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.
4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.
4051 Consignatária desativada temporariamente.
O valor do percentual de desconto não deve ser informado quando o valor
4070
de desconto estiver preenchido.
O valor do assunto de cálculo ou relação de rubricas deve ser informado
4071
quando o valor do percentual de desconto estiver preenchido.
O valor do desconto ou valor do percentual de desconto deve ser
4072
preenchido.
4073 Valor do percentual inválido
4073 Valor do assunto de cálculo inválido.
4074 Rubrica inválida.
8017 Contrato não localizado.
8888 Serviço indisponível.

51
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.8.4. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:renovarContratoV2>
<renovarContratoV2Request>
<cdConsig>115</cdConsig>
<cdSenhaConsig>12345678</cdSenhaConsig>
<nrCpf>99999999999</nrCpf>
<cdOrgao>13000</cdOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<vlDesconto>100000</vlDesconto>
<pzDesconto>60</pzDesconto>
<vlBruto>6000000</vlBruto>
<vlLiquido>4500000</vlLiquido>
<txJurosMensal>115</txJurosMensal>
<iof>120</iof>
<cet>2000</cet>
<contratosRenovados>

<nrContrato>111</nrContrato>
<nrContrato>222</nrContrato>
</contratosRenovados>
<emailsParaNotificacaoAnuencia>

<email>teste1@teste.com.br</email>
<email>teste2@teste.com.br</email>
</emailsParaNotificacaoAnuencia>
<urlAceite>https://consignataria.com.br/consignasiape/
12345/698dc19d489c4e4db73e28a713eab07b</urlAceite>
<urlRecusa>https://consignataria.com.br/consignasiape/54321/38851536d87701d2191990e2

52
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4a7f8d4e</urlRecusa>
<dtValidadeAnuencia>30/11/2019</dtValidadeAnuencia>
</renovarContratoV2Request>
</urn:renovarContratoV2>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:renovarContratoV2Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<nmServ>João José Silva e Silva</nmServ>
<cdBcoServ>001</cdBcoServ>
<cdAgeServ>045942</cdAgeServ>
<cdCcsServ>327232X</cdCcsServ>
<nrContrato>111</nrContrato>
<seqContrato>1</seqContrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:renovarContratoV2Response>
</soap:Body>
</soap:Envelope>

53
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.9. Operação consultarAnuenciaContratos (Disponível na Versão V2)

Operação responsável em consultar quais contratos sem anuência foram aprovados,

recusados ou teve o prazo expirado em um determinado dia específico.
Esta operação retorna, para cada chamada, no máximo 480 contratos. Se existirem
mais do que 480 contratos disponíveis, será necessário informar um valor no parâmetro
“cursorPaginacao” para recuperar os próximos 480 contratos. Se existirem mais do que 480
contratos para a consulta, o valor do cursor a ser informado na próxima requisição será
retornado no mesmo campo “cursorPaginacao” presente na resposta da requisição. Quando
este campo for retornado vazio, significará que todos os contratos já foram consultados.

4.9.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

cdConsig Numérico(06) Código da consignatária X
cdSenhaConsig Alfanumérico(12) Senha da consignatária X
Data e hora para início da
pesquisa de anuência dos
dataHora Data e Hora X
contratos no formato
DD/MM/AAAA HH:MM:SS
Código com informação do
cursor para realizar a
busca dos próximos 480
contratos. Deve ser
informado vazio na
primeira requisição.
Sempre que o campo
“cursorPaginacao” da
cursorPaginacao Alfanumérico(20) resposta da requisição não O
for vazia, significa que
existem mais contratos
para serem consultados.
Este valor retornado
deverá ser informado
neste campo
“cursorPaginacao” da
próxima requisição.

4.9.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

Data e hora do processamento da
dtOperacao Data operação no formato DD/MM/AAAA
HH:MM:SS.
cursorPaginacao Alfanumérico(20) Código com informação do cursor

54
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

para realizar a busca dos próximos

480 contratos. Se retornado vazio,
significa que todos os contratos
disponíveis já foram retornados. Se
retornado diferente de vazio, significa
que existem mais contratos para
serem consultados. Este valor
retornado deverá ser informado no
campo “cursorPaginacao” da próxima
requisição.
Tag agrupadora com informações do
contrato – Início (Uma ou mais ocorrências)
contrato dependente de anuência.
nrCpf Numérico(11) CPF do servidor ou pensionista
Código que identifica o tipo do
codTipoVinc Alfa(1) vínculo funcional. S – para servidor.
P – para pensionista.
Descrição do tipo do vínculo
descTipoVinc Alta(15)
funcional. Servidor ou Pensionista.
codOrgao Numérico(5) Código do órgão
cdMatricula Numérico(7) Matrícula do servidor ou pensionista
Órgão (numérico(5) + Matrícula do
orgMatInst Numérico(12)
Instituidor (numérico(07)
nrContrato Alfanumérico(20) Número do contrato a ser consultado
Código da situação do contrato. A –
cdSituacao Alfa(1) Aceito, R – Rejeitado, E – Anuência
Expirada.
Descrição da situação do contrato.
dsSituacao Alfa(20) Autorizado, Recusado, Anuência
Expirada.
dtEvento Data e Hora Data e hora da ocorrência do evento.
contrato – Fim
cdRetCode Numérico(04) Código de Retorno do serviço
dsRetCode Alfanumérico(220) Mensagem de Retorno do serviço

4.9.3. Lista de erros

Código Descrição
0000 Serviço realizado com sucesso.
2027 Data e hora não incorreta.
2027 Cursor de paginação incorreto.
2109 Data e hora não informada.
8010 Consignatária inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.

55
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

8089 CPF do servidor não informado.

8888 Serviço indisponível.

4.9.4. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarAnuenciaContratos>
<consultarAnuenciaContratosRequest>
<cdConsig>115</cdConsig>
<cdSenhaConsig>12345678</cdSenhaConsig>
<dataHora>21/10/2019 00:00:00</dataHora>
<cursorPaginacao>1234567890</cursorPaginacao>
</consultarAnuenciaContratosRequest>
</urn:consultarAnuenciaContratos>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarAnuenciaContratosResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dtOperacao>
<cursorPaginacao>9876543210</cursorPaginacao>

<contrato>
<nrCpf>12345678901</nrCpf>
<codTipoVinc>S</codTipoVinc>

56
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst>
</orgMatInst>
<nrContrato>111</nrContrato>
<cdSituacao>A</cdSituacao>
<dsSituacao>Aceito</dsSituacao>
<dtEvento>21/10/2019 10:00:00</dtEvento>
</contrato>
<contrato>
<nrCpf>11111111111</nrCpf>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>25000</codOrgao>
<cdMatricula>7654321</cdMatricula>
<orgMatInst>
</orgMatInst>
<nrContrato>333</nrContrato>
<cdSituacao>R</cdSituacao>
<dsSituacao>Rejeitado</dsSituacao>
<dtEvento>21/10/2019 11:00:00</dtEvento>
</contrato>
<contrato>
<nrCpf>99999999999</nrCpf>
<codTipoVinc>P</codTipoVinc>
<descTipoVinc>Pensionista</descTipoVinc>
<codOrgao>16000</codOrgao>
<cdMatricula>16579341</cdMatricula>
<orgMatInst>160005559871</orgMatInst>
<nrContrato>444</nrContrato>
<cdSituacao>E</cdSituacao>
<dsSituacao>Anuência Expirada</dsSituacao>
<dtEvento>21/10/2019 23:59:59</dtEvento>
</contrato>

57
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarAnuenciaContratosResponse>
</soap:Body>
</soap:Envelope>

4.10. Operação consultarContrato (Disponível na Versão V2)

Operação responsável em consultar as informações de um contrato de um servidor

ou pensionista específico.

4.10.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

cdConsig Numérico(06) Código da consignatária X
cdSenhaConsig Alfanumérico(12) Senha da consignatária X
CPF do servidor ou
nrCpf Numérico(14) X
pensionista
nrContrato Alfanumérico(20) Número do contrato X

4.10.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

Data e hora do processamento da
dtOperacao Data operação no formato DD/MM/AAAA
HH:MM:SS.
Tag agrupadora com as informações
contrato – Início (Uma ou mais ocorrências)
do contrato.
Código que identifica o tipo do
codTipoVinc Alfa(1) vínculo funcional. S – para servidor.
P – para pensionista.
Descrição do tipo do vínculo
descTipoVinc Alta(15)
funcional. Servidor ou Pensionista.
codOrgao Numérico(5) Código do órgão
nmOrgao Alfa(60) Nome do órgão
cdMatricula Numérico(7) Matrícula do servidor ou pensionista
orgMatInst Numérico(12) Órgão (numérico(5)) + Matrícula do

58
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Instituidor (numérico(07)). Informação

preenchida somente para vínculos
funcionais de pensionistas.
cdRubrica Numérico(5) Código da rubrica
dsRubrica Alfa(60) Descrição da rubrica
nrSequencia Numerico(1) Número da Sequência do Contrato
Código do convênio que identifica o
cdConvenio Numérico(6)
tipo de produto/serviço alvo da ação
nrContrato Alfanumérico(20) Número do contrato
Código da situação do contrato -
cdSituacao Numérico(06) Verificar o item 4.2 Tipos
Personalizados deste documento.
Descrição da situação do contrato -
dsSituacao Alfanumérico(15) Verificar o item 4.2 Tipos
Personalizados deste documento.
Número do contrato que renovou
nrContratoRenovadoPor Alfanumérico(20)
este contrato.
Valor bruto da operação. Obrigatório
somente para contratos do tipo de
vlBruto Alfanumérico(13,2)
consignação de empréstimo.
Exemplo: 100000 para R$ 1.000,00.
Valor líquido creditado ao servidor ou
pensionista da operação. Obrigatório
vlLiquido Alfanumérico(13,2) somente para contratos do tipo de
consignação de empréstimo.
Exemplo: 100000 para R$ 1.000,00.
Valor de desconto mensal.
vlDesconto Alfanumérico(13,2)
Exemplo: 100000 para R$ 1.000,00.
Prazo em meses de desconto.
pzDesconto Numérico(3) Informar 0 (zero) para prazo
indeterminado
Taxa de juros mensal do contrato.
Exemplo: 1150 para 11,50%.
txJurosMensal Alfanumérico(3,2) Obrigatório somente para contratos
do tipo de consignação de
empréstimo.
Valor do IOF cobrado. Exemplo: 120
para R$ 1,20. Obrigatório somente
iof Alfanumérico(3,2)
para contratos do tipo de
consignação de empréstimo.
Custo efetivo total do contrato.
Exemplo: 2000 para 20%. Obrigatório
cet Alfanumérico(3,2)
somente para contratos do tipo de
consignação de empréstimo.
Tag agrupadora com as informações
contratosRenovados – Início dos contratos renovados por este
contrato.
nrContrato (Uma ou mais
Alfanumérico(20) Número do contrato a ser renovado.
ocorrências)

59
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

contratosRenovados – Fim
Tag agrupadora com as informações
do contrato portado. Informações
contratoPortado – Início disponíveis somente se o contrato é
referente a uma portabilidade de
empréstimo.
CNPJ da consignatária proprietária
nrCnpj Numérico(14)
dos contratos a serem portados.
Razão social da consignatária
nmConsignataria Alfa(60) proprietária dos contratos a serem
portados.
nrContrato Alfanumérico(20) Número do contrato a ser portado.
contratoPortado – Fim
Valor do percentual a ser utilizado no
vlPercentual Alfanumérico(3,2) cálculo do valor de desconto.
Exemplo: 1150 para 11,5 %
Código do assunto de cálculo a ser
cdAssuntoCalculo Numérico(2) utilizado no cálculo do valor de
desconto.
Tag agrupadora com as rubricas a
serem utilizadas no cálculo do valor
de desconto. Se informado este
campo, o campo “vlPercentual”
rubricas - Início
também deverá ser informado e os
campos “cdAssuntoCalculo” e
“vlDesconto” não deverão ser
informados.
cdRubrica (Uma ou mais
Numérico(5) Código da rubrica
ocorrências)
rubricas - Fim
Data e hora da inclusão do contrato
dtInclusao Data e Hora
no formato DD/MM/AAAA HH:MM:SS
Data e hora da anuência do servidor
dtAnuencia Data e Hora
no formato DD/MM/AAAA HH:MM:SS
Data e hora da efetivação da
dtEfetPortabilidade Data e Hora portabilidade do contrato no formato
DD/MM/AAAA HH:MM:SS
Ano + Mês do primeiro desconto do
anoMesPrimDesc Numérico(6)
contrato.
Ano + Mês do último desconto do
anoMesUltDesc Numérico(6)
contrato.
Tag agrupadora com os e-mails que
serão notificados após a realização
emailsParaNotificacaoAnuencia – Inicio
da anuência do contrato pelo servidor
ou pensionista
email (Uma ou mais
Alfanumérico(100) Email a ser notificado.
ocorrências)
emailsParaNotificacaoAnuencia – Fim
urlAceite Alfanumérico(250) URL da API disponível da

60
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

consignatária para ser acionada pelo

SERPRO após o aceite do contrato
pelo servidor ou pensionista.
Informação presente somente para
contratos de empréstimo.
URL da API disponível da
consignatária para ser acionada pelo
SERPRO após a recusa do contrato
urlRecusa Alfanumérico(250)
pelo servidor ou pensionista.
Informação presente somente para
contratos de empréstimo.
Data limite para o servidor aceitar ou
rejeitar o contrato proposto no
dtValidadeAnuencia Data formato DD/MM/AAAA. Obrigatório
somente para contratos de
empréstimo.
Data de início do processo de
portabilidade no CIP no formato DD/
dtInicioProcessoCip Data MM/AAAA. Informação disponível
somente para contratos de
portabilidade.
Número que identifica o processo da
portabilidade no CIP. Informação
nrProcessoCip Alfanumérico(20)
disponível somente para contratos de
portabilidade.
contrato - Fim
cdRetCode Numérico(04) Código de Retorno do serviço
dsRetCode Alfanumérico(220) Mensagem de Retorno do serviço

4.10.3. Lista de erros

Código Descrição
0000 Serviço realizado com sucesso.
2027 Número do contrato incorreto.
2109 CPF não informado.
2109 Número do contrato não informado.
8010 Consignatária inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

61
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.10.4. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarContrato>
<consultarContratoRequest>
<cdConsig>115</cdConsig>
<cdSenhaConsig>12345678</cdSenhaConsig>
<nrCpf>99999999999</nrCpf>
<nrContrato>101</nrContrato>
</consultarContratoRequest>
</urn:consultarContrato>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada para Contratos de Empréstimo:

62
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<dsRubrica>EMPREST BCO OFICIAL - BCO BRAS</dsRubrica>

<nrSequencia>1</nrSequencia>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<cdSituacao>3</cdSituacao>
<dsSituacao>Ativo</dsSituacao>
<vlBruto>6000000</vlBruto>
<vlLiquido>4500000</vlLiquido>
<vlDesconto>100000</vlDesconto>
<pzDesconto>12</pzDesconto>
<txJurosMensal>1150</txJurosMensal>
<iof>120</iof>
<cet>2000</cef>
<dtInclusao>10/10/2019 12:00:00</dtInclusao>
<dtAnuencia>10/10/2019 17:00:00</dtAnuencia>
<anoMesPrimDesc>201910</anoMesPrimDesc>
<anoMesUltDesc>202009</anoMesUltDesc>
<emailsParaNotificacaoAnuencia>

<email>teste1@teste.com.br</email>
<email>teste2@teste.com.br</email>
</emailsParaNotificacaoAnuencia>
<urlAceite>https://consignataria.com.br/consignasiape/12345/698dc19d489c4e4db73e28a71
3eab07b</urlAceite>
<urlRecusa>https://consignataria.com.br/consignasiape/54321/38851536d87701d2191990e2
4a7f8d4e</urlRecusa>
<dtValidadeAnuencia>10/10/2019</dtValidadeAnuencia>
</contrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarContratoResponse>
</soap:Body>
</soap:Envelope>

63
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Retorno da chamada para Contratos de Empréstimo originados por uma renovação:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dataOperacao>
<contrato>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdRubrica>34116</cdRubrica>
<dsRubrica>EMPREST BCO OFICIAL - BCO BRAS</dsRubrica>
<nrSequencia>1</nrSequencia>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<cdSituacao>3</cdSituacao>
<dsSituacao>Ativo</dsSituacao>
<vlBruto>6000000</vlBruto>
<vlLiquido>4500000</vlLiquido>
<vlDesconto>100000</vlDesconto>
<pzDesconto>12</pzDesconto>
<txJurosMensal>1150</txJurosMensal>
<iof>120</iof>
<cet>2000</cef>
<contratosRenovados>
<nrContrato>111</nrContrato>
<nrContrato>222</nrContrato>

64
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</contratosRenovados>
<dtInclusao>10/10/2019 12:00:00</dtInclusao>
<dtAnuencia>10/10/2019 17:00:00</dtAnuencia>
<anoMesPrimDesc>201910</anoMesPrimDesc>
<anoMesUltDesc>202009</anoMesUltDesc>
<emailsParaNotificacaoAnuencia>

<email>teste1@teste.com.br</email>
<email>teste2@teste.com.br</email>
</emailsParaNotificacaoAnuencia>
<urlAceite>https://consignataria.com.br/consignasiape/12345/698dc19d489c4e4db73e28a71
3eab07b</urlAceite>
<urlRecusa>https://consignataria.com.br/consignasiape/54321/38851536d87701d2191990e2
4a7f8d4e</urlRecusa>
<dtValidadeAnuencia>10/10/2019</dtValidadeAnuencia>
</contrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarContratoResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Contratos de Empréstimo na situação Renovada:

65
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdRubrica>34116</cdRubrica>
<dsRubrica>EMPREST BCO OFICIAL - BCO BRAS</dsRubrica>
<nrSequencia>1</nrSequencia>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<cdSituacao>4</cdSituacao>
<dsSituacao>Renovado</dsSituacao>
<nrContratoRenovadoPor>222</nrContratoRenovadoPor>
<vlBruto>6000000</vlBruto>
<vlLiquido>4500000</vlLiquido>
<vlDesconto>100000</vlDesconto>
<pzDesconto>12</pzDesconto>
<txJurosMensal>1150</txJurosMensal>
<iof>120</iof>
<cet>2000</cef>
<dtInclusao>10/10/2019 12:00:00</dtInclusao>
<dtAnuencia>10/10/2019 17:00:00</dtAnuencia>
<anoMesPrimDesc>201910</anoMesPrimDesc>
<anoMesUltDesc>202009</anoMesUltDesc>
<emailsParaNotificacaoAnuencia>

<email>teste1@teste.com.br</email>
<email>teste2@teste.com.br</email>
</emailsParaNotificacaoAnuencia>
<urlAceite>https://consignataria.com.br/consignasiape/12345/698dc19d489c4e4db73e28a71
3eab07b</urlAceite>
<urlRecusa>https://consignataria.com.br/consignasiape/54321/38851536d87701d2191990e2
4a7f8d4e</urlRecusa>
<dtValidadeAnuencia>10/10/2019</dtValidadeAnuencia>
</contrato>

66
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarContratoResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Contratos de Empréstimo originados por uma

Portabilidade:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dataOperacao>
<contrato>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdRubrica>34116</cdRubrica>
<dsRubrica>EMPREST BCO OFICIAL - BCO BRAS</dsRubrica>
<nrSequencia>1</nrSequencia>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<cdSituacao>1</cdSituacao>
<dsSituacao>Ativo</dsSituacao>
<vlBruto>6000000</vlBruto>

67
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<vlLiquido>4500000</vlLiquido>
<vlDesconto>100000</vlDesconto>
<pzDesconto>12</pzDesconto>
<txJurosMensal>1150</txJurosMensal>
<iof>120</iof>
<cet>2000</cef>
<contratoPortado>
<nrCnpj>12345678901234</nrCnpj>
<nmConsignataria>CONSIGNATARIA XYZ</nmConsignataria>
<nrContrato>XYZ111</nrContrato>
</contratoPortado>
<dtInclusao>10/10/2019 12:00:00</dtInclusao>
<dtEfetPortabilidade>11/10/2019 18:00:00</dtEfetPortabilidade>
<anoMesPrimDesc>201911</anoMesPrimDesc>
<anoMesUltDesc>202010</anoMesUltDesc>
<dtInicioProcessoCip>27/11/2019</dtInicioProcessoCip>
<nrProcessoCip>A234567890B234567890</nrProcessoCip>
</contrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarContratoResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Contrato de mensalidade de sindicatos, associações,

operadoras de plano de saúde, seguros, previdência e cooperativas com valor fixo:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[

68
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<?xml version="1.0" encoding="iso-8859-1"?>

<response>
<dtOperacao>21/10/2019 12:30:00</dataOperacao>
<contrato>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdRubrica>34284</cdRubrica>
<dsRubrica>MENSALIDADE SINDICAL - SINPOL/</dsRubrica>
<nrSequencia>1</nrSequencia>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<cdSituacao>3</cdSituacao>
<dsSituacao>Ativo</dsSituacao>
<vlDesconto>100000</vlDesconto>
<pzDesconto>0</pzDesconto>
<dtInclusao>10/10/2019 12:00:00</dtInclusao>
<anoMesPrimDesc>201910</anoMesPrimDesc>
</contrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarContratoResponse>
</soap:Body>
</soap:Envelope>

69
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Retorno da chamada para Contrato de mensalidade de sindicatos, associações,

operadoras de plano de saúde, seguros, previdência e cooperativas com com assunto
de cálculo e percentual:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dataOperacao>
<contrato>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdRubrica>34284</cdRubrica>
<dsRubrica>MENSALIDADE SINDICAL - SINPOL/</dsRubrica>
<nrSequencia>1</nrSequencia>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<cdSituacao>3</cdSituacao>
<dsSituacao>Ativo</dsSituacao>
<pzDesconto>0</pzDesconto>
<vlPercentual>515</vlPercentual>
<cdAssuntoCalculo>1</cdAssuntoCalculo>
<dtInclusao>10/10/2019 12:00:00</dtInclusao>
<anoMesPrimDesc>201910</anoMesPrimDesc>
</contrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>

70
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</return>
</ns1:consultarContratoResponse>
</soap:Body>
</soap:Envelope>

Retorno da chamada para Contrato de mensalidade de sindicatos, associações,

operadoras de plano de saúde, seguros, previdência e cooperativas com com assunto
de cálculo, rubricas e percentual:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dtOperacao>21/10/2019 12:30:00</dataOperacao>
<contrato>
<codTipoVinc>S</codTipoVinc>
<descTipoVinc>Servidor</descTipoVinc>
<codOrgao>17000</codOrgao>
<nmOrgao>MINISTERIO DA ECONOMIA</nmOrgao>
<cdMatricula>1234567</cdMatricula>
<orgMatInst></orgMatInst>
<cdRubrica>34284</cdRubrica>
<dsRubrica>MENSALIDADE SINDICAL - SINPOL/</dsRubrica>
<nrSequencia>1</nrSequencia>
<cdConvenio>101</cdConvenio>
<nrContrato>111</nrContrato>
<cdSituacao>3</cdSituacao>
<dsSituacao>Ativo</dsSituacao>
<pzDesconto>0</pzDesconto>
<vlPercentual>515</vlPercentual>
<cdAssuntoCalculo>26</cdAssuntoCalculo>
<rubricas>

71
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<cdRubrica>1</cdRubrica>
<cdRubrica>2</cdRubrica>
<cdRubrica>3</cdRubrica>
</rubricas>
<dtInclusao>10/10/2019 12:00:00</dtInclusao>
<anoMesPrimDesc>201910</anoMesPrimDesc>
</contrato>
<cdRetCode>0000</cdRetCode>
<dsRetCode>Serviço realizado com sucesso.</dsRetCode>
</response>
]]>
</return>
</ns1:consultarContratoResponse>
</soap:Body>
</soap:Envelope>

4.11. Operação consultarVinculoMargemPorCPF (Disponível na Versão

V1)

Esta operação foi descontinuada na Versão V2 do web service. Ela será substituída
pela nova operação “consultarAutorizacoesMargemConsignavel”.
Operação responsável em consultar somente margem consignável para consignações
facultativas (30%) de cada vínculo funcional do servidor público. Para consultar, além da
margem facultativa, a margem consignável de cartão (5%) será necessário acionar as
operações consultarMargemPorCPFV1 ou consultarVinculoMargemPorCPFV1, as quais
retornam ambos valores de margem.
O valor da margem consignável somente será recuperada se existir uma autorização
vigente do servidor público para a consignatária realizar a consulta.
Foi mantida a mesma assinatura da operação já existente no sistema ESCA da
empresa CONSIST com o objetivo de causar o menor impacto possível às consignatárias
que já faziam uso desta operação.
A diferença entre esta operação e a operação consultarMargemPorCPF é que esta
última retorna alguns campos a mais. São eles: “dt_prim_desc”, “cd_upag_serv”,
“cd_uf_upag_serv”, “bloqueio_judicial”, “cd_ret_code_matricula ” e “ds_ret_code_matricula”.

72
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.11.1. Parâmetros de Entrada

Campos EstruturaDescrição Preenchimento

CD_CIA Alfanumérico(03)
Código da companhia -
CD_EMPRESA Alfanumérico(03)
Código da empresa -
CD_ORGAO Alfanumérico(10)
Código do órgão -
NR_CNPJ_ORGAO Numérico(15)
CNPJ do órgão -
NR_CPF_A Numérico(14)
CPF do servidor X
CD_CONSIG Numérico(06)
Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12)
Senha da consignatária X
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
Transação (COT) -
CD_ORIGEM_TRANS Numérico(02) Verificar o item 4.2 Tipos X
Personalizados deste
documento.
CD_SENHA_SERVIDOR Numérico(08) Senha do servidor -
IN_REG_HOLD Alfanumérico(01) ‘S’ Para Registro em Hold H
Identificação do Reg. em
CD_TRAN_HOLD_SERV Alfanumérico(20) -
Hold

4.11.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

dados_matricula - array
cd_orgao Alfanumérico(10) Código do órgão
nr_cnpj_orgao Numérico(15) CNPJ do órgão
cd_matricula Alfanumérico(13) Matrícula do servidor
Id_unica Alfanumérico(20) Identificação Única
org_mat_inst Alfanumérico(12) Dados do Instituidor *
Mantido apenas para não quebrar
vl_margem_consig Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_utiliz Numérico(13,2) interface, sempre retorna
000000000000000
Valor de Margem Disponível
vl_margem_disp Numérico(13,2)
(vl_margem_consig – vl_margem_utiliz)
Mantido apenas para não quebrar
vl_margem_fixa Numérico(13,2) interface, sempre retorna
000000000000000
vl_margem_var Numérico(13,2) Mantido apenas para não quebrar
interface, sempre retorna

73
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

000000000000000
Mantido apenas para não quebrar
vl_margem_disp_fixa Numérico(13,2) interface, sempre retorna
000000000000000
Fim dados_matricula - array
cd_ret_code Numérico(04) Código de Retorno do serviço
ds_ret_code Alfanumérico(220) Mensagem de Retorno do serviço

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))
Obs.: A tag “dados_matricula” pode ocorrer N vezes.

4.11.3. Lista de erros herdados da Consist

Código Descrição
0000 Serviço realizado com sucesso.
0087 Senha do funcionário expirada ou bloqueada
0087 Consignatária não autorizada a consignar pelo servidor/pensionista.
Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
2035 Servidor inativo.
2048 Servidor falecido.
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8028 Código de origem da transação incorreto.
8030 Código identificação servidor incorreto.
8035 Registro Hold incorreto.
8036 Consignatária incorreta.
8039 Senha do funcionário incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8084 Senha do servidor da transação não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8111 Código de origem da transação não informado.
8112 Código identificação servidor não informado.
8888 Serviço indisponível.

74
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.11.4. Lista de novos erros

Código* Descrição**
4007 Situação do servidor não permite consignação.

* (cd_ret_code)
** (ds_ret_code)

4.11.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarVinculoMargemPorCPF>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<NR_CNPJ_ORGAO></NR_CNPJ_ORGAO>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG>115</CD_CONSIG>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<IN_REG_HOLD></IN_REG_HOLD>
<CD_TRAN_HOLD_SERV></CD_TRAN_HOLD_SERV>
</urn:consultarVinculoMargemPorCPF>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

75
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<ns1:consultarVinculoMargemPorCPFResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dados_matricula>
<cd_orgao>13000</cd_orgao>
<nr_cnpj_orgao>00489828000236</nr_cnpj_orgao>
<cd_matricula>897</cd_matricula>
<id_unica>1310684</id_unica>
<org_mat_inst></org_mat_inst>
<vl_margem_consig>000000000000000</vl_margem_consig>
<vl_margem_utiliz>000000000000000</vl_margem_utiliz>
<vl_margem_disp>00000122005</vl_margem_disp>
<vl_margem_fixa>000000000000000</vl_margem_fixa>
<vl_margem_var>000000000000000</vl_margem_var>
<vl_margem_disp_fixa>000000000000000</vl_margem_disp_fixa>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code></ds_ret_code>
</dados_matricula>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:consultarVinculoMargemPorCPFResponse>
</soap:Body>
</soap:Envelope>

4.12. Operação consultarMargemPorCPF (Disponível na Versão V1)

76
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

margem facultativa, a margem consignável de cartão (5%) será necessário acionar as

operações consultarMargemPorCPFV1 ou consultarVinculoMargemPorCPFV1.
O valor da margem consignável somente será recuperada se existir uma autorização
vigente do servidor público para a consignatária realizar a consulta.
Foi mantida a mesma assinatura da operação já existente no sistema ESCA da
empresa CONSIST com o objetivo de causar o menor impacto possível às consignatárias
que já faziam uso desta operação.
A diferença entre esta operação e a operação consultarVinculoMargemPorCPF é que
esta primeira retorna alguns campos a mais. São eles: “dt_prim_desc”, “cd_upag_serv”,
“cd_uf_upag_serv”, “bloqueio_judicial”, “cd_ret_code_matricula ” e “ds_ret_code_matricula”.

4.12.1. Parâmetros de Entrada

Campos Estrutura
Descrição Preenchimento
CD_CIA Alfanumérico(03)
Código da companhia -
CD_EMPRESA Alfanumérico(03)
Código da empresa -
CD_ORGAO Alfanumérico(10)
Código do órgão -
NR_CNPJ_ORGAO Numérico(15)
CNPJ do órgão -
NR_CPF_A Numérico(14)
CPF do servidor X
CD_CONSIG Numérico(06)
Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12)
Senha da consignatária X
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
Transação (COT) -
CD_ORIGEM_TRANS Numérico(02) Verificar o item 4.2 Tipos X
Personalizados deste
documento.
CD_SENHA_SERVIDOR Numérico(08) Senha do servidor -
IN_REG_HOLD Alfanumérico(01) ‘S’ Para Registro em Hold H
CD_TRAN_HOLD_SER Identificação do Reg. em
Alfanumérico(20) -
V Hold

4.12.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

dados_matricula - array
cd_orgao Alfanumérico(10) Código do órgão
nr_cnpj_orgao Numérico(15) CNPJ do órgão
cd_matricula Alfanumérico(13) Matrícula do servidor

77
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Id_unica Alfanumérico(20) Identificação Única

org_mat_inst Alfanumérico(12) Dados do Instituidor *
Mantido apenas para não quebrar
vl_margem_consig Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_utiliz Numérico(13,2) interface, sempre retorna
000000000000000
Valor de Margem Disponível
vl_margem_disp Numérico(13,2)
(vl_margem_consig – vl_margem_utiliz)
Mantido apenas para não quebrar
vl_margem_fixa Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_var Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_disp_fixa Numérico(13,2) interface, sempre retorna
000000000000000
Ano/mês do primeiro desconto do contrato
dt_prim_desc Numerico(6)
(AAAAMM)
cd_upag_serv Numérico(14) Código da UPAG**
cd_uf_upag_serv Alfanumérico(2) Código da UF da UPAG
Indicador de bloqueio judicial Se houver
algum contrato bloqueado por suspensão
bloqueio_judicial Alfanumérico(1) judicial da matrícula/consignatária em
questão o campo retornará ‘S’ caso
contrário retornará branco.
Mantido apenas para não quebrar
cd_ret_code_matricula Numérico(04)
interface, sempre retorna 0000
Mantido apenas para não quebrar
ds_ret_code_matricula Alfanumérico(220)
interface, sempre retorna vazio
Fim dados_matricula - array
cd_ret_code Numérico(04) Código de Retorno do serviço
ds_ret_code Alfanumérico(220) Mensagem de Retorno do serviço

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))
** O campo “cd_upag_serv” é formado de: Órgão(Numérico (05)) + Upag (Numérico (09))
Obs.: A tag “dados_matricula” pode ocorrer N vezes.

4.12.3. Lista de erros herdados da Consist

Código* Descrição**
0000 Serviço realizado com sucesso.
0087 Senha do funcionário expirada ou bloqueada

78
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

0087 Consignatária não autorizada a consignar pelo servidor/pensionista.

Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
2035 Servidor inativo.
2048 Servidor falecido.
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8028 Código de origem da transação incorreto.
8030 Código identificação servidor incorreto.
8035 Registro Hold incorreto.
8036 Consignatária incorreta.
8039 Senha do funcionário incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8084 Senha do servidor da transação não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8111 Código de origem da transação não informado.
8112 Código identificação servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.12.4. Lista de novos erros

Código* Descrição**
4007 Situação do servidor não permite consignação.

* (cd_ret_code)
** (ds_ret_code)

4.12.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarMargemPorCPF>

79
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<NR_CNPJ_ORGAO></NR_CNPJ_ORGAO>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG>115</CD_CONSIG>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<IN_REG_HOLD></IN_REG_HOLD>
<CD_TRAN_HOLD_SERV></CD_TRAN_HOLD_SERV>
</urn:consultarMargemPorCPF>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarMargemPorCPFResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dados_matricula>
<cd_orgao>13000</cd_orgao>
<nr_cnpj_orgao>00489828000236</nr_cnpj_orgao>
<cd_matricula>897</cd_matricula>
<id_unica>1310684</id_unica>
<org_mat_inst></org_mat_inst>
<vl_margem_consig>000000000000000</vl_margem_consig>
<vl_margem_utiliz>000000000000000</vl_margem_utiliz>
<vl_margem_disp>00000122005</vl_margem_disp>
<vl_margem_fixa>000000000000000</vl_margem_fixa>

80
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<vl_margem_var>000000000000000</vl_margem_var>
<vl_margem_disp_fixa>000000000000000</vl_margem_disp_fixa>
<dt_prim_desc>201704</dt_prim_desc>
<cd_upag_serv>13000000056934</cd_upag_serv>
<cd_uf_upag_serv>DF</cd_uf_upag_serv>
<bloqueio_judicial>N</bloqueio_judicial>
<cd_ret_code_matricula>0000</cd_ret_code_matricula>
<ds_ret_code_matricula></ds_ret_code_matricula>
</dados_matricula>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:consultarMargemPorCPFResponse>
</soap:Body>
</soap:Envelope>

4.13. Operação consultarVinculoMargemPorCPFV1 (Disponível na Versão

V1)

4.13.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CIA Alfanumérico(03) Código da companhia -

81
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

CD_EMPRESA Alfanumérico(03)
Código da empresa -
CD_ORGAO Alfanumérico(10)
Código do órgão -
NR_CNPJ_ORGAO Numérico(15)
CNPJ do órgão -
NR_CPF_A Numérico(14)
CPF do servidor X
CD_CONSIG Numérico(06)
Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12)
Senha da consignatária X
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
Transação (COT) - Verificar
CD_ORIGEM_TRANS Numérico(02) o item 4.2 Tipos X
Personalizados deste
documento.
CD_SENHA_SERVIDOR Numérico(08) Senha do servidor -
IN_REG_HOLD Alfanumérico(01) ‘S’ Para Registro em Hold H
CD_TRAN_HOLD_SER Identificação do Reg. em
Alfanumérico(20) -
V Hold

4.13.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

dados_matricula - array
cd_orgao Alfanumérico(10) Código do órgão
nr_cnpj_orgao Numérico(15) CNPJ do órgão
cd_matricula Alfanumérico(13) Matrícula do servidor
Id_unica Alfanumérico(20) Identificação Única
org_mat_inst Alfanumérico(12) Dados do Instituidor *
Mantido apenas para não quebrar
vl_margem_consig Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_utiliz Numérico(13,2) interface, sempre retorna
000000000000000
Valor de Margem Disponível **
vl_margem_disp Numérico(13,2)
(vl_margem_consig – vl_margem_utiliz)
Valor de Margem de Cartão Consignado
vl_margem_cartao_disp Numérico(13,2)
Disponível ***
Mantido apenas para não quebrar
vl_margem_fixa Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_var Numérico(13,2) interface, sempre retorna
000000000000000
vl_margem_disp_fixa Numérico(13,2) Mantido apenas para não quebrar

82
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

interface, sempre retorna

000000000000000
Fim dados_matricula - array
cd_ret_code Numérico(04) Código de Retorno do serviço
ds_ret_code Alfanumérico(220) Mensagem de Retorno do serviço

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))
** O campo “vl_margem_disp” somente será retornado se existir autorização cadastrada
pelo servidor para o tipo de consignação específico.
*** O campo “vl_margem_cartao_disp” somente será retornado se existir autorização
cadastrada pelo servidor para o tipo de consignação de cartão consignado.
Obs.: A tag “dados_matricula” pode ocorrer N vezes.

4.13.3. Lista de erros herdados da Consist

Código* Descrição**
0000 Serviço realizado com sucesso.
0087 Senha do funcionário expirada ou bloqueada
0087 Consignatária não autorizada a consignar pelo servidor/pensionista.
Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
2035 Servidor inativo.
2048 Servidor falecido.
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8028 Código de origem da transação incorreto.
8030 Código identificação servidor incorreto.
8035 Registro Hold incorreto.
8036 Consignatária incorreta.
8039 Senha do funcionário incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8084 Senha do servidor da transação não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8111 Código de origem da transação não informado.
8112 Código identificação servidor não informado.
8888 Serviço indisponível.

83
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.13.4. Lista de novos erros

Código* Descrição**
4007 Situação do servidor não permite consignação.

* (cd_ret_code)
** (ds_ret_code)

4.13.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarVinculoMargemPorCPFV1>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<NR_CNPJ_ORGAO></NR_CNPJ_ORGAO>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG>115</CD_CONSIG>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<IN_REG_HOLD></IN_REG_HOLD>
<CD_TRAN_HOLD_SERV></CD_TRAN_HOLD_SERV>
</urn:consultarVinculoMargemPorCPFV1>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

84
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<ns1:consultarVinculoMargemPorCPFV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dados_matricula>
<cd_orgao>13000</cd_orgao>
<nr_cnpj_orgao>00489828000236</nr_cnpj_orgao>
<cd_matricula>897</cd_matricula>
<id_unica>1310684</id_unica>
<org_mat_inst></org_mat_inst>
<vl_margem_consig>000000000000000</vl_margem_consig>
<vl_margem_utiliz>000000000000000</vl_margem_utiliz>
<vl_margem_disp>00000122005</vl_margem_disp>
<vl_margem_cartao_disp>00000025001</vl_margem_cartao_disp>
<vl_margem_fixa>000000000000000</vl_margem_fixa>
<vl_margem_var>000000000000000</vl_margem_var>
<vl_margem_disp_fixa>000000000000000</vl_margem_disp_fixa>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code></ds_ret_code>
</dados_matricula>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:consultarVinculoMargemPorCPFV1Response>
</soap:Body>
</soap:Envelope>

4.14. Operação consultarMargemPorCPFV1 (Disponível na Versão V1)

85
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

facultativas (30%) e margem consignável de cartão (5%) de cada vínculo funcional do

servidor público.
Os valores das margens consignáveis somente serão recuperadas se existir uma
autorização vigente do servidor público para a consignatária realizar a consulta.
A diferença entre esta operação e a operação consultarVinculoMargemPorCPFV1 é
que esta primeira retorna alguns campos a mais. São eles: “dt_prim_desc”, “cd_upag_serv”,
“cd_uf_upag_serv”, “bloqueio_judicial”, “cd_ret_code_matricula ” e “ds_ret_code_matricula”.

4.14.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CIA Alfanumérico(03) Código da companhia -
CD_EMPRESA Alfanumérico(03) Código da empresa -
CD_ORGAO Alfanumérico(10) Código do órgão -
NR_CNPJ_ORGAO Numérico(15) CNPJ do órgão -
NR_CPF_A Numérico(14) CPF do servidor X
CD_CONSIG Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
Transação (COT) -
CD_ORIGEM_TRANS Numérico(02) Verificar o item 4.2 Tipos X
Personalizados deste
documento.
CD_SENHA_SERVIDOR Numérico(08) Senha do servidor -
IN_REG_HOLD Alfanumérico(01) ‘S’ Para Registro em Hold H
CD_TRAN_HOLD_SER Identificação do Reg. em
Alfanumérico(20) -
V Hold

4.14.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

86
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

000000000000000
Mantido apenas para não quebrar
vl_margem_utiliz Numérico(13,2) interface, sempre retorna
000000000000000
Valor de Margem Disponível **
vl_margem_disp Numérico(13,2)
(vl_margem_consig – vl_margem_utiliz)
Valor de Margem de Cartão Consignado
vl_margem_cartao_disp Numérico(13,2)
Disponível ***
Mantido apenas para não quebrar
vl_margem_fixa Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_var Numérico(13,2) interface, sempre retorna
000000000000000
Mantido apenas para não quebrar
vl_margem_disp_fixa Numérico(13,2) interface, sempre retorna
000000000000000
Ano/mês do primeiro desconto do contrato
dt_prim_desc Numerico(6)
(AAAAMM)
cd_upag_serv Numérico(14) Código da UPAG****
cd_uf_upag_serv Alfanumérico(2) Código da UF da UPAG
Indicador de bloqueio judicial Se houver
algum contrato bloqueado por suspensão
bloqueio_judicial Alfanumérico(1) judicial da matrícula/consignatária em
questão o campo retornará ‘S’ caso
contrário retornará branco.
Mantido apenas para não quebrar
cd_ret_code_matricula Numérico(04)
interface, sempre retorna 0000
Mantido apenas para não quebrar
ds_ret_code_matricula Alfanumérico(220)
interface, sempre retorna vazio
Fim dados_matricula - array
cd_ret_code Numérico(04) Código de Retorno do serviço
ds_ret_code Alfanumérico(220) Mensagem de Retorno do serviço

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))
** O campo “vl_margem_disp” somente será retornado se existir autorização cadastrada
pelo servidor para o tipo de consignação específico.
*** O campo “vl_margem_cartao_disp” somente será retornado se existir autorização
cadastrada pelo servidor para o tipo de consignação de cartão consignado.
**** O campo “cd_upag_serv” é formado de: Órgão(Numérico (05)) + Upag (Numérico (09))
Obs.: A tag “dados_matricula” pode ocorrer N vezes.

87
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.14.3. Lista de erros herdados da Consist

* (cd_ret_code)
** (ds_ret_code)

4.14.4. Lista de novos erros

Código* Descrição**
4007 Situação do servidor não permite consignação.
4044 CPF não cadastrado no SIAPE

* (cd_ret_code)
** (ds_ret_code)

88
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.14.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarMargemPorCPFV1>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<NR_CNPJ_ORGAO></NR_CNPJ_ORGAO>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG>115</CD_CONSIG>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<IN_REG_HOLD></IN_REG_HOLD>
<CD_TRAN_HOLD_SERV></CD_TRAN_HOLD_SERV>
</urn:consultarMargemPorCPFV1>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarMargemPorCPFV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dados_matricula>
<cd_orgao>13000</cd_orgao>
<nr_cnpj_orgao>00489828000236</nr_cnpj_orgao>

89
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<cd_matricula>897</cd_matricula>
<id_unica>1310684</id_unica>
<org_mat_inst></org_mat_inst>
<vl_margem_consig>000000000000000</vl_margem_consig>
<vl_margem_utiliz>000000000000000</vl_margem_utiliz>
<vl_margem_disp>00000122005</vl_margem_disp>
<vl_margem_cartao_disp>00000025001</vl_margem_cartao_disp>
<vl_margem_fixa>000000000000000</vl_margem_fixa>
<vl_margem_var>000000000000000</vl_margem_var>
<vl_margem_disp_fixa>000000000000000</vl_margem_disp_fixa>
<dt_prim_desc>201704</dt_prim_desc>
<cd_upag_serv>13000000056934</cd_upag_serv>
<cd_uf_upag_serv>DF</cd_uf_upag_serv>
<bloqueio_judicial>N</bloqueio_judicial>
<cd_ret_code_matricula>0000</cd_ret_code_matricula>
<ds_ret_code_matricula></ds_ret_code_matricula>
</dados_matricula>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:consultarMargemPorCPFV1Response>
</soap:Body>
</soap:Envelope>

4.15. Operação alterarValorParcela (Disponível na Versão V1)

Esta operação foi descontinuada na Versão V2 do web service. Ela será substituída
pela nova operação “alterarContrato”.
Operação responsável em alterar somente o valor de desconto de uma consignação.
Para alterar o valor do prazo da consignação, será necessário utilizar a operação
“alterarValorPrazoParcelaV1”.
Foi mantida a mesma assinatura da operação já existente no sistema ESCA da
empresa CONSIST com o objetivo de causar o menor impacto possível às consignatárias
que já faziam uso desta operação.

90
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Deverá ser utilizada quando existir a necessidade de alterar somente o valor do

desconto de um contrato de consignação. Neste momento o valor da margem consignável
do servidor público será automaticamente ajustada de acordo com o novo valor de desconto
informado. Porém para alguns tipos de consignações o MP determina que seja permitido
somente realizar amortização, ou seja, alterar o valor de desconto para valores menores. Os
tipos de consignações atuais restringidas pelo MP atualmente são:
01 - PRESTACAO REFERENTE A AQUISICAO DE IMOVEL RESIDENCIAL DE CONSIGNA
16 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS JUNTO BANCO OFICIAL CRED
17 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS JUNTO ENTID.PREV.PRIVADA
18 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS JUNTO COOPERATIVA
19 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS BANCO PRIVADO
41 - PRESTACAO IMOVEL RESIDENCIAL UNIAO ESTADOS E DF

4.15.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

Código da companhia -
CD_CIA Alfanumérico(03) -
Informar vazio.
Código da empresa –
CD_EMPRESA Alfanumérico(03) -
Informar vazio
Código do órgão do vínculo
CD_ORGAO Alfanumérico(10) X
funcional do servidor.
Matrícula do vínculo
CD_MATRICULA Alfanumérico(13) X
funcional do servidor.
Dados do Instituidor - Este
campo é formado de: Órgão
ORG_MAT_INST Alfanumérico(12) (Alfanumérico(05)) + P
Matrícula do Instituidor
(Alfanumérico(07)
NR_CPF_A Numérico(14) CPF do servidor X
Valor a ser consignado
VL_OPERACAO_A Numérico(13,2) X
mensalmente
Código que identifica a
consignatária – Este código
CD_CONSIG_A Numérico(06) X
será fornecido pelo
SERPRO.
Senha da consignatária –
CD_SENHA_CONSIG Alfanumérico(12) Esta senha será fornecida X
pelo SERPRO
Usuário da consignatária –
CD_USUARIO Alfanumérico(08) -
Informar vazio
NR_CONTRATO Alfanumérico(20) Número do contrato X
Código Identificador do
CD_ID_SERV Numérico(02) X
servidor (CIS) - Verificar o

91
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

item 4.2 Tipos

Personalizados deste
documento.
Código de origem de
Transação (COT) - Verificar
CD_ORIGEM_TRANS Numérico(02) o item 4.2 Tipos X
Personalizados deste
documento.
Senha do servidor – Informar
CD_SENHA_SERVIDOR Numérico(08) -
vazio

4.15.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

4.15.3. Lista de erros herdados da Consist

92
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

8056 Senha da consignatária incorreta.

8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8111 Código de origem da transação não informado.
8112 Código identificação servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.15.4. Lista de novos erros

Código* Descrição**
4006 O contrato pertence a outro vínculo.
4012 Contrato renovado dentro do mês não pode ser excluído.
4013 Contrato já se encontra quitado.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização nao permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
4036 Tipo de consignação só permite amortização.
4039 Contrato não pode ser alterado.
4041 Consignação de cartão deve possuir prazo igual a 1.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.

93
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4049 Consignatária descredenciada.

4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.
4051 Consignatária desativada temporariamente.

* (cd_ret_code)
** (ds_ret_code)

4.15.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:alterarValorParcela>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<VL_OPERACAO_A>150,00</VL_OPERACAO_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<NR_CONTRATO>C-200-10</NR_CONTRATO>
<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
</urn:alterarValorParcela>
</soapenv:Body>
</soapenv:Envelope>

94
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:alterarValorParcelaResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:alterarValorParcelaResponse>
</soap:Body>
</soap:Envelope>

4.16. Operação alterarValorPrazoParcelaV1 (Disponível na Versão V1)

Esta operação foi descontinuada na Versão V2 do web service. Ela será substituída
pela nova operação “alterarContrato”.
Operação responsável em alterar o valor de desconto de uma consignação e o prazo.
Foi mantida a mesma assinatura da operação já existente no sistema ESCA da
empresa CONSIST com o objetivo de causar o menor impacto possível às consignatárias
que já faziam uso desta operação.
Deverá ser utilizada quando existir a necessidade de o valor do desconto de um
contrato de consignação, o total de parcelas ou ambos. Neste momento o valor da margem
consignável do servidor público será automaticamente ajustada de acordo com o novo valor
de desconto informado. Porém para alguns tipos de consignações o MP determina que seja
permitido somente realizar amortização, ou seja, alterar os valores de desconto e total de
parcelas para valores menores. Os tipos de consignações atuais restringidas pelo MP
atualmente são:
01 - PRESTACAO REFERENTE A AQUISICAO DE IMOVEL RESIDENCIAL DE CONSIGNA
16 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS JUNTO BANCO OFICIAL CRED
17 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS JUNTO ENTID.PREV.PRIVADA
18 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS JUNTO COOPERATIVA

95
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

19 - AMORT JUROS DIVIDAS PESSOAIS CONTRAIDOS BANCO PRIVADO

41 - PRESTACAO IMOVEL RESIDENCIAL UNIAO ESTADOS E DF

4.16.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CIA Alfanumérico(03) Código da companhia -
CD_EMPRESA Alfanumérico(03) Código da empresa -
CD_ORGAO Alfanumérico(10) Código do órgão X
CD_MATRICULA Alfanumérico(13) Matrícula do servidor X
ORG_MAT_INST Alfanumérico(12) Dados do Instituidor * P
NR_CPF_A Numérico(14) CPF do servidor X
NR_CONTRATO Alfanumérico(20) Número do contrato X
Valor a ser consignado
VL_OPERACAO_A Numérico(13,2) X
mensalmente
PRAZO Numérico(3) Prazo da operação X
CD_CONSIG_A Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
CD_USUARIO Alfanumérico(08) Usuário da consignatária -
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
Transação (COT) - Verificar
CD_ORIGEM_TRANS Numérico(02) o item 4.2 Tipos X
Personalizados deste
documento.
CD_SENHA_SERVIDO
Numérico(08) Senha do servidor -
R

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))

4.16.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

96
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.16.3. Lista de erros herdados da Consist

Código* Descrição**
0000 Serviço realizado com sucesso.
0024 Número contrato incorreto.
0056 Órgão não está ativo.
0087 Senha do funcionário expirada ou bloqueada
0087 Consignatária não autorizada a consignar pelo servidor/pensionista.
Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Órgão incorreto.
2027 Prazo incorreto.
2027 Valor da prestação incorreto.
2046 CPF não confere com a matrícula.
2109 Número do contrato não informado
2109 Órgão não informado
2109 Prazo não informado
2109 Valor da prestação não informado
2109 Matrícula não informada
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8017 Contrato não localizado.
8028 Código de origem da transação incorreto.
8030 Código identificação servidor incorreto.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8111 Código de origem da transação não informado.
8112 Código identificação servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

97
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.16.4. Lista de novos erros

* (cd_ret_code)
** (ds_ret_code)

4.16.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>

98
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<urn:alterarValorPrazoParcelaV1>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<NR_CONTRATO>C-1000-10</NR_CONTRATO>
<VL_OPERACAO_A>250,00</VL_OPERACAO_A>
<PRAZO>10</PRAZO>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
</urn:alterarValorPrazoParcelaV1>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:alterarValorPrazoParcelaV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:alterarValorPrazoParcelaV1Response>

99
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</soap:Body>
</soap:Envelope>

4.17. Operação cancelarContrato (Disponível nas Versões V1 e V2)

Operação responsável em interromper o desconto de uma consignação do

contracheque do servidor público.
Foi mantida a mesma assinatura da operação já existente no sistema ESCA da
empresa CONSIST com o objetivo de causar o menor impacto possível às consignatárias
que já faziam uso desta operação.
Deverá ser utilizada quando existir a necessidade de interromper o desconto de uma
consignação inicialmente originada por uma renovação, e retornar a descontar (reativá-las)
as consignações originais antes da renovação destes, dentro de um prazo de 7 dias após a
realização da renovação. Exemplo:
1 - Incluída a consignação A.
2 - Incluída a consignação B.
3 - Renova as consignações A e B gerando a nova consignação C. (as consignações A e B
não serão mais descontadas).
4 - Cancela a consignação C (interrompe o desconto). Consequentemente as consignações
A e B serão reativadas e voltarão a ser descontadas.
Se a consignação que será cancelada não for originada de uma renovação, esta
operação terá o mesmo comportamento da operação “encerrarContrato”.
Neste momento o valor da margem consignável do servidor público será
automaticamente ajustada de acordo com os novos valores das consignações que
retornaram a descontar e o valor da consignação que foi interrompida.

4.17.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

100
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

NR_CONTRATO Alfanumérico(20) Número do contrato X

DS_LIVRE Alfanumérico(20) Livre uso da Consignatária -

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))

4.17.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

4.17.3. Lista de erros herdados da Consist

Código* Descrição**
0000 Serviço realizado com sucesso.
0002 Órgão inexistente.
0024 Número contrato incorreto.
0056 Órgão não está ativo.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Órgão incorreto.
2046 CPF não confere com a matrícula.
2109 Número do contrato não informado
2109 Órgão não informado
2109 Matrícula não informada
2215 Registro está sendo utilizado em outra operação.
4057 Prazo limite de 7 dias para o cancelamento da renovação expirou.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8017 Contrato não localizado.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)

101
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

** (ds_ret_code)

4.17.4. Lista de novos erros

Código* Descrição**
4006 O contrato pertence a outro vínculo.
4012 Contrato renovado dentro do mês não pode ser excluído.
4013 Contrato já se encontra quitado.
4014 Contrato sem renovação.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização nao permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
4037 Contrato não pode desfazer renovação.
4038 Rubrica/Sequência do contrato.
Não é possível cancelar a renovação. Ano/Mês do último desconto do
4045
contrato a ser reativado já foi processado.

* (cd_ret_code)
** (ds_ret_code)

4.17.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:cancelarContrato>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>

102
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<DT_OPERACAO_A></DT_OPERACAO_A>
<NR_CONTRATO>C-1000-50</NR_CONTRATO>
<DS_LIVRE></DS_LIVRE>
</urn:cancelarContrato>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:cancelarContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:cancelarContratoResponse>
</soap:Body>
</soap:Envelope>

103
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.18. Operações consultarContratosPorFuncionario e

consultarContratosPorFuncionarioV1 (Disponíveis nas Versões V1 e V2)

Operações responsáveis em listar todas as consignações, (vigentes ou não) de um

servidor público, firmadas com a consignatária que realizou a consulta.
Não existe nenhuma diferença de comportamento entre estas operações. Foi mantida
a mesma assinatura das operações já existente no sistema ESCA da empresa CONSIST
com o objetivo de causar o menor impacto possível às consignatárias que já faziam uso
desta operação.
Deverá ser utilizada quando existir a necessidade de conhecer o histórico de
consignações firmadas entre o servidor público e a consignatária com suas respectivas
situações atuais.

4.18.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))
** Se informado, a operação retornará somente as consignações associadas ao convênio
informado.

4.18.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

dados_servidor
Mantido apenas para não quebrar
cd_empresa Alfanumérico (03)
interface, sempre retorna MP
Mantido apenas para não quebrar
ds_empresa Alfanumérico (40) interface, sempre retorna MINISTERIO DO
PLANEJAMENTO
cd_orgao Alfanumérico (10) Código do Órgão

104
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

ds_orgao Alfanumérico (40) Descrição do Órgão

cd_matricula Alfanumérico (13) Matrícula do servidor
nr_cpf_servidor Numérico (14) CPF do servidor
nm_servidor Alfanumérico (30) Nome do servidor
Código situação do servidor - Verificar o
cd_sit_serv Numérico(06) item 4.2 Tipos Personalizados deste
documento.
Descrição da situação do servidor -
ds_sit_serv Alfanumérico(40) Verificar o item 4.2 Tipos Personalizados
deste documento.
Código da classificação do servidor -
cd_classe_serv Numérico(06) Verificar o item 4.2 Tipos Personalizados
deste documento.
Descrição da classificação do servidor -
ds_classe_serv Alfanumérico(40) Verificar o item 4.2 Tipos Personalizados
deste documento.
dados_autorizacao - Array
cd_consig Numérico(06) Cód.da consignatária da autorização
ds_consig Alfanumérico(30) Desc. da consignatária da autorização
prazo Numérico(03) Prazo da autorização
dt_operacao Numérico(08) Data de Operação da autorização
dt_prim_desc Numérico(06) Data do primeiro desconto da autorização
dt_ult_desc Numérico(06) Data do último desconto da autorização
vl_desconto Numérico(13,2) Valor do Desconto da autorização
nr_externo Alfanumérico(20) Número da operação
Código da situação da autorização -
cd_situacao Numérico(06) Verificar o item 4.2 Tipos Personalizados
deste documento.
Descrição da situação da autorização -
ds_situacao Alfanumérico(15) Verificar o item 4.2 Tipos Personalizados
deste documento.
cd_convenio Numérico(06) Código do convênio da autorização
ds_convenio Alfanumérico(30) Descrição do convênio da autorização
Mantido apenas para não quebrar
ds_auto Alfanumérico(30)
interface, sempre retorna vazio
Fim - dados_autorizacao - Array
cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

Obs.: A tag “dados_autorizacao” pode ocorrer N vezes.

4.18.3. Lista de erros herdados da Consist

Código* Descrição**
0000 Serviço realizado com sucesso.
2027 Matrícula incorreta.

105
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

2027 Matrícula Instituidor incorreta.

2027 Órgão incorreto.
2109 Órgão não informado
2109 Matrícula não informada
8010 Consignatária inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.18.4. Lista de novos erros

Não foram criados códigos de retorno novos para essa consulta.

4.18.5. Exemplo de Requisição SOAP

Operação consultarContratosPorFuncionario:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarContratosPorFuncionario>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>

106
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<CD_USUARIO></CD_USUARIO>
<CD_CONVENIO_A></CD_CONVENIO_A>
</urn:consultarContratosPorFuncionario>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada da operação consultarContratosPorFuncionario:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarContratosPorFuncionarioResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dados_servidor>
<cd_empresa>MP</cd_empresa>
<ds_empresa>MINISTERIO DO PLANEJAMENTO</ds_empresa>
<cd_orgao>13000</cd_orgao>
<ds_orgao>MINIST.DA AGRICULTURA,PECUARIA E ABAST.</ds_orgao>
<cd_matricula>897</cd_matricula>
<nr_cpf_servidor>14477750153</nr_cpf_servidor>
<nm_servidor>CARMEN LUCINDA FARKAS DE ARAUJO</nm_servidor>
<cd_sit_serv>1</cd_sit_serv>
<ds_sit_serv>Normal</ds_sit_serv>
<cd_classe_serv>1</cd_classe_serv>
<ds_classe_serv>Estável</ds_classe_serv>
<dados_autorizacao>
<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>1</prazo>
<dt_operacao>20160513</dt_operacao>
<dt_prim_desc>201605</dt_prim_desc>
<dt_ult_desc>201605</dt_ult_desc>
<vl_desconto>10000</vl_desconto>

107
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<nr_externo>TESTE TIPO NE 42</nr_externo>

<cd_situacao>5</cd_situacao>
<ds_situacao>Quitado</ds_situacao>
<cd_convenio>430110</cd_convenio>
<ds_convenio>BANCO REAL -EMPRES IMOBILIARIO</ds_convenio>
<ds_auto></ds_auto>
</dados_autorizacao>
<dados_autorizacao>
<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>30</prazo>
<dt_operacao>20160513</dt_operacao>
<dt_prim_desc>201606</dt_prim_desc>
<dt_ult_desc>201811</dt_ult_desc>
<vl_desconto>1800</vl_desconto>
<nr_externo>OOO</nr_externo>
<cd_situacao>6</cd_situacao>
<ds_situacao>Encerrado Consignatária</ds_situacao>
<cd_convenio>430110</cd_convenio>
<ds_convenio>BANCO REAL -EMPRES IMOBILIARIO</ds_convenio>
<ds_auto></ds_auto>
</dados_autorizacao>
<dados_autorizacao>
<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>1</prazo>
<dt_operacao>20160513</dt_operacao>
<dt_prim_desc>201606</dt_prim_desc>
<dt_ult_desc>201606</dt_ult_desc>
<vl_desconto>13000</vl_desconto>
<nr_externo>250</nr_externo>
<cd_situacao>5</cd_situacao>
<ds_situacao>Quitado</ds_situacao>
<cd_convenio>430142</cd_convenio>
<ds_convenio>430142</ds_convenio>

108
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<ds_auto></ds_auto>
</dados_autorizacao>
<dados_autorizacao>
<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>1</prazo>
<dt_operacao>20160518</dt_operacao>
<dt_prim_desc>201606</dt_prim_desc>
<dt_ult_desc>201606</dt_ult_desc>
<vl_desconto>900</vl_desconto>
<nr_externo>123/2016</nr_externo>
<cd_situacao>3</cd_situacao>
<ds_situacao>Ativo</ds_situacao>
<cd_convenio>430110</cd_convenio>
<ds_convenio>BANCO REAL -EMPRES IMOBILIARIO</ds_convenio>
<ds_auto></ds_auto>
</dados_autorizacao>
</dados_servidor>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:consultarContratosPorFuncionarioResponse>
</soap:Body>
</soap:Envelope>

Operação consultarContratosPorFuncionarioV1:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarContratosPorFuncionarioV1>
<CD_CIA></CD_CIA>

109
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<CD_CONVENIO_A></CD_CONVENIO_A>
</urn:consultarContratosPorFuncionarioV1>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada da operação consultarContratosPorFuncionarioV1:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarContratosPorFuncionarioV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dados_servidor>
<cd_empresa>MP</cd_empresa>
<ds_empresa>MINISTERIO DO PLANEJAMENTO</ds_empresa>
<cd_orgao>13000</cd_orgao>
<ds_orgao>MINIST.DA AGRICULTURA,PECUARIA E ABAST.</ds_orgao>
<cd_matricula>897</cd_matricula>
<nr_cpf_servidor>14477750153</nr_cpf_servidor>
<nm_servidor>CARMEN LUCINDA FARKAS DE ARAUJO</nm_servidor>
<cd_sit_serv>1</cd_sit_serv>
<ds_sit_serv>Normal</ds_sit_serv>
<cd_classe_serv>1</cd_classe_serv>
<ds_classe_serv>Estável</ds_classe_serv>
<dados_autorizacao>

110
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>1</prazo>
<dt_operacao>20160513</dt_operacao>
<dt_prim_desc>201605</dt_prim_desc>
<dt_ult_desc>201605</dt_ult_desc>
<vl_desconto>10000</vl_desconto>
<nr_externo>TESTE TIPO NE 42</nr_externo>
<cd_situacao>5</cd_situacao>
<ds_situacao>Quitado</ds_situacao>
<cd_convenio>430110</cd_convenio>
<ds_convenio>BANCO REAL -EMPRES IMOBILIARIO</ds_convenio>
<ds_auto></ds_auto>
</dados_autorizacao>
<dados_autorizacao>
<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>30</prazo>
<dt_operacao>20160513</dt_operacao>
<dt_prim_desc>201606</dt_prim_desc>
<dt_ult_desc>201811</dt_ult_desc>
<vl_desconto>1800</vl_desconto>
<nr_externo>OOO</nr_externo>
<cd_situacao>6</cd_situacao>
<ds_situacao>Encerrado Consignatária</ds_situacao>
<cd_convenio>430110</cd_convenio>
<ds_convenio>BANCO REAL -EMPRES IMOBILIARIO</ds_convenio>
<ds_auto></ds_auto>
</dados_autorizacao>
<dados_autorizacao>
<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>1</prazo>
<dt_operacao>20160513</dt_operacao>
<dt_prim_desc>201606</dt_prim_desc>

111
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<dt_ult_desc>201606</dt_ult_desc>
<vl_desconto>13000</vl_desconto>
<nr_externo>250</nr_externo>
<cd_situacao>5</cd_situacao>
<ds_situacao>Quitado</ds_situacao>
<cd_convenio>430142</cd_convenio>
<ds_convenio>430142</ds_convenio>
<ds_auto></ds_auto>
</dados_autorizacao>
<dados_autorizacao>
<cd_consig>115</cd_consig>
<ds_consig>BANCO ABN AMRO REAL S/A</ds_consig>
<prazo>1</prazo>
<dt_operacao>20160518</dt_operacao>
<dt_prim_desc>201606</dt_prim_desc>
<dt_ult_desc>201606</dt_ult_desc>
<vl_desconto>900</vl_desconto>
<nr_externo>123/2016</nr_externo>
<cd_situacao>3</cd_situacao>
<ds_situacao>Ativo</ds_situacao>
<cd_convenio>430110</cd_convenio>
<ds_convenio>BANCO REAL -EMPRES IMOBILIARIO</ds_convenio>
<ds_auto></ds_auto>
</dados_autorizacao>
</dados_servidor>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:consultarContratosPorFuncionarioV1Response>
</soap:Body>
</soap:Envelope>

112
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.19. Operação encerrarContrato (Disponível nas Versões V1 e V2)

Operação responsável em interromper o desconto de uma consignação do

4.19.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))

4.19.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

113
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.19.3. Lista de erros herdados da Consist

Código* Descrição**
0000 Serviço realizado com sucesso.
0002 Órgão inexistente.
0024 Número contrato incorreto.
0056 Órgão não está ativo.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Órgão incorreto.
2046 CPF não confere com a matrícula.
2109 Número do contrato não informado
2109 Órgão não informado
2109 Matrícula não informada
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8017 Contrato não localizado.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.19.4. Lista de novos erros

114
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4025 Cronograma do órgão não implantado.

4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.

* (cd_ret_code)
** (ds_ret_code)

4.19.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:encerrarContrato>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<NR_CONTRATO>C-200-10</NR_CONTRATO>
<DS_LIVRE></DS_LIVRE>
</urn:encerrarContrato>
</soapenv:Body>
</soapenv:Envelope>

115
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:encerrarContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:encerrarContratoResponse>
</soap:Body>
</soap:Envelope>

4.20. Operações incluirContrato e incluirContratoV1 (Disponíveis na

Versão V1)

Estas operações foram descontinuadas na Versão V2 do web service. Elas serão

substituídas pela nova operação “incluirContratoV2”.
Operações responsáveis em incluir uma nova consignação no contracheque do
servidor público.
Ambas operações “incluirContrato” e “incluirContratoV1” possuem o mesmo
comportamento. Foram mantidas as mesmas assinaturas das operações já existente no
sistema ESCA da empresa CONSIST com o objetivo de causar o menor impacto possível às
consignatárias que já faziam uso dessas operações.
Neste momento o valor da margem consignável do servidor público será
automaticamente ajustada de acordo com o valor da consignação que foi incluída.

4.20.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CIA Alfanumérico(03) Código da companhia -

116
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

CD_EMPRESA Alfanumérico(03)
Código da empresa -
CD_ORGAO Alfanumérico(10)
Código do órgão X
CD_MATRICULA Alfanumérico(13)
Matrícula do servidor X
ORG_MAT_INST Alfanumérico(12)
Dados do Instituidor * P
NR_CPF_A Numérico(14)
CPF do servidor X
VL_LIQUIDO_A Numérico(13,2)
Valor a ser creditado -
Valor a ser consignado
VL_OPERACAO_A Numérico(13,2) X
mensalmente
CD_CONSIG_A Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
CD_USUARIO Alfanumérico(08) Usuário da consignatária -
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
Transação (COT) -
CD_ORIGEM_TRANS Numérico(02) Verificar o item 4.2 Tipos X
Personalizados deste
documento.
CD_SENHA_SERVIDOR Numérico(08) Senha do servidor -
CD_CONVENIO_A Numérico(06) Código do convênio X
QT_PRAZO_A Numérico(03) Prazo da operação X
Data de Operação do
DT_OPERACAO_A Numérico(08) -
contrato (AAAAMMDD)
Ano/mês do 1º desconto
DT_ANO_MES_A Numérico(06) -
(AAAAMM)
Número da operação de
NR_CONTRATO Alfanumérico(20) domínio da Consignatária X
(Número do contrato)
TX_EFETIVA_AUTO_A Alfanumérico(3,7) CET -
Livre uso da
DS_LIVRE Alfanumérico(20) -
Consignatária
IN_REG_HOLD Alfanumérico(01) ‘S’ Para Registro em Hold H
CD_TRAN_HOLD_SER Identificação do Reg. em
Alfanumérico(20) -
V Hold

* Este campo é formado de: Órgão (Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))

4.20.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

nm_serv Tamanho Variável Nome do servidor
cd_bco_serv Tamanho Variável Banco do Servidor

117
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

cd_age_serv Tamanho Variável Agência do Servidor

cd_ccs_serv Tamanho Variável Conta do Servidor
Situação do Servidor - Verificar o item 4.2
in_sit_serv Alfanumérico(40)
Tipos Personalizados deste documento.
Classificação do Servidor - Verificar o item
in_class_serv Alfanumérico(40) 4.2 Tipos Personalizados deste
documento.
Mantido para não quebrar interface.
im_foto Tamanho Variável
Sempre retorna vazio.
nr_contrato Alfanumérico(20) Gerado pelo sistema, se não informado
Mantido para não quebrar interface.
seq_contrato Numérico(1)
Sempre retorna vazio.
vl_bruto Numérico(13,2) Valor do desconto
Ano/mês do primeiro desconto do contrato,
dt_prim_desc Numérico(6)
gerado pelo sistema
data_operacao Numérico(8) Data de operação do contrato
cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

4.20.3. Lista de erros herdados da Consist

118
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

2109 Ano/mês do 1° desconto não informado

2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8028 Código de origem da transação incorreto.
8030 Código identificação servidor incorreto.
8035 Registro Hold incorreto.
8036 Consignatária incorreta.
8039 Senha do funcionário incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8084 Senha do servidor da transação não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8111 Código de origem da transação não informado.
8112 Código identificação servidor não informado.
8133 Ação não executada. Número de sequência indisponível.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.20.4. Lista de novos erros

Código* Descrição**
4008 Rubrica não possui autorizacao para realizar consignacao.
4011 Consignatária sem rubrica associada para este órgão.
4015 Contrato sem rubrica disponível.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização não permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.

119
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4030 Valor inferior ao valor mínimo permitido.

4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
Já existe uma consignação de cartão vigente. Tipo de consignação permite
4040
somente uma consignação vigente.
4041 Consignação de cartão deve possuir prazo igual a 1.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.
4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.
4051 Consignatária desativada temporariamente.

* (cd_ret_code)
** (ds_ret_code)

4.20.5. Exemplo de Requisição SOAP

Operação incluirContrato:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:incluirContrato>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<VL_LIQUIDO_A></VL_LIQUIDO_A>
<VL_OPERACAO_A>100,00</VL_OPERACAO_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>

120
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<CD_CONVENIO_A>430110</CD_CONVENIO_A>
<QT_PRAZO_A>10</QT_PRAZO_A>
<DT_OPERACAO_A></DT_OPERACAO_A>
<DT_ANO_MES_A></DT_ANO_MES_A>
<NR_CONTRATO>20000101</NR_CONTRATO>
<TX_EFETIVA_AUTO_A></TX_EFETIVA_AUTO_A>
<DS_LIVRE></DS_LIVRE>
<IN_REG_HOLD></IN_REG_HOLD>
<CD_TRAN_HOLD_SERV></CD_TRAN_HOLD_SERV>
</urn:incluirContrato>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada da operação incluirContrato:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:incluirContratoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<nm_serv>CARMEN LUCINDA FARKAS DE ARAUJO</nm_serv>
<cd_bco_serv>001</cd_bco_serv>
<cd_age_serv>045942</cd_age_serv>
<cd_ccs_serv>327232X</cd_ccs_serv>
<in_sit_serv>1</in_sit_serv>
<in_class_serv>1</in_class_serv>
<im_foto></im_foto>
<nr_contrato>20000101</nr_contrato>
<seq_contrato></seq_contrato>
<vl_bruto>10000</vl_bruto>

121
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<dt_prim_desc>201704</dt_prim_desc>
<data_operacao>20170316</data_operacao>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:incluirContratoResponse>
</soap:Body>
</soap:Envelope>

Operação incluirContratoV1:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:incluirContratoV1>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<VL_LIQUIDO_A></VL_LIQUIDO_A>
<VL_OPERACAO_A>100,00</VL_OPERACAO_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<CD_ID_SERV>01</CD_ID_SERV>
<CD_ORIGEM_TRANS>01</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<CD_CONVENIO_A>430110</CD_CONVENIO_A>
<QT_PRAZO_A>10</QT_PRAZO_A>
<DT_OPERACAO_A></DT_OPERACAO_A>

122
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<DT_ANO_MES_A></DT_ANO_MES_A>
<NR_CONTRATO>20000102</NR_CONTRATO>
<TX_EFETIVA_AUTO_A></TX_EFETIVA_AUTO_A>
<DS_LIVRE></DS_LIVRE>
<IN_REG_HOLD></IN_REG_HOLD>
<CD_TRAN_HOLD_SERV></CD_TRAN_HOLD_SERV>
</urn:incluirContratoV1>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada da operação incluirContratoV1:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:incluirContratoV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<nm_serv>CARMEN LUCINDA FARKAS DE ARAUJO</nm_serv>
<cd_bco_serv>001</cd_bco_serv>
<cd_age_serv>045942</cd_age_serv>
<cd_ccs_serv>327232X</cd_ccs_serv>
<in_sit_serv>1</in_sit_serv>
<in_class_serv>1</in_class_serv>
<im_foto></im_foto>
<nr_contrato>20000101</nr_contrato>
<seq_contrato></seq_contrato>
<vl_bruto>10000</vl_bruto>
<dt_prim_desc>201704</dt_prim_desc>
<data_operacao>20170316</data_operacao>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>

123
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</return>
</ns1:incluirContratoV1Response>
</soap:Body>
</soap:Envelope>

4.21. Operação renovarContratoCPFV1 (Disponível na Versão V1)

Esta operação foi descontinuada na Versão V2 do web service. Ela será substituída
pela nova operação “renovarContratoV2”.
Operação responsável em renovar uma ou várias consignações em uma nova
consignação no contracheque do servidor público.
Foi mantida a mesma assinatura da operação já existente no sistema ESCA da
empresa CONSIST com o objetivo de causar o menor impacto possível às consignatárias
que já faziam uso dessa operação.
Neste momento o valor da margem consignável do servidor público será
automaticamente ajustada de acordo com o valor da consignação que foi incluída.
A diferença entre esta e a operação renovarContratoV1 é que esta última permite
renovar no máximo 5 consignações.

4.21.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CIA Alfanumérico(03) Código da companhia -
CD_EMPRESA Alfanumérico(03) Código da empresa -
CD_ORGAO Alfanumérico(10) Código do órgão X
CD_MATRICULA Alfanumérico(13) Matrícula do servidor X
ORG_MAT_INST Alfanumérico(12) Dados do Instituidor * P
NR_CPF_A Numérico(14) CPF do servidor X
VL_LIQUIDO_A Numérico(13,2) Valor a ser creditado -
Valor a ser consignado
VL_OPERACAO_A Numérico(13,2) X
mensalmente
CD_CONSIG_A Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
CD_USUARIO Alfanumérico(08) Usuário da consignatária -
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
CD_ORIGEM_TRANS Numérico(02) Transação (COT) - X
Verificar o item 4.2 Tipos

124
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Personalizados deste
documento.
CD_SENHA_SERVIDOR Numérico(08) Senha do servidor -
CD_CONVENIO_A Numérico(06) Código do convênio X
QT_PRAZO_A Numérico(03) Prazo da operação X
Data de Operação do
DT_OPERACAO_A Numérico(08) -
contrato (AAAAMMDD)
Ano/mês do 1º desconto
DT_ANO_MES_A Numérico(06) -
(AAAAMM)
NR_CONTRATO Alfanumérico(20) Novo número do Contrato X
DS_LIVRE Alfanumérico(20) Livre uso da Consignatária -
Qtd contratos a serem
QT_RENOVA_A Numérico(02) X
renovados
NR_CONTRATO_ARRAY
Item Alfanumérico(20) Número do contrato X
Fim NR_CONTRATO_ARRAY

* Este campo é formado de: Órgão (Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))

4.21.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

nm_serv Tamanho Variável Nome do servidor
cd_bco_serv Tamanho Variável Banco do Servidor
cd_age_serv Tamanho Variável Agência do Servidor
cd_ccs_serv Tamanho Variável Conta do Servidor
Situação do Servidor - Verificar o item 4.2
in_sit_serv Alfanumérico(40)
Tipos Personalizados deste documento.
Classificação do Servidor - Verificar o item
in_class_serv Alfanumérico(40) 4.2 Tipos Personalizados deste
documento.
Mantido para não quebrar interface.
im_foto Tamanho Variável
Sempre retorna vazio.
nr_contrato Alfanumérico(20) Gerado pelo sistema, se não informado
Mantido para não quebrar interface.
seq_contrato Numérico(1)
Sempre retorna vazio.
vl_bruto Numérico(13,2) Valor do desconto
Ano/mês do primeiro desconto do contrato,
dt_prim_desc Numérico(6)
gerado pelo sistema
data_operacao Numérico(8) Data de operação do contrato
cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

125
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.21.3. Lista de erros herdados da Consist

Código* Descrição**
0000 Serviço realizado com sucesso.
0002 Órgão inexistente.
0008 Convênio inexistente.
0024 Número contrato incorreto.
0029 Número contrato existente.
0056 Órgão não está ativo.
0087 Senha do funcionário expirada ou bloqueada
0087 Consignatária não autorizada a consignar pelo servidor/pensionista.
Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
2027 Valor da prestação incorreto.
2027 Órgão incorreto.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Convênio incorreto.
2027 Prazo incorreto.
2027 Ano/mês do 1° desconto incorreto
2027 Quantidade de contratos a renovar incorreta
2027 Número do contrato a renovar incorreto
2046 CPF não confere com a matrícula.
2109 Valor da prestação não informado
2109 Órgão não informado
2109 Matrícula não informada
2109 Número do contrato não informado
2109 Convênio não informado
2109 Prazo não informado
2109 Ano/mês do 1° desconto não informado
2109 Quantidade de contratos a renovar não informada
2215 Registro está sendo utilizado em outra operação.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8017 Contrato não localizado.
8028 Código de origem da transação incorreto.
8030 Código identificação servidor incorreto.
8036 Consignatária incorreta.
8039 Senha do funcionário incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8083 Senha da consignatária não informada.
8084 Senha do servidor da transação não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.

126
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

8111 Código de origem da transação não informado.

8112 Código identificação servidor não informado.
8133 Ação não executada. Número de sequência indisponível.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.21.4. Lista de novos erros

Código* Descrição**
4003 Nenhum contrato vigente
4004 Quantidade de contratos vigentes insuficiente.
4005 Não foi possível recuperar todos os contratos vigentes requeridos.
4006 O contrato pertence a outro vínculo.
4008 Rubrica não possui autorizacao para realizar consignacao.
4011 Consignatária sem rubrica associada para este órgão.
4012 Contrato renovado dentro do mês não pode ser excluído.
4013 Contrato já se encontra quitado.
4015 Contrato sem rubrica disponível.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização nao permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
4042 Não permitida renovação de Consignação de cartão.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.

127
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.

4051 Consignatária desativada temporariamente.

* (cd_ret_code)
** (ds_ret_code)

4.21.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:renovarContratoCPFV1>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<VL_LIQUIDO_A></VL_LIQUIDO_A>
<VL_OPERACAO_A>150,00</VL_OPERACAO_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<CD_ID_SERV>1</CD_ID_SERV>
<CD_ORIGEM_TRANS>1</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<CD_CONVENIO_A>430110</CD_CONVENIO_A>
<QT_PRAZO_A>10</QT_PRAZO_A>
<DT_OPERACAO_A></DT_OPERACAO_A>
<DT_ANO_MES_A></DT_ANO_MES_A>
<NR_CONTRATO>C150-10</NR_CONTRATO>
<DS_LIVRE></DS_LIVRE>
<QT_RENOVA_A>2</QT_RENOVA_A>
<NR_CONTRATO_ARRAY>

128
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:renovarContratoCPFV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<nm_serv>CARMEN LUCINDA FARKAS DE ARAUJO</nm_serv>
<cd_bco_serv>001</cd_bco_serv>
<cd_age_serv>045942</cd_age_serv>
<cd_ccs_serv>327232X</cd_ccs_serv>
<in_sit_serv>1</in_sit_serv>
<in_class_serv>1</in_class_serv>
<im_foto></im_foto>
<nr_contrato>C150-10</nr_contrato>
<seq_contrato></seq_contrato>
<vl_bruto>15000</vl_bruto>
<dt_prim_desc>201705</dt_prim_desc>
<data_operacao>20170418</data_operacao>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:renovarContratoCPFV1Response>
</soap:Body>

129
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</soap:Envelope>

4.22. Operação renovarContratoV1 (Disponível na Versão V1)

Esta operação foi descontinuada na Versão V2 do web service. Ela será substituída
pela nova operação “renovarContratoV2”.
Operação responsável em renovar de uma a no máximo 5 consignações em uma
nova consignação no contracheque do servidor público.
Foi mantida a mesma assinatura da operação já existente no sistema ESCA da
empresa CONSIST com o objetivo de causar o menor impacto possível às consignatárias
que já faziam uso dessa operação.
Neste momento o valor da margem consignável do servidor público será
automaticamente ajustada de acordo com o valor da consignação que foi incluída.
A diferença entre esta e a operação renovarContratoCPFV1 é que esta última permite
renovar mais do que 5 consignações.

4.22.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CIA Alfanumérico(03) Código da companhia -
CD_EMPRESA Alfanumérico(03) Código da empresa -
CD_ORGAO Alfanumérico(10) Código do órgão X
CD_MATRICULA Alfanumérico(13) Matrícula do servidor X
ORG_MAT_INST Alfanumérico(12) Dados do Instituidor * P
NR_CPF_A Numérico(14) CPF do servidor X
VL_LIQUIDO_A Numérico(13,2) Valor a ser creditado -
Valor a ser consignado
VL_OPERACAO_A Numérico(13,2) X
mensalmente
CD_CONSIG_A Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
CD_USUARIO Alfanumérico(08) Usuário da consignatária -
Código Identificador do
servidor (CIS) - Verificar o
CD_ID_SERV Numérico(02) item 4.2 Tipos X
Personalizados deste
documento.
Código de origem de
Transação (COT) -
CD_ORIGEM_TRANS Numérico(02) Verificar o item 4.2 Tipos X
Personalizados deste
documento.
CD_SENHA_SERVIDOR Numérico(08) Senha do servidor -

130
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

CD_CONVENIO_A Numérico(06) Código do convênio X

QT_PRAZO_A Numérico(03) Prazo da operação X
Data de Operação do
DT_OPERACAO_A Numérico(08) -
contrato (AAAAMMDD)
Ano/mês do 1º desconto
DT_ANO_MES_A Numérico(06) -
(AAAAMM)
NR_CONTRATO Alfanumérico(20) Novo número do Contrato X
Livre uso da
DS_LIVRE Alfanumérico(20) -
Consignatária
Qtd contratos a serem
QT_RENOVA_A Numérico(02) X
renovados
NR_CONTRATO_1 Alfanumérico(20) Número do Contrato X
NR_CONTRATO_2 Alfanumérico(20) Número do Contrato O
NR_CONTRATO_3 Alfanumérico(20) Número do Contrato O
NR_CONTRATO_4 Alfanumérico(20) Número do Contrato O
NR_CONTRATO_5 Alfanumérico(20) Número do Contrato O
TX_EFETIVA_AUTO_A Alfanumérico(3,7) CET -

* Este campo é formado de: Órgão (Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))

4.22.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

131
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.22.3. Lista de erros herdados da Consist

132
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

8111 Código de origem da transação não informado.

8112 Código identificação servidor não informado.
8133 Ação não executada. Número de sequência indisponível.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.22.4. Lista de novos erros

Código* Descrição**
4003 Nenhum contrato vigente
4004 Quantidade de contratos vigentes insuficiente.
4005 Não foi possível recuperar todos os contratos vigentes requeridos.
4006 O contrato pertence a outro vínculo.
4008 Rubrica não possui autorização para realizar consignação.
4011 Consignatária sem rubrica associada para este órgão.
4012 Contrato renovado dentro do mês não pode ser excluído.
4013 Contrato já se encontra quitado.
4015 Contrato sem rubrica disponível.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização nao permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
4042 Não permitida renovação de Consignação de cartão.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.

133
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.

4051 Consignatária desativada temporariamente.

* (cd_ret_code)
** (ds_ret_code)

4.22.5. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:renovarContratoV1>
<CD_CIA></CD_CIA>
<CD_EMPRESA></CD_EMPRESA>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
<NR_CPF_A>14477750153</NR_CPF_A>
<VL_LIQUIDO_A></VL_LIQUIDO_A>
<VL_OPERACAO_A>50,00</VL_OPERACAO_A>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<CD_USUARIO></CD_USUARIO>
<CD_ID_SERV>1</CD_ID_SERV>
<CD_ORIGEM_TRANS>1</CD_ORIGEM_TRANS>
<CD_SENHA_SERVIDOR></CD_SENHA_SERVIDOR>
<CD_CONVENIO_A>430110</CD_CONVENIO_A>
<QT_PRAZO_A>1</QT_PRAZO_A>
<DT_OPERACAO_A></DT_OPERACAO_A>
<DT_ANO_MES_A></DT_ANO_MES_A>
<NR_CONTRATO>55</NR_CONTRATO>
<DS_LIVRE></DS_LIVRE>
<QT_RENOVA_A>2</QT_RENOVA_A>
<NR_CONTRATO_1>20000102</NR_CONTRATO_1>

134
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<NR_CONTRATO_2>CCC-30-30</NR_CONTRATO_2>
<NR_CONTRATO_3></NR_CONTRATO_3>
<NR_CONTRATO_4></NR_CONTRATO_4>
<NR_CONTRATO_5></NR_CONTRATO_5>
<TX_EFETIVA_AUTO_A>?</TX_EFETIVA_AUTO_A>
</urn:renovarContratoV1>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:renovarContratoV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<nm_serv>CARMEN LUCINDA FARKAS DE ARAUJO</nm_serv>
<cd_bco_serv>001</cd_bco_serv>
<cd_age_serv>045942</cd_age_serv>
<cd_ccs_serv>327232X</cd_ccs_serv>
<in_sit_serv>1</in_sit_serv>
<in_class_serv>1</in_class_serv>
<im_foto></im_foto>
<nr_contrato>55</nr_contrato>
<seq_contrato></seq_contrato>
<vl_bruto>5000</vl_bruto>
<dt_prim_desc>201705</dt_prim_desc>
<data_operacao>20170418</data_operacao>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>

135
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</ns1:renovarContratoV1Response>
</soap:Body>
</soap:Envelope>

4.23. Operação cancelarAutorizacaoCartao (Disponível nas Versões V1 e

V2)

Operação responsável em cancelar autorizações para realização de consignações de

cartão consignado.
Deve ser utilizada quando existir a necessidade de cancelar as autorizações de cartão
consignado existentes em todos os vínculos funcionais do CPF informado.
A diferença entre esta e a operação cancelarAutorizacaoCartaoV1 é que esta última
cancela as autorizações de cartão consignado de apenas um vínculo funcional específico.

4.23.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CONSIG_A Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
NR_CPF_A Numérico(14) CPF do servidor X

4.23.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

4.23.3. Lista de erros

Código* Descrição**
0000 Serviço realizado com sucesso.
4043 Autorização de amortização de Cartão de Crédito (5%) não localizada.
8010 Consignatária inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.

136
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

8087 Código da Companhia não informado.

8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.23.4. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:cancelarAutorizacaoCartao>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<NR_CPF_A>14477750153</NR_CPF_A>
</urn:cancelarAutorizacaoCartao>
</soapenv:Body>
</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:cancelarAutorizacaoCartaoResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>

137
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</ns1:cancelarAutorizacaoCartaoResponse>
</soap:Body>
</soap:Envelope>

4.24. Operação cancelarAutorizacaoCartaoV1 (Disponível nas Versões V1

e V2)

Operação responsável em cancelar autorizações para realização de consignações de

cartão consignado.
Deve ser utilizada quando existir a necessidade de cancelar a autorização de cartão
consignado de um vínculo funcional específico do servidor público.
A diferença entre esta e a operação cancelarAutorizacaoCartao é que esta última
cancela as autorizações de cartão consignado de todos os vínculos funcionais do CPF
informado.

4.24.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CONSIG_A Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
NR_CPF_A Numérico(14) CPF do servidor X
CD_ORGAO Alfanumérico(10) Código do órgão X
CD_MATRICULA Alfanumérico(13) Matrícula do servidor X
ORG_MAT_INST Alfanumérico(12) Dados do Instituidor * P

* Este campo é formado de: Órgão(Alfanumérico(05)) + Matrícula do

Instituidor(Alfanumérico(07))

4.24.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

138
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.24.3. Lista de erros

Código* Descrição**
0000 Serviço realizado com sucesso.
2046 CPF não confere com a matrícula.
4043 Autorização de amortização de Cartão de Crédito (5%) não localizada.
8010 Consignatária inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8087 Código da Companhia não informado.
8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

4.24.4. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:cancelarAutorizacaoCartaoV1>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<NR_CPF_A>14477750153</NR_CPF_A>
<CD_ORGAO>13000</CD_ORGAO>
<CD_MATRICULA>897</CD_MATRICULA>
<ORG_MAT_INST></ORG_MAT_INST>
</urn:cancelarAutorizacaoCartaoV1>
</soapenv:Body>
</soapenv:Envelope>

139
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:cancelarAutorizacaoCartaoV1Response xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:cancelarAutorizacaoCartaoV1Response>
</soap:Body>
</soap:Envelope>

4.25. Operação consultarVinculosFuncionais (Disponível nas Versões V1

e V2)

Operação responsável em recuperar todos vínculos funcionais ativos de servidores e

pensionistas por CPF.
É comum que servidores e pensionistas sejam transferidos entre os órgãos federais
e, consequentemente, tenham o código do órgão e a matrícula do vínculo funcional
alterados.
Deve ser utilizada quando existir a necessidade de conhecer o código do órgão e
números corretos das matrículas dos vínculos funcionais ativos no momento.

4.25.1. Parâmetros de Entrada

Campos Estrutura Descrição Preenchimento

CD_CONSIG_A Numérico(06) Código da consignatária X
CD_SENHA_CONSIG Alfanumérico(12) Senha da consignatária X
NR_CPF_A Numérico(14) CPF do servidor X

140
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.25.2. Parâmetros de Saída

Nome da Tag Estrutura Descrição

Tag agrupadora dos dados da pessoa
dadosPessoa
consultada
cpf Numérico(11)
nome Alfanumérico(60)
Tag agrupadora com os vínculos
vinculosDeServidor funcionais de servidor da pessoa
consultada
vinculo - array
codOrgao Numérico(5) Código do órgão do vínculo funcional
nmOrgao Alfanumérico(40) Nome do órgão do vínculo funcional
Número da matrícula do vínculo
cdMatricula Alfanumérico(7)
funcional
Fim vinculo - array
Tag agrupadora com os vínculos
vinculosDePensionista funcionais de pensionista da pessoa
consultada
vinculo - array
codOrgao Numérico(5) Código do órgão do vínculo funcional
nmOrgao Alfanumérico(40) Nome do órgão do vínculo funcional
Número da matrícula do vínculo
cdMatricula Alfanumérico(7)
funcional
Órgão e matrícula do instituidor do
orgMatInst Alfanumérico(12)
vínculo funcional
Fim vinculo - array
cd_ret_code Numérico(04) Código de Retorno
ds_ret_code Alfanumérico(220) Mensagem de Retorno

4.25.3. Exemplo de Requisição SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:consignataria">
<soapenv:Header/>
<soapenv:Body>
<urn:consultarVinculosFuncionais>
<CD_CONSIG_A>115</CD_CONSIG_A>
<CD_SENHA_CONSIG>12345678</CD_SENHA_CONSIG>
<NR_CPF_A>261807404</NR_CPF_A>
</urn:consultarVinculosFuncionais>
</soapenv:Body>

141
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

</soapenv:Envelope>

Retorno da chamada:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:consultarVinculosFuncionaisResponse xmlns:ns1="urn:consignataria">
<return>
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<response>
<dadosPessoa>
<cpf>261807404</cpf>
<nome>NOME BENEFICIARIO</nome>
<vinculosDeServidor>
<vinculo>
<codOrgao>25000</codOrgao>
<nmOrgao>MINISTERIO DA SAUDE</nmOrgao>
<cdMatricula>0564155</cdMatricula>
</vinculo>
<vinculo>
<codOrgao>25000</codOrgao>
<nmOrgao>MINISTERIO DA SAUDE</nmOrgao>
<cdMatricula>6564155</cdMatricula>
</vinculo>
</vinculosDeServidor>
<vinculosDePensionista>
<vinculo>
<codOrgao>57202</codOrgao>
<nmOrgao>INSTITUTO NACIONAL DE SEGURO
SOCIAL</nmOrgao>
<cdMatricula>05642221</cdMatricula>
<orgMatInst>572026328469</orgMatInst>
</vinculo>
<vinculo>

142
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

<codOrgao>26240</codOrgao>
<nmOrgao>UNIVERSIDADE FEDERAL DA PARAIBA</nmOrgao>
<cdMatricula>05642221</cdMatricula>
<orgMatInst>262400328469</orgMatInst>
</vinculo>
</vinculosDePensionista>
</dadosPessoa>
<cd_ret_code>0000</cd_ret_code>
<ds_ret_code>Serviço realizado com sucesso.</ds_ret_code>
</response>
]]>
</return>
</ns1:consultarVinculosFuncionaisResponse>
</soap:Body>
</soap:Envelope>

4.25.4. Lista de erros

Código* Descrição**
0000 Serviço realizado com sucesso.
4054 CPF não possui vínculos ativos.
8010 Consignatária inexistente.
8036 Consignatária incorreta.
8056 Senha da consignatária incorreta.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.
8087 Código da Companhia não informado.
8083 Senha da consignatária não informada.
8089 CPF do servidor não informado.
8888 Serviço indisponível.

* (cd_ret_code)
** (ds_ret_code)

143
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4.26. Lista de todos os erros herdados da Consist

Código Descrição
0000 Serviço realizado com sucesso.
0002 Órgão inexistente.
0008 Convênio inexistente.
0087 Senha do funcionário expirada ou bloqueada
0087 Consignatária não autorizada a consignar pelo servidor/pensionista.
Autorização para consignação com data de validade expirada. O
0087
servidor/pensionista deverá gerar novo código de autorização no SIGEPE.
0024 Número contrato incorreto.
0029 Número contrato existente.
0056 Órgão não está ativo.
2027 Valor da prestação incorreto.
2027 Órgão incorreto.
2027 Matrícula incorreta.
2027 Matrícula Instituidor incorreta.
2027 Número do contrato incorreto.
2027 Convênio incorreto.
2027 Prazo incorreto.
2027 Ano/mês do 1° desconto incorreto
2027 Quantidade de contratos a renovar incorreta
2027 Número do contrato a renovar incorreto
2035 Servidor inativo.
2046 CPF não confere com a matrícula.
2048 Servidor falecido.
2109 Valor da prestação não informado
2109 Órgão não informado
2109 Matrícula não informada
2109 Número do contrato não informado
2109 Convênio não informado
2109 Prazo não informado
2109 Ano/mês do 1° desconto não informado
2109 Quantidade de contratos a renovar não informada
2215 Registro está sendo utilizado em outra operação.
2282 Senha do servidor não autenticada.
8010 Consignatária inexistente.
8014 Servidor inexistente.
8017 Contrato não localizado.
8028 Código de origem da transação incorreto.
8030 Código identificação servidor incorreto.
8035 Registro Hold incorreto.
8036 Consignatária incorreta.
8039 Senha do funcionário incorreta.
8056 Senha da consignatária incorreta.
8058 Funcionário não tem margem para essa solicitação.
8060 Senha da consignatária bloqueada.
8081 CPF incorreto.

144
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

8083 Senha da consignatária não informada.

8084 Senha do servidor da transação não informada.
8087 Código da Companhia não informado.
8089 CPF do servidor não informado.
8111 Código de origem da transação não informado.
8112 Código identificação servidor não informado.
8133 Ação não executada. Número de sequência indisponível.
8888 Serviço indisponível.

4.27. Lista de todos os erros novos

Código Descrição
4003 Nenhum contrato vigente
4004 Quantidade de contratos vigentes insuficiente.
4005 Não foi possível recuperar todos os contratos vigentes requeridos.
4006 O contrato pertence a outro vínculo.
4007 Situação do servidor não permite consignação.
4008 Rubrica não possui autorização para realizar consignação.
4009 Nenhum vínculo encontrado para este servidor.
4010 Valor e prazo iguais ao do contrato a ser alterado.
4011 Consignatária sem rubrica associada para este órgão.
4012 Contrato renovado dentro do mês não pode ser excluído.
4013 Contrato já se encontra quitado.
4014 Contrato sem renovação.
4015 Contrato sem rubrica disponível.
4016 Servidor ou Pensionista com renovação no mês corrente e sem sequência.
4017 Rubrica não pertence a esta consignatária.
4018 Rubrica não pode ser tratada por mov. de consignação.
4019 Servidor ou Pensionista bloqueado para rubrica/sequência.
Atualização nao permitida, conforme §3º do art. 25º do decreto 6386 de
4020
29/02/08.
4021 Rubrica não é facultativa.
4022 Prazo informado maior que o prazo estabelecido pelo MP.
4023 Problemas com a consignatária.
4024 Matrícula ou Órgão inválido.
4025 Cronograma do órgão não implantado.
4026 Rubrica não cadastrada.
4027 Rubrica desativada.
4028 Situação funcional da rubrica incompatível com a do servidor.
4029 Rubrica com incompatibilidade determinada por decisão judicial.
4030 Valor inferior ao valor mínimo permitido.
4031 Inclusão de rubrica/sequência já existente para o servidor/pensionista.
4032 Beneficiário excluído de pagamento.
4033 Beneficiário suspenso de pagamento.
4034 Servidor/Pensionista sem contrato ativo.
4035 Contratos zerados.

145
Documento de Integração - Web Service Gestão da Margem Consignável do Servidor

4036 Tipo de consignação só permite amortização.

4037 Contrato não pode desfazer renovação.
4038 Rubrica/Sequência do contrato.
4039 Contrato não pode ser alterado.
Já existe uma consignação de cartão vigente. Tipo de consignação permite
4040
somente uma consignação vigente.
4041 Consignação de cartão deve possuir prazo igual a 1.
4042 Não permitida renovação de Consignação de cartão.
4043 Autorização de amortização de Cartão de Crédito (5%) não localizada.
4044 CPF não cadastrado no SIAPE
Não é possível cancelar a renovação. Ano/Mês do último desconto do
4045
contrato a ser reativado já foi processado.
Rubrica possui restrição do tipo suspensão de consignação ativa com o
4046
servidor/pensionista.
Rubrica possui restrição do tipo exclusão de consignação ativa com o
4047
servidor/pensionista.
4048 Consignatária inabilitada.
4049 Consignatária descredenciada.
4050 Rubrica possui restrição de consignação ativa com o servidor/pensionista.
4051 Consignatária desativada temporariamente.
O novo prazo deve ser maior do que a quantidade de parcelas já
4052
descontadas.
4054 CPF não possui vínculos ativos.

146

Você também pode gostar

Manual Webservice TIP Brasil
Ainda não há avaliações
Manual Webservice TIP Brasil
10 páginas
Purchasing Guide Pro
100% (1)
Purchasing Guide Pro
314 páginas
Configuração DRC Inbound
Ainda não há avaliações
Configuração DRC Inbound
28 páginas
WS SiapeNet Gestão Consignação V2
Ainda não há avaliações
WS SiapeNet Gestão Consignação V2
163 páginas
SIGCT Manual Usuario
Ainda não há avaliações
SIGCT Manual Usuario
298 páginas
Manual de Contratos - Global - Totvs Gestão de Estoque Compras e Faturamento
100% (1)
Manual de Contratos - Global - Totvs Gestão de Estoque Compras e Faturamento
39 páginas
Manual Do Cliente - Criação de TCPs v2
Ainda não há avaliações
Manual Do Cliente - Criação de TCPs v2
43 páginas
22Z S4hana2021 BPD PT BR
100% (1)
22Z S4hana2021 BPD PT BR
160 páginas
Manual de Operacoes - Swap
Ainda não há avaliações
Manual de Operacoes - Swap
181 páginas
Manual Api Top Sapp
Ainda não há avaliações
Manual Api Top Sapp
122 páginas
Consultas MultiEmbarcador
Ainda não há avaliações
Consultas MultiEmbarcador
14 páginas
MIT2043 - Especificação de Parametrização - Contratos - 20180809
Ainda não há avaliações
MIT2043 - Especificação de Parametrização - Contratos - 20180809
12 páginas
Manual de Operacoes - SWAP
Ainda não há avaliações
Manual de Operacoes - SWAP
181 páginas
Integração de Propostas - WBC - 7.0
Ainda não há avaliações
Integração de Propostas - WBC - 7.0
50 páginas
Gerenciamento de Suporte e Serviços
Ainda não há avaliações
Gerenciamento de Suporte e Serviços
660 páginas
Manual Contrato de Serviços
Ainda não há avaliações
Manual Contrato de Serviços
10 páginas
WS Os
Ainda não há avaliações
WS Os
103 páginas
WSSiape Net Gestao Consignacao Nova Versao
Ainda não há avaliações
WSSiape Net Gestao Consignacao Nova Versao
150 páginas
Manual de Integração - 2.4
Ainda não há avaliações
Manual de Integração - 2.4
85 páginas
22Z - BR - Aquisição de Serviços
Ainda não há avaliações
22Z - BR - Aquisição de Serviços
158 páginas
Manual Integracao Gestor Creditov2
Ainda não há avaliações
Manual Integracao Gestor Creditov2
15 páginas
API de Servicos para Integracoes
Ainda não há avaliações
API de Servicos para Integracoes
111 páginas
Scope Item - 18J
100% (1)
Scope Item - 18J
30 páginas
Manual de Instalacao Da Integracao Bionexo v3.4
Ainda não há avaliações
Manual de Instalacao Da Integracao Bionexo v3.4
32 páginas
Sap Acm Application Help PT
Ainda não há avaliações
Sap Acm Application Help PT
328 páginas
MIT044IP - Integração Korus X Protheus
Ainda não há avaliações
MIT044IP - Integração Korus X Protheus
12 páginas
EDI WS Forn PT v3.11 1223332
Ainda não há avaliações
EDI WS Forn PT v3.11 1223332
28 páginas
Ariba 1701334361
Ainda não há avaliações
Ariba 1701334361
74 páginas
SOC - (Sis081m) - (280 - Manual de Procedimentos) 3. Web Services Disponíveis
Ainda não há avaliações
SOC - (Sis081m) - (280 - Manual de Procedimentos) 3. Web Services Disponíveis
13 páginas
ManualOrientacaoDesenvolvedor REINF v2.4
Ainda não há avaliações
ManualOrientacaoDesenvolvedor REINF v2.4
66 páginas
NFe Web Service
Ainda não há avaliações
NFe Web Service
51 páginas
Introducao A Teoria Democratica
0% (1)
Introducao A Teoria Democratica
11 páginas
E-Commerce - WebService - Manual de Integração - v06.4
Ainda não há avaliações
E-Commerce - WebService - Manual de Integração - v06.4
102 páginas
Manual de Leiautes RTM - Integração R2C3 - V2.2.0
Ainda não há avaliações
Manual de Leiautes RTM - Integração R2C3 - V2.2.0
67 páginas
GMP - Manual Tcnico - Clientes Novos v15 3 PDF
Ainda não há avaliações
GMP - Manual Tcnico - Clientes Novos v15 3 PDF
29 páginas
Documento de Transição - BAYER - BPV
Ainda não há avaliações
Documento de Transição - BAYER - BPV
15 páginas
Manual - de - Preenchimento E-Financeira PDF
Ainda não há avaliações
Manual - de - Preenchimento E-Financeira PDF
230 páginas
Codigos Conciliadora
Ainda não há avaliações
Codigos Conciliadora
22 páginas
NFe Web Service PDF
Ainda não há avaliações
NFe Web Service PDF
51 páginas
Manual Técnico Integração Plansyst WebService - 07112022
Ainda não há avaliações
Manual Técnico Integração Plansyst WebService - 07112022
22 páginas
Apostila - Módulo 2 - Arquiteto (A) de Soluções PDF
Ainda não há avaliações
Apostila - Módulo 2 - Arquiteto (A) de Soluções PDF
96 páginas
Documentacao MNTxBackOfficeRM 020813
Ainda não há avaliações
Documentacao MNTxBackOfficeRM 020813
84 páginas
NFe Web Service
Ainda não há avaliações
NFe Web Service
50 páginas
Manual Fabricante Digistar
100% (1)
Manual Fabricante Digistar
65 páginas
Manual Monocanal STS 250 360MHz
100% (3)
Manual Monocanal STS 250 360MHz
55 páginas
Manual de Integração v2 2-14 PDF
Ainda não há avaliações
Manual de Integração v2 2-14 PDF
68 páginas
Manual WebIntegra - Sister-Protheus - Versao 1.2
Ainda não há avaliações
Manual WebIntegra - Sister-Protheus - Versao 1.2
7 páginas
NFe Web Service v2.3 PMSP
Ainda não há avaliações
NFe Web Service v2.3 PMSP
49 páginas
Revista 112 PDF
Ainda não há avaliações
Revista 112 PDF
386 páginas
Construção de Webservice Via PI
Ainda não há avaliações
Construção de Webservice Via PI
22 páginas
BQ Aquaris X5 Plus Guia Completo Do Utilizador
0% (1)
BQ Aquaris X5 Plus Guia Completo Do Utilizador
87 páginas
GT-B6520L Ug Common
Ainda não há avaliações
GT-B6520L Ug Common
112 páginas
7 - Operating Instruction - Digital Interface DI B000, Profibus Interface - BEA - 250859-En-01
100% (1)
7 - Operating Instruction - Digital Interface DI B000, Profibus Interface - BEA - 250859-En-01
84 páginas
Pfsense +o+firewall+open+source+mais+poderoso+do+mercado
Ainda não há avaliações
Pfsense +o+firewall+open+source+mais+poderoso+do+mercado
53 páginas
Armário de Telecom
Ainda não há avaliações
Armário de Telecom
21 páginas
6-Curso IEC61850 Introdução Basico
100% (5)
6-Curso IEC61850 Introdução Basico
39 páginas
OMERJ2013
Ainda não há avaliações
OMERJ2013
8 páginas
Como Autenticar Documentacao Api - Cleaned
Ainda não há avaliações
Como Autenticar Documentacao Api - Cleaned
3 páginas
Caderno 6 - Configuração GPON
Ainda não há avaliações
Caderno 6 - Configuração GPON
11 páginas
Manual ClearWave 1.5 8x2M 205.1668.04-8 30.04.09 V01
Ainda não há avaliações
Manual ClearWave 1.5 8x2M 205.1668.04-8 30.04.09 V01
66 páginas
Roteiro - Telecomunicações Ópticas
Ainda não há avaliações
Roteiro - Telecomunicações Ópticas
11 páginas
Mapa Mental Aula 3 Informática
Ainda não há avaliações
Mapa Mental Aula 3 Informática
1 página
Cap 01
Ainda não há avaliações
Cap 01
25 páginas
Relatório de Plágio Pim Iv
Ainda não há avaliações
Relatório de Plágio Pim Iv
57 páginas
Curso Config Manut PLC 9030
Ainda não há avaliações
Curso Config Manut PLC 9030
24 páginas
Manual Placa Base Icip30 e PL Codec Icip Site
Ainda não há avaliações
Manual Placa Base Icip30 e PL Codec Icip Site
92 páginas
Como Rotear e Abrir Portas No Modem TelSec TS-9000 para o Velox - Blog Do Ciro Mota
Ainda não há avaliações
Como Rotear e Abrir Portas No Modem TelSec TS-9000 para o Velox - Blog Do Ciro Mota
27 páginas
Solucoes-Integradas-Com-Iot-Para-Aplicacoes-Em-Saneamento - Marcelo Wicthoff Pessoa - Schneider Electric
Ainda não há avaliações
Solucoes-Integradas-Com-Iot-Para-Aplicacoes-Em-Saneamento - Marcelo Wicthoff Pessoa - Schneider Electric
28 páginas
(Superpartituras - Com.br) Balada Do Louco
Ainda não há avaliações
(Superpartituras - Com.br) Balada Do Louco
19 páginas
Configurando o Serviço Triple Play
Ainda não há avaliações
Configurando o Serviço Triple Play
11 páginas
02-Modelos Sistemas Distribuidos
Ainda não há avaliações
02-Modelos Sistemas Distribuidos
20 páginas
Drucos-Manual Repetidores Sinal Celular A4
Ainda não há avaliações
Drucos-Manual Repetidores Sinal Celular A4
16 páginas
Introdução A Computação - Memória Principal - IFPA
Ainda não há avaliações
Introdução A Computação - Memória Principal - IFPA
16 páginas
Edital 6
Ainda não há avaliações
Edital 6
10 páginas
Contrato Wkve - Ampliação 7050
Ainda não há avaliações
Contrato Wkve - Ampliação 7050
15 páginas
Spo - DT - 7129354 - Varbra-Gp Ivestimentos - 2M - Novo PDF
Ainda não há avaliações
Spo - DT - 7129354 - Varbra-Gp Ivestimentos - 2M - Novo PDF
2 páginas
OMERJ2016
Ainda não há avaliações
OMERJ2016
9 páginas
Diferença Entre SNMP e CMIP
Ainda não há avaliações
Diferença Entre SNMP e CMIP
5 páginas
Segurança de Redes em Amientes Corporativos
Ainda não há avaliações
Segurança de Redes em Amientes Corporativos
5 páginas
Sincronizando o Relógio Do AD Com Uma Fonte Externa
Ainda não há avaliações
Sincronizando o Relógio Do AD Com Uma Fonte Externa
2 páginas
Exercícios Capitulo 2 Feitos (Kurose)
Ainda não há avaliações
Exercícios Capitulo 2 Feitos (Kurose)
5 páginas
Fatura Oi Conta Total 12-07-2011
Ainda não há avaliações
Fatura Oi Conta Total 12-07-2011
4 páginas
Faturamento Hospitalar
No Everand
Faturamento Hospitalar
Glauber G. Silva
Ainda não há avaliações
Sales Ops
No Everand
Sales Ops
Byanca Ramos
Ainda não há avaliações
Execução Trabalhista: Do Início Ao Fim
No Everand
Execução Trabalhista: Do Início Ao Fim
Sheila Gomes Leal Vasconcelos
Ainda não há avaliações
Engenharia De Produção Em Ação
No Everand
Engenharia De Produção Em Ação
Wellington Cícero Do Nascimento Soares
Ainda não há avaliações
Servidor Web Com Foco Em Vps
No Everand
Servidor Web Com Foco Em Vps
Ribamar Ferreira De Sousa
Ainda não há avaliações
Excel Avançado 2016 - 2019
No Everand
Excel Avançado 2016 - 2019
Kaique Franco
Ainda não há avaliações
Ética, Cidadania E Compromisso
No Everand
Ética, Cidadania E Compromisso
Vil Becker
Ainda não há avaliações
Fusões & Aquisições - M&a
No Everand
Fusões & Aquisições - M&a
José Antônio De Castro
Ainda não há avaliações
Modelos De Regressão Em R
No Everand
Modelos De Regressão Em R
Écio Souza Diniz E Jan Thiele
Ainda não há avaliações
Testando Componentes Eletrônicos
No Everand
Testando Componentes Eletrônicos
Luis Carlos Burgos
Ainda não há avaliações
Tópicos Sobre Metrologia Industrial
No Everand
Tópicos Sobre Metrologia Industrial
Romualdo Campos Da Fonsêca
Ainda não há avaliações
Produção Audiovisual
No Everand
Produção Audiovisual
Bruno Talarico
Ainda não há avaliações
Descobrindo A Segurança Cibernética
No Everand
Descobrindo A Segurança Cibernética
Jideon F Marques
Ainda não há avaliações
Desbloqueando O Sucesso Na Mentoria De Tic 2023: O Guia De Dinheiro Inteligente Para O Modelo Completo De Negociação Diária De Tic
No Everand
Desbloqueando O Sucesso Na Mentoria De Tic 2023: O Guia De Dinheiro Inteligente Para O Modelo Completo De Negociação Diária De Tic
Jideon F Marques
Ainda não há avaliações
Excel 2023 Power Pivot & Power Query
No Everand
Excel 2023 Power Pivot & Power Query
Jideon F Marques
Ainda não há avaliações

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.