Escolar Documentos
Profissional Documentos
Cultura Documentos
DAYPAG
WEB API CONSULTA\PGTO DÉBITOS
ESPECIFICAÇÃO TÉCNICA PARA CONSULTA\PGTO DE
DÉBITOS
BANCO DAYCOVAL
Índice
Introdução: ............................................................................................................................................... 3
Objetivo:................................................................................................................................................... 3
Esclarecimentos sobre o processo: ........................................................................................................ 3
Considerações técnicas: ......................................................................................................................... 5
Contato: ................................................................................................................................................... 5
URL Acesso: ............................................................................................................................................ 6
Controle de acesso: ................................................................................................................................. 6
Consulta de Débitos: ............................................................................................................................... 6
Consulta de Débitos V2: ........................................................................................................................ 10
Pagamento de Débitos: ......................................................................................................................... 14
Impressão de Recibo: ............................................................................................................................ 17
Consulta de Saldo Disponível: .............................................................................................................. 17
Consulta de Limite Disponível: .............................................................................................................. 18
Emissão de Títulos: ............................................................................................................................... 19
Reimpressão de Títulos: ........................................................................................................................ 20
Consulta de Títulos: ............................................................................................................................... 21
Consulta de Pagamentos: ..................................................................................................................... 22
Glossário de Tipos: ................................................................................................................................ 24
Exemplos JSON: ................................................................................................................................... 42
Tabelas: ................................................................................................................................................. 58
Histórico de Versão ............................................................................................................................... 80
Introdução:
Objetivo:
Este documento tem por objetivo descrever as especificações técnicas necessárias para o acesso a
operações em lotes de consultas e pagamentos de débitos relacionados a veículos realizadas dentro
do portal Daypag (www.daypag.com.br).
3) A SEFAZ-SP controla a relação entre consultas x arrecadações; o Banco Daycoval apura esta
relação por cliente e contatará quando discrepâncias forem detectadas. O índice ideal praticado é
20% de arrecadações em relação às consultas.
4) Não são admitidos robôs de consultas. Os processos devem ser inteligentes para evitar consultas
desnecessárias.
5) Esta API filtra as mensagens, mas, para compreensão, segue o fluxo de um pagamento:
Quando um cliente faz uma consulta, o Banco envia à PRODESP uma transação 9300.
A PRODESP retorna ao Banco a transação 9310.
Quando o Cliente efetiva o pagamento, o Banco envia à PRODESP uma transação 0200.
A PRODESP retorna ao Banco a transação 0210.
O Banco confirma que recebeu o retorno, enviando uma transação 0202.
Assim, em uma transação normal de consulta e pagamento, sem retornos diferentes de zero por
conta de regras de negócios, no mínimo cinco mensagens são disparadas.
O DAYPAG recebe as arrecadações da SEFAZ de acordo com o horário de corte atribuído a cada
cliente. O default é que os pagamentos em débito até 19:00 hs e em cheque até 16h00 sejam feitos
com a mesma data – a partir destes horários, serão autenticados com a data útil seguinte, o que pode
gerar diferenças em descontos e correção de IPVA por exemplo. Em caso de dúvidas, contatar o
atendimento pelo e-mail atendimento.daypag@bancodaycoval.com.br .
Estes horários acima são sempre alterados quando os dias 24/12 e 31/12 são dias úteis e o Banco
avisará previamente.
7) Regras específicas:
7.1) Para os serviços 001 (Licenciamento), 002 (Transferência) e 003 (Licenciamento e Transferên-
cia), são trazidos os débitos que impedem os serviços, ou seja, débitos vencidos – não são trazidas
multas ainda não vencidas e valores de IPVA parcelados ainda não vencidos.
7.2) Para os serviços 001 (Licenciamento), 002 (Transferência) e 003 (Licenciamento e Transferên-
cia), no início do exercício mesmo que o IPVA não esteja vencido ele será obrigatoriamente cobrado.
7.3) Para os serviços 001 (Licenciamento), 002 (Transferência) e 003 (Licenciamento e Transferên-
cia), caso o veículo possua multas RENAINF, os serviços retornarão mensagem específica e deverá
ser efetuada consulta do serviço 011 (Multas RENAINF). Só após o pagamento do serviço 011 que os
serviços 001, 002 e 003 serão permitidos.
7.4) Para os serviços 001 (Licenciamento) e 003 (Licenciamento e Transferência), caso o veículo não
tenha licenciado o ano anterior, durante a cobrança do IPVA do exercício vigente será necessário
licenciar o ano vencido e depois o vigente. Exemplo: se um veículo em 2022 não licenciou ainda o
ano de 2021: a) em abril/22 quando consultar o serviço 001 terá apenas o valor do licenciamento de
2021 e deverá pagar este para depois consultar e pagar 2022; b) em setembro/22 quando consultar o
serviço 001, terá os valores dos dois licenciamentos e poderá licenciar de uma vez.
7.5) O serviço 009 (DPVAT) continua ativo, mas não precisa ser consultado uma vez que os DPVATS
de 2021 e 2022 não estão sendo cobrados.
7.6) O serviço 010 (Multas) traz as multas municipais, estaduais e federais vencidas e não-vencidas.
Quando o veículo possui mais de 15 multas, este serviço necessitará ser utilizado para pagar as 15
primeiras e só depois que o número total de multas vencidas estiver menor que 15, serão aceitos os
serviços 001, 002 e 003.
8.1) A consulta detalhada de Licenciamento (001) traz os valores em aberto de IPVA e Multas, assim
como o valor da GARE do Licenciamento. Com o retorno dessa consulta é possível efetuar o
pagamento do Licenciamento 001 ou permitir que o cliente escolha pagar, por exemplo, um IPVA e
duas multas, fazendo assim um envio com as transações de pagamento com os serviços 008 e 010.
8.2) Uma sequência recomendável de consultas quando o cliente desejar conhecer os débitos e
escolher quais pagará: consultar o serviço 001; caso tenha o retorno “69-VEÍCULO COM MULTA
RENAINF-PAGAR PELA OPÇÃO MULTAS RENAINF”, efetuar consulta com os serviços 007 e 011.
Para a maioria dos veículos, a primeira consulta trará os débitos necessários.
8.3) Caso a consulta do serviço 001 traga o retorno “75- VEÍC.C/+ 15 MULTAS-PAGAR PELA
OPÇÃO MULTAS”, será necessário efetuar consulta com o serviço 007 e avisar o cliente que os
valores são maiores e só poderão ser visualizados após o pagamento das 15 multas apresentadas,
escolhendo então o serviço 010 para pagar as multas já apresentadas.
Considerações técnicas:
Toda a chamada e retorno deverá ser gerado no padrão JSON respeitando-se o layout especificado
neste manual, com suas estruturas e restrições.
Não se faz necessário nenhum tipo de encriptação dos pacotes de chamada e retorno do conteúdo
JSON.
Existem dois endereços para acesso a WEB API, um aponta para o ambiente de Homologação e
outro para o ambiente de Produção. Para o ambiente de Homologação é necessário sempre solicitar
uma lista de RENAVANS válidos já que a PRODESP não disponibiliza a base completa cadastrada
no estado.
As consultas e pagamentos são feitas de forma Online com a PRODESP. Ou seja, não é possível o
estorno após o pagamento e impressão do recibo.
A descrição dos parâmetros de funções e campos de registros apresentados neste manual segue a
convenção da tabela a seguir.
# Descrição Observação
A campo alfanumérico em alguns casos: completado com espaços à direita e
preenchido com espaços, quando não informado
N campo numérico em alguns casos: completado com zeros à esquerda e
preenchido com zeros, quando não informado
Contato:
Todas estas informações, solicitações e dúvidas devem ser enviadas para o email
atendimento.daypag@bancodaycoval.com.br
URL Acesso:
Homologação:
O endereço principal dos serviços para a homologação é http://187.9.76.122:8901
Para acessar o ambiente de homologação, é necessário que o IP do servidor de origem seja fixo e o
mesmo seja liberado em nosso firewall.
Produção:
O endereço principal dos serviços para a produção é http://172.23.64.82:8090
Para acessar o ambiente de produção, é necessário configurar uma VPN.
Controle de acesso:
Consulta de Débitos:
Será disponibilizado a consulta aos débitos de veículos cadastrados no estado de São Paulo de
forma online com a PRODESP. Os serviços contemplados e disponíveis pela WEB API estão listados
no anexo TABELA 1 ao final do documento.
O Layout JSON abaixo é um exemplo com todos os campos. A obrigatoriedade de envio ou retorno
vai depender do serviço utilizado. (Vide Item com exemplos JSON a partir da página 39).
Método
Nome ConsultarDebitos
Url Homologação: POST http://187.9.76.122:8901/Debito/ConsultarDebitos
Produção: POST http://172.23.64.82:8090/Debito/ConsultarDebitos
Descrição Obtém os débitos de veículos cadastrados no Estado de São Paulo.
‘
Parâmetros de Envio
Tipo ParametroDebitoDto
Formato Objeto
Descrição Objeto que contém o lote de consulta de débitos com os RENAVANS/Documentos
Exemplo
Body {
"TokenCliente":"Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento":"D",
"ListaParametroDebitoVeiculo":[
{
"Renavam":"00284057541",
"Documento":"",
"CodServico":"7",
"CodSubServico":"0",
"TipoConsulta":"D"
},
{
"Renavam":"00284103578",
"Documento":"",
"CodServico":"7",
"CodSubServico":"0",
"TipoConsulta":"D"
}
]
}
Parâmetros de retorno
Tipo DebitoResultDto
Formato Objeto
Descrição Objeto que contém o lote de retorno de débitos para os RENAVANS/Documentos.
Exemplo
{
"ListaDebitos":[
{
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"Exercicio":"",
"Nome":"",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"CodServico":"9",
"CodSubServico":"0",
"TipoConsulta":"S",
"Ocorrencia":{
"CodOcorrencia":"99",
"Descricao":""
},
"Retorno":{
"TipoRetorno":"0",
"Mensagem":""
},
"DataMovimento":"AAAA-MM-DD",
"DataHoraConsulta":"AAAA-MM-DD HH:MM:SS",
"ValorTotal":"99999.99",
"Correio":{
"Valor":"99.99",
"TipoCorreio":"1"
},
"ValorTaxas":"9999.99",
"ValorIpvas":"9999.99",
"ValorDpvats":"9999.99",
"ValorMultas":"9999.99",
"ValorMultasRenainf":"9999.99"
},
{
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"Exercicio":"",
"Nome":"",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"CodServico":"9",
"CodSubServico":"0",
"TipoConsulta":"D",
"Ocorrencia":{
"CodOcorrencia":"99",
"Descricao":""
},
"Retorno":{
"TipoRetorno":"0",
"Mensagem":""
},
"DataMovimento":"AAAA-MM-DD",
"DataHoraConsulta":"AAAA-MM-DD HH:MM:SS",
"ValorTotal":"99999.99",
"Correio":{
"Valor":"99.99",
"TipoCorreio":"1"
},
"ValorTaxas":"9999.99",
"ValorIpvas":"9999.99",
"ValorDpvats":"9999.99",
"ValorMultas":"9999.99",
"ValorMultasRenainf":"9999.99",
"Taxas":[
{
"Valor":"9999.99",
"Descricao":"",
"Ano":"9999"
}
],
"IpvaAtual":{
"Exercicio":"9999",
"DataVencimentoComDesconto":"AAAA-MM-DD",
"ValorComDesconto":"9999.99",
"DataVencimentoSemDesconto":"AAAA-MM-DD",
"ValorSemDesconto":"9999.99",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela1":"9999.99",
"DataVencimentoParcela2":"AAAA-MM-DD",
"ValorParcela2":"9999.99",
"DataVencimentoParcela3":"AAAA-MM-DD",
"ValorParcela3":"9999.99",
"DataVencimentoParcela4":"AAAA-MM-DD",
"ValorParcela4":"9999.99",
"DataVencimentoParcela5":"AAAA-MM-DD",
"ValorParcela5":"9999.99",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela6":"9999.99"
},
"Ipvas":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
}
],
"DpvatAtual":{
"Valor":"9999.99",
"Exercicio":"9999",
"CategoriaDpvat":"9",
"TipoVeiculo":"2",
"DataVencimento":"AAAA-MM-DD",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela1":"9999.99",
"DataVencimentoParcela2":"AAAA-MM-DD",
"ValorParcela2":"9999.99",
"DataVencimentoParcela3":"AAAA-MM-DD",
"ValorParcela3":"9999.99",
"DataVencimentoParcela4":"AAAA-MM-DD",
"ValorParcela4":"9999.99",
"DataVencimentoParcela5":"AAAA-MM-DD",
"ValorParcela5":"9999.99",
"DataVencimentoParcela6":"AAAA-MM-DD",
"ValorParcela6":"9999.99"
},
"Dpvats":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaDpvat":"9",
"CategoriaDpvat":"9",
"TipoVeiculo":"2"
}
],
"Multas":[
{
"Aiip":"",
"Guia":"",
"CodSegmento":"",
"CodEmpresaOrgao":"",
"DataInfracao":"AAAA-MM-DD",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"Enquadramento":{
"CodEnquadramento":"9999",
"Descricao":""
},
"DataVencimento":"AAAA-MM-DD",
"Valor":"9999.99",
"OrgaoAutuador":{
"CodOrgaoAutuador":"999999",
"Nome":""
}
}
],
"MultasRenainf":[
{
"Aiip":"",
"Guia":"",
"DataInfracao":"AAAA-MM-DD",
"Uf":"",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"Enquadramento":{
"CodEnquadramento":"9999",
"Descricao":""
},
"DataVencimento":"AAAA-MM-DD",
"Valor":"9999.99",
"OrgaoAutuador":{
"CodOrgaoAutuador":"9999",
"Nome":""
}
}
]
]
}
Será disponibilizado a consulta aos débitos de veículos cadastrados no estado de São Paulo de for-
ma online com a PRODESP. Os serviços contemplados e disponíveis pela WEB API estão listados no
anexo TABELA 1 ao final do documento.
O Layout JSON abaixo é um exemplo com todos os campos. A obrigatoriedade de envio ou retorno
vai depender do serviço utilizado. (Vide Item com exemplos JSON mais ao final do documento).
OBS: Esta versão contempla a segregação das taxas do serviço 3 - Licenciamento + Transferência.
Para os demais serviços, o retorno é idêntico ao método de consulta de débitos anterior.
Método
Nome ConsultarDebitos
Url Homologação: POST http://187.9.76.122:8901/Debito/ConsultarDebitos/v2
Produção: POST http://172.23.64.82:8090/Debito/ConsultarDebitos/v2
Descrição Obtém os débitos de veículos cadastrados no Estado de São Paulo.
Parâmetros de Envio
Tipo ParametroDebitoDto
Formato Objeto
Descrição Objeto que contém o lote de consulta de débitos com os RENAVANS/Documentos
Exemplo
Body {
"TokenCliente":"Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento":"D",
"ListaParametroDebitoVeiculo":[
{
"Renavam":"00284057541",
"Documento":"",
"CodServico":"7",
"CodSubServico":"0",
"TipoConsulta":"D"
},
{
"Renavam":"00284103578",
"Documento":"",
"CodServico":"7",
"CodSubServico":"0",
"TipoConsulta":"D"
}
]
}
Parâmetros de Retorno
Tipo DebitoResultDto
Formato Objeto
Descrição Objeto que contém o lote de retorno de débitos para os RENAVANS/Documentos.
Exemplo
{
"ListaDebitos":[
{
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"Exercicio":"",
"Nome":"",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"CodServico":"9",
"CodSubServico":"0",
"TipoConsulta":"S",
"Ocorrencia":{
"CodOcorrencia":"99",
"Descricao":""
},
"Retorno":{
"TipoRetorno":"0",
"Mensagem":""
},
"DataMovimento":"AAAA-MM-DD",
"DataHoraConsulta":"AAAA-MM-DD HH:MM:SS",
"ValorTotal":"99999.99",
"Correio":{
"Valor":"99.99",
"TipoCorreio":"1"
},
"ValorTaxas":"9999.99",
"ValorIpvas":"9999.99",
"ValorDpvats":"9999.99",
"ValorMultas":"9999.99",
"ValorMultasRenainf":"9999.99"
},
{
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"Exercicio":"",
"Nome":"",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"CodServico":"9",
"CodSubServico":"0",
"TipoConsulta":"D",
"Ocorrencia":{
"CodOcorrencia":"99",
"Descricao":""
},
"Retorno":{
"TipoRetorno":"0",
"Mensagem":""
},
"DataMovimento":"AAAA-MM-DD",
"DataHoraConsulta":"AAAA-MM-DD HH:MM:SS",
"ValorTotal":"99999.99",
"Correio":{
"Valor":"99.99",
"TipoCorreio":"1"
},
"ValorTaxas":"9999.99",
"ValorIpvas":"9999.99",
"ValorDpvats":"9999.99",
"ValorMultas":"9999.99",
"ValorMultasRenainf":"9999.99",
"Taxas":[
{
"Valor":"9999.99",
"Descricao":"Transferencia",
"Ano":"9999"
},
{
"Valor":"9999.99",
"Descricao":"Licenciamento",
"Ano":"9999"
}
],
"IpvaAtual":{
"Exercicio":"9999",
"DataVencimentoComDesconto":"AAAA-MM-DD",
"ValorComDesconto":"9999.99",
"DataVencimentoSemDesconto":"AAAA-MM-DD",
"ValorSemDesconto":"9999.99",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela1":"9999.99",
"DataVencimentoParcela2":"AAAA-MM-DD",
"ValorParcela2":"9999.99",
"DataVencimentoParcela3":"AAAA-MM-DD",
"ValorParcela3":"9999.99",
"DataVencimentoParcela4":"AAAA-MM-DD",
"ValorParcela4":"9999.99",
"DataVencimentoParcela5":"AAAA-MM-DD",
"ValorParcela5":"9999.99",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela6":"9999.99"
},
"Ipvas":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
}
],
"DpvatAtual":{
"Valor":"9999.99",
"Exercicio":"9999",
"CategoriaDpvat":"9",
"TipoVeiculo":"2",
"DataVencimento":"AAAA-MM-DD",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela1":"9999.99",
"DataVencimentoParcela2":"AAAA-MM-DD",
"ValorParcela2":"9999.99",
"DataVencimentoParcela3":"AAAA-MM-DD",
"ValorParcela3":"9999.99",
"DataVencimentoParcela4":"AAAA-MM-DD",
"ValorParcela4":"9999.99",
"DataVencimentoParcela5":"AAAA-MM-DD",
"ValorParcela5":"9999.99",
"DataVencimentoParcela6":"AAAA-MM-DD",
"ValorParcela6":"9999.99"
},
"Dpvats":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaDpvat":"9",
"CategoriaDpvat":"9",
"TipoVeiculo":"2"
}
],
"Multas":[
{
"Aiip":"",
"Guia":"",
"CodSegmento":"",
"CodEmpresaOrgao":"",
"DataInfracao":"AAAA-MM-DD",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"Enquadramento":{
"CodEnquadramento":"9999",
"Descricao":""
},
"DataVencimento":"AAAA-MM-DD",
"Valor":"9999.99",
"OrgaoAutuador":{
"CodOrgaoAutuador":"999999",
"Nome":""
}
}
],
"MultasRenainf":[
{
"Aiip":"",
"Guia":"",
"DataInfracao":"AAAA-MM-DD",
"Uf":"",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"Enquadramento":{
"CodEnquadramento":"9999",
"Descricao":""
},
"DataVencimento":"AAAA-MM-DD",
"Valor":"9999.99",
"OrgaoAutuador":{
"CodOrgaoAutuador":"9999",
"Nome":""
}
}
]
]
}
Pagamento de Débitos:
O Layout JSON abaixo é um exemplo com todos os campos. A obrigatoriedade de envio ou retorno
vai depender do serviço utilizado. (Vide Item com exemplos JSON a partir da página 39).
Método
Nome PagarDebitos
Url Homologação: POST http://187.9.76.122:8901/Debito/PagarDebitos
Produção: POST http://172.23.64.82:8090/Debito/PagarDebitos
Descrição Efetua pagamentos dos débitos de veículos cadastrados no Estado de São Paulo.
Parâmetros de Envio
Tipo ParametroPagamentoDto
Formato Objeto
Descrição Objeto que contém o lote de pagamento de débitos com os RENAVANS/Documentos
Exemplo
Body {
"TokenCliente":"Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento":"D",
"PagamentoDuplicado":"S",
"listaParametroPagamentoVeiculo":[ {
"CodServico":"9",
"CodSubServico":"999",
"ValorTotal":"99999.99",
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"Nome":"",
"CodFederal":"9999",
"ControleCliente":"",
"Ipvas":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
}
],
"Dpvats":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaDpvat":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaDpvat":"8"
}
],
"Multas":[
{
"Aiip":"",
"Guia":"",
"Valor":"9999.99
},
{
"Aiip":"",
"Guia":"",
"Valor":"9999.99
}
],
"MultasRenainf":[
{
"Aiip":"",
"Guia":"",
"Valor":"9999.99"
},
{
"Aiip":"",
"Guia":"",
"Valor":"9999.99"
}
],
"IpvaAtual":{
"Endereco":"",
"CEP":"",
"MarcaModelo":"",
"PlacaAnterior":"",
"Placa":"",
"Chassi":"",
"Combustivel":"",
"EspecieTipo":"",
"Procedencia":"N",
"AnoFabricacao":"AAAA",
"CotaIpva":"8",
"DataVencimento":"AAAA-MM-DD",
"DataCompra":"AAAA-MM-DD",
"Faixa":"",
"Exercicio":"AAAA",
"ValorNota":"9999.99",
"ValorJuros":"9999.99",
"ValorMulta":"9999.99",
"ValorMultaInfracao":"9999.99",
"Valor":"9999.99"
},
"DpvatAtual":{
"Exercicio":"",
"CotaDpvat":"9",
"CategoriaDpvat":"9",
"TipoVeiculo":"2",
"Chassi":"",
"DataInicioVigencia":"AAAA-MM-DD",
"DataFimVigencia":"AAAA-MM-DD",
"ValorIof":"9999.99",
"Valor":"9999.99"
}
}
]
}
Parâmetros de Retorno
Tipo PagamentoResultDto
Formato Objeto
Descrição Objeto que contém o lote retorno de pagamento dos débitos para os RENAVANS.
Exemplo
{
"ListaPagamentos":[
{
"CodServico":"9",
"CodSubServico":"9",
"ValorTotal":"999999999.99",
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"DataMovimento":"AAAA-MM-DD",
"DataHoraPagamento":"AAAA-MM-DD HH:MM:SS",
"Ocorrencia":{
"CodOcorrencia":"99",
"Descricao":""
},
"Retorno":{
"TipoRetorno":"0",
"Mensagem":""
},
"CodRecibo":"000000000000",
"NsuBanco":"000000000000",
"NsuProdesp":"000000000000"
},
{
"CodServico":"9",
"CodSubServico":"9",
"ValorTotal":"999999999,99",
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"DataMovimento":"AAAA-MM-DD",
"DataHora":"AAAA-MM-DD HH:MM:SS",
"Ocorrencia":{
"CodOcorrencia":"99",
"Descricao":""
},
"CodRecibo":"000000000000",
"NsuBanco":"000000000000",
"NsuProdesp":"000000000000"
} ]
}
Impressão de Recibo:
Método
Nome ImprimirRecibo
Url Homologação: POST http://187.9.76.122:8901/Debito/ImprimirRecibo
Produção: POST http://172.23.64.82:8090/Debito/ImprimirRecibo
Descrição Obtém o recibo de pagamentos efetuados.
Parâmetros de Envio
Tipo ParametroReciboDto
Formato Objeto
Descrição Objeto que contém número do recibo a ser impresso/reimpresso
Exemplo {
Body "tokenCliente":"Bu18uY840TUu6LyaoaVK6w==",
"codRecibo":"99999999999"
}
Parâmetros de Retorno
Tipo ReciboImpressoResultDto
Formato Objeto
Descrição Objeto que contém o Array de Bytes do recibo de pagamento.
Exemplo {
" ReciboRetorno":
{
"CodRecibo":"99999999999",
"Pdf":""
}
}
Será disponibilizada a consulta do saldo disponível para a conta utilizando a WEB API.
Método
Nome ConsultarSaldoDisponivel
Url Homologação: POST http://187.9.76.122:8901/Debito/ConsultarSaldoDisponivel
Produção: POST http://172.23.64.82:8090/Debito/ConsultarSaldoDisponivel
Descrição Obtém o saldo disponível para a conta.
Parâmetros de Envio
Tipo ParametroSaldoDisponivelDto
Formato Objeto
Descrição Objeto que contém o cliente a ser consultado.
Exemplo {
Body "TokenCliente":"Bu18uY840TUu6LyaoaVK6w=="
}
Parâmetros de Retorno
Tipo SaldoDisponivelResultDto
Formato Objeto
Descrição Objeto que contém o valor do saldo disponível para a conta.
Exemplo {
"SaldoDisponivel":
{
"Valor":999999.99
}
}
Será disponibilizada a consulta do limite de giro disponível para a conta utilizando a WEB API.
Método
Nome ConsultarLimiteDisponivel
Url Homologação: POST http://187.9.76.122:8901/Debito/ConsultarLimiteDisponivel
Produção: POST http://172.23.64.82:8090/Debito/ConsultarLimiteDisponivel
Descrição Obtém o limite de giro disponível para a conta.
Parâmetros de Envio
Tipo ParametroLimiteDisponivelDto
Formato Objeto
Descrição Objeto que contém o cliente a ser consultado.
Exemplo {
Body "TokenCliente":"Bu18uY840TUu6LyaoaVK6w=="
}
Parâmetros de Retorno
Tipo LimiteDisponivelResultDto
Formato Objeto
Descrição Objeto que contém o valor do limite de giro disponível para a conta.
Exemplo {
"LimiteDisponivel":
{
"Valor":999999.99
}
}
Emissão de Títulos:
Será disponibilizada a emissão de títulos de cobrança utilizando a WEB API.
Método
Nome EmitirTitulo
Url Homologação: POST http://187.9.76.122:8901/Titulo/EmitirTitulo
Produção: POST http://172.23.64.82:8090/Titulo/EmitirTitulo
Descrição Emite o título de cobrança.
Parâmetros de Envio
Tipo ParametroEmissaoTituloDto
Formato Objeto
Descrição Objeto que contém o título de cobrança a ser emitido.
Exemplo {
Body "TokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"ParametroEmissaoTitulo":
{
"Valor": 999.99,
"DataVencimento": "AAAA-MM-DD",
"TipoNomeSacador": "F",
"NomePagador": "NOME DO PAGADOR",
"DocumentoPagador": "99999999999",
"TipoPessoaPagador": "F",
"EnderecoPagador": "ENDERECO DO PAGADOR",
"BairroPagador": "BAIRRO DO PAGADOR",
"CidadePagador": "CIDADE DO PAGADOR",
"UfPagador": "SP",
"CepPagador": "99999999",
"DddPagador": "11",
"TelefonePagador": "999999999",
"EmailPagador": "EMAILPAGADOR@EXEMPLO.COM.BR",
"Instrucao1": "INSTRUCAO 1",
"Instrucao2": " INSTRUCAO 2",
"Instrucao3": "INSTRUCAO 2",
"Instrucao4": "INSTRUCAO 4"
}
}
Parâmetros de Retorno
Tipo EmitirTituloResultDto
Formato Objeto
Descrição Objeto que contém o título de cobrança emitido.
Exemplo {
"Titulo":{
"NossoNumero":"00843491427",
"LinhaDigitavel":"99999.99999 99999.999999 99999.999999 9 99999999999999",
"CodBarras":"99999999999999999999999999999999999999999999",
"Valor":999.99,
"DataVencimento":"AAAA-MM-DD",
"Pdf":"",
"Retorno":{
"TipoRetorno":0
}
}
}
‘
Reimpressão de Títulos:
Método
Nome EmitirTitulo
Url Homologação: POST http://187.9.76.122:8901/Titulo/ReimprimirTitulo
Produção: POST http://172.23.64.82:8090/Titulo/ReimprimirTitulo
Descrição Reimprime o título de cobrança.
Parâmetros de Envio
Tipo ParametroReimpressaoTituloDto
Formato Objeto
Descrição Objeto que contém o título de cobrança a ser reimpresso.
Exemplo {
Body "TokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"NossoNumero": "99999999999"
}
Parâmetros de Retorno
Tipo EmitirTituloResultDto
Formato Objeto
Descrição Objeto que contém o título de cobrança reimpresso.
Exemplo {
"Titulo":{
"NossoNumero":"00843491427",
"LinhaDigitavel":"99999.99999 99999.999999 99999.999999 9 99999999999999",
"CodBarras":"99999999999999999999999999999999999999999999",
"Valor":999.99,
"DataVencimento":"AAAA-MM-DD",
"Pdf":"",
"Retorno":{
"TipoRetorno":0
}
}
}
Consulta de Títulos:
Será disponibilizada a consulta de títulos de cobrança utilizando a WEB API.
Método
Nome ConsultarTitulo
Url Homologação: POST http://187.9.76.122:8901/Titulo/ConsultarTitulo
Produção: POST http://172.23.64.82:8090/Titulo/ConsultarTitulo
Descrição Consulta o título de cobrança.
Parâmetros de Envio
Tipo ParametroConsultarTituloDto
Formato Objeto
Descrição Objeto que contém o título de cobrança a ser consultado.
Exemplo {
Body "TokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"ParametroConsultaTitulo":
{
"NossoNumero": "99999999999",
"Valor": 999.99,
"DataVencimentoDe":"AAAA-MM-DD",
"DataVencimentoAte":"AAAA-MM-DD",
"DataHoraGravacaoDe":"AAAA-MM-DD HH:MM:SS",
"DataHoraGravacaoAte":"AAAA-MM-DD HH:MM:SS"
}
}
Parâmetros de Retorno
Tipo ConsultarTituloResultDto
Formato Objeto
Descrição Objeto que contém o título de cobrança consultado.
Exemplo {
"ListaTitulos":[
{
"NossoNumero":"99999999999",
"DataVencimento":"AAAA-MM-DD",
"DataHoraGravacao":"AAAA-MM-DD HH:MM:SS",
"ValorOriginal":999.99,
"CodBarras":"99999999999999999999999999999999999999999999",
"LinhaDigitavel":"99999.99999 99999.999999 99999.999999 9 99999999999999",
"IndCompensacao":false
},
{
"NossoNumero":"99999999999",
"DataVencimento":"AAAA-MM-DD",
"DataHoraGravacao":"AAAA-MM-DD HH:MM:SS",
"ValorOriginal":999.99,
"CodBarras":"99999999999999999999999999999999999999999999",
"LinhaDigitavel":"99999.99999 99999.999999 99999.999999 9 99999999999999",
"IndCompensacao":true,
"ValorCompensacao":999.999,
"DataCompensacao":" "AAAA-MM-DD"
}],
"Retorno":
{
"TipoRetorno":0
}
}
Consulta de Pagamentos:
Será disponibilizada a consulta de pagamentos utilizando a WEB API.
Método
Nome ConsultarPagamento
Url Homologação: POST http://187.9.76.122:8901/Pagamento/ConsultarPagamento
Produção: POST http://172.23.64.82:8090/Pagamento/ConsultarPagamento
Descrição Consulta o título de cobrança.
Parâmetros de Envio
Tipo ParametroConsultarPagamentoDto
Formato Objeto
Descrição Objeto que contém o pagamento a ser consultado.
Exemplo {
Body "TokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"ParametroConsultaPagamento":
{
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"DataAutenticacao":"AAAA-MM-DD",
"DataPagamento":"AAAA-MM-DD",
"TipoConsulta":"S(Simplificado) ou D(Detalhado)",
}
}
Parâmetros de Retorno
Tipo ConsultarPagamentoResultDto
Formato Objeto
Descrição Objeto que contém o pagamento consultado detalhado.
Exemplo {
"ListaPagamentos":[
{
"CodRecibo":99999999,
"Renavam":"99999999999",
"Placa":"XXX9999",
"Documento":"99999999999999",
"DataAutenticacao":"AAAA-MM-DD",
"DataHoraPagamento":"AAAA-MM-DD HH:MM:SS",
"ValorTotal":999.99,
"CodServico":99,
"DscServico":"Descrição do Serviço",
"OrigemPagamento":"Descrição da Origem do Pagamento",
"AutenticacaoDigital":"999999999999999999999999999999999999999999"
"NsuBanco":"999999999",
"NsuProdesp":"999999999",
"Taxas":[
{
"Valor":"9999.99",
"Descricao":"Transferencia",
"Ano":"9999"
},
{
"Valor":"9999.99",
"Descricao":"Licenciamento",
"Ano":"9999"
}
],
"IpvaAtual":{
"Exercicio":"9999",
"DataVencimentoComDesconto":"AAAA-MM-DD",
"ValorComDesconto":"9999.99",
"DataVencimentoSemDesconto":"AAAA-MM-DD",
"ValorSemDesconto":"9999.99",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela1":"9999.99",
"DataVencimentoParcela2":"AAAA-MM-DD",
"ValorParcela2":"9999.99",
"DataVencimentoParcela3":"AAAA-MM-DD",
"ValorParcela3":"9999.99",
"DataVencimentoParcela4":"AAAA-MM-DD",
"ValorParcela4":"9999.99",
"DataVencimentoParcela5":"AAAA-MM-DD",
"ValorParcela5":"9999.99",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela6":"9999.99"
},
"Ipvas":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
},
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaIpva":"8"
}
],
"DpvatAtual":{
"Valor":"9999.99",
"Exercicio":"9999",
"CategoriaDpvat":"9"
"TipoVeiculo":"2",
"DataVencimento":"AAAA-MM-DD",
"DataVencimentoParcela1":"AAAA-MM-DD",
"ValorParcela1":"9999.99",
"DataVencimentoParcela2":"AAAA-MM-DD",
"ValorParcela2":"9999.99",
"DataVencimentoParcela3":"AAAA-MM-DD",
"ValorParcela3":"9999.99",
"DataVencimentoParcela4":"AAAA-MM-DD",
"ValorParcela4":"9999.99",
"DataVencimentoParcela5":"AAAA-MM-DD",
"ValorParcela5":"9999.99",
"DataVencimentoParcela6":"AAAA-MM-DD",
"ValorParcela6":"9999.99"
},
"Dpvats":[
{
"Valor":"9999.99",
"Exercicio":"9999",
"CotaDpvat":"9",
"CategoriaDpvat":"9",
"TipoVeiculo":"2"
}
],
"Multas":[
{
"Aiip":"",
"Guia":"",
"CodSegmento":"",
"CodEmpresaOrgao":"",
"DataInfracao":"AAAA-MM-DD",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"Enquadramento":{
"CodEnquadramento":"9999",
"Descricao":""
},
"DataVencimento":"AAAA-MM-DD",
"Valor":"9999.99",
"OrgaoAutuador":{
"CodOrgaoAutuador":"999999",
"Nome":""
}
}
],
"MultasRenainf":[
{
"Aiip":"",
"Guia":"",
"DataInfracao":"AAAA-MM-DD",
"Uf":"",
"Municipio":{
"CodFederal":"99999",
"CodEstadual":"99999",
"Nome":""
},
"Enquadramento":{
"CodEnquadramento":"9999",
"Descricao":""
},
"DataVencimento":"AAAA-MM-DD",
"Valor":"9999.99",
"OrgaoAutuador":{
"CodOrgaoAutuador":"9999",
"Nome":""
}
}
],
"Retorno":
{
"TipoRetorno":0
}
}
Glossário de Tipos:
1. TokenCliente
TokenCliente
Propriedade Tipo Formato Obrig. Descrição
TokenCliente String A (50) Sim Token de Identificação da Conta Corrente do Cliente
2. FormaPagamento
FormaPagamento
Propriedade Tipo Formato Obrig. Descrição
FormaPagamento String A (1) Não Forma de Pagamento = “D” - Débito em Conta ou “C”
- Troca de Cheque (Caso não seja preenchida, a
forma de pagamento “D” - Débito em Conta será
assumida como padrão)
3. PagamentoDuplicado
PagamentoDuplicado
Propriedade Tipo Formato Obrig. Descrição
PagamentoDuplicado String A (1) Não Pagamento Duplicado = “S” - Sim ou “N” - Não
(Caso não seja preenchido, o indicador de
pagamento duplicado “N” - Não, será assumido
como padrão).
4. TipoNomeSacador
TipoNomeSacador
Propriedade Tipo Formato Obrig. Descrição
TipoNomeSacador String A (1) Sim Tipo do Nome do Sacador (Beneficiário) = “N” -
Nome ou “F” - Nome Fantasia
5. TipoPessoaPagador
TipoPessoaPagador
Propriedade Tipo Formato Obrig. Descrição
TipoPessoaPagador String A (1) Sim Tipo de pessoa do Pagador = “F” - Física ou “J” -
Jurídica
6. OrigemPagamento
TipoPessoaPagador
Propriedade Tipo Formato Obrig. Descrição
OrigemPagamento String A (50) Sim Origem do Pagamento = “Site Cliente” , “DAYPAG -
Pagamento por Arquivo com Layout TXT”,
“DAYPAG - Pagamento por Arquivo com Layout
XML”, “DAYPAG - Arquivo Pagamento Planilha”,
“Web Service Pagamentos” ou “Web Api”
7. Consultar Débitos
7.1. Envio
8. Pagamento de Débitos
8.1. Envio
8.2. Retorno
9. Impressão de Recibo
9.1. Envio
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ParametroRecibo Parâmetro de entrada
CodRecibo Numérico N (12) Sim Código do Recibo de Pagamento
9.2. Retorno
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ReciboImpressoR
Parâmetro de retorno
esultDto
CodRecibo Numérico N (12) Sim Código do Recibo de Pagamento
Pdf Array Bytes[] pdf Sim Array de Bytes com o Pdf do recibo
10.1. Envio
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ParametroSaldoDisponi
Parâmetro de entrada
vel
String Sim Token de Identificação da Conta Corrente
TokenCliente A (50)
do Cliente
10.2. Retorno
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
SaldoDisponivelD
Parâmetro de retorno
to
Valor Numérico N (12) Sim Valor do Saldo da Conta Corrente
11.1. Envio
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ParametroLimiteDispon
Parâmetro de entrada
ivel
String Sim Token de Identificação da Conta Corrente
TokenCliente A (50)
do Cliente
11.2. Retorno
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
LimiteDisponivelDto Parâmetro de retorno
Valor Numérico N (12) Sim Valor do Limite de Giro da Conta Corrente
12.1. Envio
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ParametroEmissaoTitulo Parâmetro de entrada
Valor Numérico N (12) Sim Valor do Título
DataVencimento Date Time D (10) Sim Data do Vencimento - AAAA-MM-DD
TipoNomeSacador String A (01) Sim Tipo do Nome do Sacador (Beneficiário)
NomePagador String A (60) Sim Nome do Pagador (Sacado)
DocumentoPagador String A (14) Sim CPF ou CNPJ do Pagador (Sacado)
A (01) Sim Tipo de pessoa do Pagador (Física “F” ou
TipoPessoaPagador String
Jurídica “J”)
EnderecoPagador String A (60) Sim Endereço do Pagador (Sacado)
BairroPagador String A (20) Não Bairro do Pagador (Sacado)
CidadePagador String A (40) Sim Cidade do Pagador (Sacado)
UfPagador String A (2) Sim Uf do Pagador (Sacado)
CepPagador String N (8) Sim CEP do Pagador (Sacado)
DddPagador String N (2) Não DDD do telefone do Pagador (Sacado)
TelefonePagador String N (9) Não Telefone do Pagador (Sacado)
EmailPagador String A (50) Não E-mail do Pagador (Sacado)
Instrucao1 String A (60) Não Instruções ao pagador 1
Instrucao2 String A (60) Não Instruções ao pagador 2
Instrucao3 String A (60) Não Instruções ao pagador 3
Instrucao4 String A (60) Não Instruções ao pagador 4
12.2. Retorno
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
Titulo EmitirTituloResultDto Parâmetro de retorno
NossoNumero Numérico N (11) Sim Nosso Número
LinhaDigitavel String A (54) Sim Linha Digitável
CodBarras Numérico A (44) Sim Código de Barras
Valor Numérico N (12) Sim Valor do Título
DataVencimento Date Time D (10) Sim Data do Vencimento - AAAA-MM-DD
Pdf Array Bytes[] Pdf Sim Array de Bytes com o Pdf do Título
Sim Informação sobre o retorno de emissão do
Retorno Objeto
título de cobrança
A (2) Sim Sendo: 0-Sucesso ou 9 - Falha (Nestes
TipoRetorno String casos o parâmetro Mensagem será
preenchida com o erro)
A (100) Não Mensagem será preenchida com o erro no
Mensagem String
caso de 9-Falha
13.1. Envio
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ParametroReimpressaoTitulo Parâmetro de entrada
Token de Identificação da Conta Corrente
TokenCliente String A (50) Sim
do Cliente
NossoNumero Numérico N (11) Sim Nosso Número
13.2. Retorno
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
Titulo EmitirTituloResultDto Parâmetro de retorno
NossoNumero Numérico N (11) Sim Nosso Número
LinhaDigitavel String A (54) Sim Linha Digitável
CodBarras Numérico A (44) Sim Código de Barras
Valor Numérico N (12) Sim Valor do Título
DataVencimento Date Time D (10) Sim Data do Vencimento - AAAA-MM-DD
Pdf Array Bytes[] Pdf Sim Array de Bytes com o Pdf do Título
Sim Informação sobre o retorno de emissão do
Retorno Objeto
título de cobrança
A(2) Sim Sendo: 0-Sucesso ou 9 - Falha (Nestes
TipoRetorno String casos o parâmetro Mensagem será
preenchida com o erro)
A(100) Não Mensagem será preenchida com o erro no
Mensagem String
caso de 9-Falha
14.1. Envio
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ParametroConsultaTitulo Parâmetro de entrada
NossoNumero Numérico N (11) Não Nosso Número
Valor Numérico N (12) Não Valor do Título
Date Time Não Data Inicial do Vencimento - AAAA-
DataVencimentoDe D (10)
MM-DD
DateTime Não Data final do Vencimento - AAAA-MM-
DataVencimentoAte D (10)
DD
DateTime Não Data/Hora Inicial da Gravação -
DataHoraGravacaoDe D (19)
AAAA-MM-DD HH:MM:SS
DateTime Não Data/Hora Final da Gravação - AAAA-
DataHoraGravacaoAte D (19)
MM-DD HH:MM:SS
14.2. Retorno
15.1. Envio
PROPRIEDADE TIPO FORMATO OBRIG. DESCRIÇÃO
ParametroConsultaPagamento Parâmetro de entrada
Renavam Numérico N (11) Não Número do Renavam
Placa String A (7) Não Placa
Documento String A (14) Não CPF ou CNPJ
DateTime Não Data da Autenticação do Pagamento
DataAutenticacao D (10)
- AAAA-MM-DD
DataPagamento DateTime D (10) Não Data do Pagamento - AAAA-MM-DD
Exemplos JSON:
1 - Envio Consulta:
{
"TokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "D",
"ListaParametroDebitoVeiculo":[
{
"Renavam":"00000000027",
"CodServico":"7",
"TipoConsulta":"S"
},
{
"Renavam":"00995132550",
"CodServico":"2",
"TipoConsulta":"D"
},
{
"Renavam":"10735022515",
"CodServico":"11",
"TipoConsulta":"D"
}
]
}
2 - Retorno Consulta:
" ListaDebitos":[
{
"Renavam":"00000000027",
"CodServico":"7",
"TipoConsulta":"D",
"DataMovimento":"2018-05-01",
"DataHoraConsulta":"2018-05-01 10:22:45",
"Retorno":{
"TipoRetorno":"9",
"Descricao":"RENAVAM INEXISTENTE"
},
"Ocorrencia":{
"CodOcorrencia":"03",
"Descricao":"RENAVAM INEXISTENTE"
}
}
]
}
{
"ListaDebitos":[
{
"Renavam":"00000000027",
"Placa":"JDP0729",
"Documento":"61198164000160",
"CodServico":"7",
"Nome":"NOME TESTE",
"TipoConsulta":"S",
"DataMovimento":"2018-05-01",
"DataHoraConsulta":"2018-05-01 10:22:45",
"Retorno":{
"TipoRetorno":"0"
},
"Ocorrencia":{
"CodOcorrencia":"00",
"Descricao":"TRANSAÇÃO CONFIRMADA E APROVADA"
},
"ValorTotal":"1500.00",
"ValorIpvas":"500.00",
"ValorMultas":"1000.00
}
]
}
{
"DebitoResultDto":[
{
"Renavam":"00995132550",
"Placa":"BVH7116",
"Documento":"00025124192828",
"Nome":"NOME TESTE",
"CodServico":"3",
"TipoConsulta":"D",
"DataMovimento":"2018-05-01",
"DataHoraConsulta":"2018-05-01 08:26:35",
"Ocorrencia":{
"CodOcorrencia":"00",
"Descricao":"TRANSAÇÃO CONFIRMADA E APROVADA"
},
"ValorTotal":"993.70",
"Correio":{
"Valor":"11.00",
"TipoCorreio":"3"
},
"ValorTaxas":"193.70",
"ValorIpvas":"300.00",
"ValorDpvats":"200.00",
"ValorMultas":"300.00",
"Taxas":[
{
"Valor":"193.70",
"Descricao":"LICENCIAMENTO + TRANSFERÊNCIA",
"Ano":"2017"
}
],
"Ipvas":[
{
"Valor":"100.00",
"Exercicio":"2017",
"CotaIpva":"8"
},
{
"Valor":"200.00",
"Exercicio":"2016",
"CotaIpva":"8"
}
],
"Dpvats":[
{
"Valor":"200.00",
"Exercicio":"2017",
"CotaDpvat":"9",
"CategoriaDpvat":"9",
"TipoVeiculo":"2"
}
],
"Multas":[
{
"Aiip":"5A2538336",
"Guia":"026467847",
"CodSegmento":"1",
"CodEmpresaOrgao":"0271070",
"DataInfracao":"2018-02-01",
"Municipio":{
"CodFederal":"7107",
"CodEstadual":"1004",
"Nome":"SÃO PAULO"
},
"Enquadramento":{
"CodEnquadramento":"06211",
}
]
]
}
3 - Envio Pagamento:
3.1 Exemplo Json para pagamento dos serviços 001, 002, 003, 004, 005 e 007 (TABELA I):
{
"TokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "C",
"PagamentoDuplicado": "N",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"3",
"ValorTotal":"421.82",
"Renavam":"00995132550"
},
{
"CodServico":"7",
"ValorTotal":"345.56",
"Renavam":"00991913027"
},
{
"CodServico":"1",
"ValorTotal":"149.15",
"Renavam":"00991912284"
},
{
"CodServico":"2",
"ValorTotal":"65.86",
"Renavam":"00991912233"
},
{
"CodServico":"5",
"ValorTotal":"149.15",
"Renavam":"00991912411"
}
]
}
Onde estamos efetuando os seguintes pagamentos:
1 - pagamento do serviço 003-Lic+Transf para o RENAVAM 00995132550 onde o valor total dos
débitos ref. ao serviço é de R$ 421,82 (um DPVAT 2012 no valor de R$ 101,16, um DPVAT no valor
de R$ 105,65 e mais a Taxa de Lic+Transf. no valor de R$ 215,01);
2 - pagamento do serviço 007-Débitos Pendentes para o RENAVAM 00991913027 onde o valor total
dos débitos ref. ao serviço é de R$ 345,56 (um IPVA 2013 no valor de R$ 345,56);
3 - pagamento do serviço 001-Transferência para o RENAVAM 00991912284 onde o valor total dos
débitos ref. ao serviço é de R$ 149,15 (custo da taxa para transferência no valor de R$ 149,15);
4 - pagamento do serviço 002-Licenciamento para o RENAVAM 00991912233 onde o valor total dos
débitos ref. ao serviço é de R$ 65,86 (custo da taxa para Licenciamento no valor de R$ 65,86)
5 - pagamento do serviço 005- Segunda Via de Transferência para o RENAVAM 00991912411 onde
o valor total dos débitos ref. ao serviço é de R$ 149,15 (custo da taxa para segunda via de
transferência no valor de R$ 149,15);
{
"tokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "C",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"6",
"ValorTotal":"215,01",
"Placa":"XXX9999",
"Documento":"00123456789101",
"Nome":"PAGAMENTO EXEMPLO",
"CodFederal":"7107"
},
{
"CodServico":"6",
"ValorTotal":"215,01",
"Renavam":"00995132550",
"Placa":"XXX9999",
"Documento":"00123456789101",
"Nome":"PAGAMENTO EXEMPLO",
"CodFederal":"7107"
}
]
}
{
"tokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "D",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"8",
"CodSubServico":"1",
"ValorTotal":"136.61",
"Renavam":"00991900677",
"Ipvas":[
{
"Valor":"136.61",
"Exercicio":"2013",
"CotaIpva":"8"
}
]
},
{
"CodServico":"8",
"CodSubServico":"1",
"ValorTotal":"300.18",
"Renavam":"00991912497",
"Ipvas":[
{
"Valor":"84.35",
"Exercicio":"2013",
" CotaIpva":"8"
},
{
"Valor":"98.14",
"Exercicio":"2012",
" CotaIpva":"8"
},
{
"Valor":"117.69",
"Exercicio":"2011",
" CotaIpva":"8"
}
]
},
{
"CodServico":"8",
"CodSubServico":"2",
"ValorTotal":"266.66",
"Placa":"XXX8888",
"Documento":"00012345678901",
"Nome":"EXEMPLO PAGAMENTO",
"CodFederal":"7107"
"IpvaAtual":{
"Endereco":"RUA EXEMPLO, 123",
"CEP":"04313002",
"MarcaModelo":"HONDA/CG 125 FAN ES",
"PlacaAnterior":"NOT-FIS",
"Placa":"XXX8888",
"Chassi":"9C2JC4830DR05504",
"Combustivel":"GASOLINA",
"EspecieTipo":"PASSAGEIRO/MOTOCICLO",
"Procedencia":"N",
"AnoFabricacao":"2013",
"CotaIpva":"8",
"DataVencimento":"2013-04-09",
"DataCompra":"2013-03-10",
"Faixa":"0028430",
"Exercicio":"2013",
"ValorNota":"8000.00",
"ValorJuros":"0.00",
"ValorMulta":"0.00",
"ValorMultaInfracao":"0.00",
"Valor":"266.66"
}
},
{
"CodServico":"8",
"CodSubServico":"2",
"ValorTotal":"381.80",
"Placa":"XXX7777",
"Documento":"00012345678902",
"Nome":"EXEMPLO PAGAMENTO",
"CodFederal":"7107"
"IpvaAtual":{
"Endereco":"RUA EXEMPLO, 123",
"CEP":"04313002",
"MarcaModelo":"HONDA/CG 125 FAN ES",
"PlacaAnterior":"NOT-FIS",
"Placa":"XXX7777",
"Chassi":" 9C2JC4830DR055045",
"Combustivel":"GASOLINA",
"EspecieTipo":"PASSAGEIRO/MOTOCICLO",
"Procedencia":"N",
"AnoFabricacao":"2013",
"CotaIpva":"8",
"DataVencimento":"2013-01-31",
"DataCompra":"2013-01-01",
"Faixa":"0028430",
"Exercicio":"2013",
"ValorNota":"8000.00",
"ValorJuros":"11.12",
"ValorMulta":"50.68",
"ValorMultaInfracao":"0.00",
"Valor":"381.80"
}
}
]
}
3 - Pagamento do serviço 008-IPVA de carro Zero Km (Subserviço=002) para a placa XXX7777 fora
do vencimento onde o valor total dos débitos referentes ao serviço é R$ 381,80
IPVA P. REGISTRO com as informações:
PLACA = “XXX7777”
DOCUMENTO = “00012345678902”
NOME = “EXEMPLO PAGAMENTO”
COD. MUNICIPIO FEDERAL = “7107” (SÃO PAULO/SP)
ENDEREÇO = “RUA EXEMPLO, 123”
CEP = “04313002”
MARCA/MODELO = “HONDA/CG 125 FAN ES”
PLACA ANTERIOR = “NOT-FIS” (NOTA-FISCAL)
PLACA ATUAL = “XXX7777”
CHASSIS = “9C2JC4830DR055045”
COMBUSTÍVEL = “GASOLINA”
ESPÉCIE/TIPO = “PASSAGEIRO/MOTOCICLO”
PROCEDÊNCIA = “N” (NACIONAL)
ANO FABRICAÇÃO = “2013”
COTAIPVA = “8” (COTA ÚNICA)
DATA DE VENCIMENTO = “2013-01-31” (VENCIMENTO PARA A COTA PAGA)
DATA DA COMPRA = “2013-01-01”
FAIXA IPVA = “0028430” (HONDA/CG 125 FAN ES)
EXERCÍCIO = “2013”
VALOR DA NOTA FISCAL = “8000,00”
VALOR BASE = “320,00”
VALOR DOS JUROS = “11,12” (IPVA VENCIDO)
VALOR DA MULTA = “50,68” (IPVA VENCIDO)
VALOR DA MULTA POR INFRAÇÃO = “0,00”
VALOR TOTAL DO IPVA = “381,80” (VALOR BASE + VALOR DOS JUROS + VALOR DA MULTA +
VALOR DA MULTA POR INFRAÇÃO)
3.4 Exemplo Json para pagamento do serviço 009 (TABELA I): Vide observação 6.5 na página 4
{
"tokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "D",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"9",
"CodSubServico":"1",
"ValorTotal":"571.28",
"Renavam":"00991900677",
"Dpvats":[
{
"Valor":"571.28",
"Exercicio":"2013",
"CotaDpvat":"9"
},
{
"Valor":"279.27",
"Exercicio":"2012",
"CotaDpvat":"9"
}
]
},
{
"CodServico":"9",
"CodSubServico":"2",
"ValorTotal":"292.01",
"Placa":"XXX8888",
"Documento":"00012345678901",
"Nome":"EXEMPLO PAGAMENTO",
"CodFederal":"7107",
"DpvatAtual":{
"Exercicio":"2013",
"CotaDpvat":"9",
"CategoriaDpvat":"9",
"TipoVeiculo":"2",
"Chassi":"9C2JC4830DR055045",
"DataInicioVigencia":"2013-03-20",
"DataFimVigencia":"2013-12-31",
"ValorIof":"1.11",
"ValorBilhete":"4.15",
"Valor":"292.01"
}
}
]
}
{
"tokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "C",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"10",
"ValorTotal":"659.73",
"Renavam":"00991912497",
"Multas":[
{
"Aiip":"3J4976211",
"Guia":"108468811",
"Valor":"574.61”
},
{
"Aiip":"5B0067540",
"Guia":"125222233",
"Valor":"85.12”
}
]
},
{
"CodServico":"10",
"ValorTotal":"53.20",
"Renavam":"00991912268",
"Multas":[
{
"Aiip":"5Y2895621",
"Guia":"359406294",
"Valor":"53.20”
}
]
}
]
}
1 - Pagamento do serviço 010-MULTAS para o RENAVAM 00991912497 onde o valor total dos débi-
tos referentes ao serviço é R$ 659,73 (uma multa no valor de R$ 574,61 e outra multa no valor de R$
85,12);
2 - Pagamento do serviço 010-MULTAS para o RENAVAM 00991912268 onde o valor total dos débi-
tos referentes ao serviço é R$ 53,20 (uma multa no valor de R$ 53,20);
{
"tokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "D",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"11",
"ValorTotal":"85.13",
"Renavam":"00304509051",
"MultasRenainf":[
{
"Aiip":"R234266837",
"Guia":"1049085383",
"Valor":"85.13 "
}
]
},
{
"CodServico":"11",
"ValorTotal":"170.24",
"Renavam":"00884221644",
"MultasRenainf":[
{
"Aiip":"E003672100",
"Guia":"1008208449",
"Valor":"85.12"
},
{
"Aiip":"E003641591",
"Guia":"1008208103",
"Valor":"85.12"
}
]
}
]
}
1 - Pagamento do serviço 011-MULTAS RENAINF para o RENAVAM 00304509051 onde o valor total
dos débitos referentes ao serviço é R$ 85,13 (uma multa no valor de R$ 85,13);
2 - Pagamento do serviço 011-MULTAS RENAINF para o RENAVAM 00884221644 onde o valor total
dos débitos referentes ao serviço é R$ 170,24 (duas multas no valor de R$ 85,12 cada);
{
"tokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"FormaPagamento": "C",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"12",
"CodSubServico":"18",
"ValorTotal":"42.96",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107"
},
{
"CodServico":"12",
"CodSubServico":"19",
"ValorTotal":"42.96",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"21",
"ValorTotal":"53.27",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"23",
"ValorTotal":"63.92",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"24",
"ValorTotal":"74.57",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"25",
"ValorTotal":"42.92",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"26",
"ValorTotal":"106.88",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"28",
"ValorTotal":"224.07",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"31",
"ValorTotal":"100.84",
"Placa":"XXX8888",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"32",
"ValorTotal":"155.60",
"Placa":"XXX8888",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"33",
"ValorTotal":"100.84",
"Renavam":"00991895754",
"Placa":"XXX8888",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"34",
"ValorTotal":"155.60",
"Renavam":"00991895754",
"Placa":"XXX8888",
"Documento":"00010823498977",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
},
{
"CodServico":"12",
"CodSubServico":"82",
"ValorTotal":"625.54",
"Documento":"62232889000190",
"Nome":"NOME EXEMPLO",
"CodFederal":"7107
"TaxaAtual":{
"Endereco":"RUA COSTA E SILVA, 33",
"CEP":"04313001",
"Telefone":"1131385000",
"ValorJuros":"0.00",
"ValorMulta":"27.38",
"ValorTotal":"625.54",
"DataVencimento":"2013-01-15",
"Observacao":"RENOVAÇÃO ALVARÁ 2013"
}
}
]
}
2 - Pagamento do serviço 012-TAXA DETRAN (GARE Tabela C) de Emissão de 2ª via da CNH via
correio (Subserviço=019) para o CPF 00010823498977 onde o valor total dos débitos referentes ao
serviço é R$ 42,96 (Valor da Taxa de R$ 31,96 da Emissão de 2ª via da CNH mais o valor da taxa de
envio pelo correio no valor de R$ 11,00);
4 - Pagamento do serviço 012-TAXA DETRAN (GARE Tabela C) de Exame de aptidão física e mental
(Subserviço=023) para o CPF 00010823498977 onde o valor total dos débitos referentes ao serviço é
R$ 63,92;
11 - Pagamento do serviço 012-TAXA DETRAN (GARE Tabela C) de Par de Placas com Tarjetas –
Veículo Cadastrado em SP (Subserviço=033) para RENAVAM 00991895754, CPF 00010823498977,
e placa XXX8888, onde o valor total dos débitos referentes ao serviço é R$ 100,84;
12 - pagamento do serviço 012-TAXA DETRAN (GARE Tabela C) de Par de Placas com Tarjetas –
Veículo Cadastrado em SP – (domiciliar - Subserviço=034) para o RENAVAM 00991895754, CPF
00010823498977, e placa XXX8888 onde o valor total dos débitos referentes ao serviço é R$ 155,60;
4 - Retorno Pagamento:
{
"tokenCliente": "Bu18uY840TUu6LyaoaVK6w==",
"ListaParametroPagamentoVeiculo":[
{
"CodServico":"2",
"Renavam":"00000000027",
"DataMovimento":"2018-05-01",
"DataHora":"2018-05-01 10:22:45",
"Ocorrencia":{
"CodOcorrencia":"03",
"Descricao": RENAVAM INEXISTENTE"
},
}
]
}
{
"ListaDebitos":[
{
"CodServico":"2",
"ValorTotal":"1000",
"Renavam":"00000000027",
"DataMovimento":"2018-05-01",
"DataHora":"2018-05-01 10:22:45",
"Ocorrencia":{
"CodOcorrencia":"00",
"Descricao":" TRANSAÇÃO CONFIRMADA E APROVADA "
},
"CodRecibo":"29398710",
"NsuBanco":"19796707",
"NsuProdesp":"300000341"
},
{
"CodServico":"12",
"CodSubServico":"82",
"ValorTotal":"667.00",
"Documento":"00010823498977",
"DataMovimento":"2018-05-01",
"DataHora":"2018-05-01 11:22:45",
"Ocorrencia":{
"CodOcorrencia":"00",
"Descricao":" TRANSAÇÃO CONFIRMADA E APROVADA "
},
"CodRecibo":"29398711",
"NsuBanco":"19796710",
"NsuProdesp":"300000381"
}
]
}
Tabelas:
TABELA V – OCORRÊNCIAS:
CODOCORRENCIA DESCRIÇÃO
NENHUM RETORNO DA PRODESP - TENTE NOVAMENTE
00 TRANSAÇÃO CONFIRMADA E APROVADA
01 SERVIÇO NÃO DISPONÍVEL - CONTATAR CALL CENTER
02 RENAVAM INVÁLIDO
03 RENAVAM INEXISTENTE
04 RENAVAN NÃO CONSTA DÉBITO
05 FORA DE OPERAÇÃO-CONTATAR CALL CENTER
06 RESTRIÇÃO DE PAGAMENTO-CONSULTAR DETRAN
07 SERVIÇO NÃO DISPONÍVEL-CONTATAR CALL CENTER
09 CÓDIGO DA MENSAGEM INVÁLIDO-CONTATAR CALL CENTER
10 OCORRÊNCIA 10-INFORMAR CALL CENTER
11 OCORRÊNCIA 11-INFORMAR CALL CENTER
12 OCORRÊNCIA 12-INFORMAR CALL CENTER
13 OCORRÊNCIA 13-INFORMAR CALL CENTER
14 OCORRÊNCIA 14-INFORMAR CALL CENTER
15 OCORRÊNCIA 15-INFORMAR CALL CENTER
16 OCORRÊNCIA 16-INFORMAR CALL CENTER
17 OCORRÊNCIA 17-INFORMAR CALL CENTER
18 OCORRÊNCIA 18-INFORMAR CALL CENTER
19 OCORRÊNCIA 19-INFORMAR CALL CENTER
Histórico de Versão
Histórico das alterações no documento da WEB API.
Data Versão Descrição Autor
01/06/2018 1.0.0 Elaboração da documentação Daniel Bratficher
08/06/2018 1.0.1 Propriedade “Restricao” descontinuada Daniel Bratficher
29/06/2018 1.0.2 Alteração no layout JSON Daniel Bratficher
07/12/2018 1.0.3 Alteração campos obrigatórios sub-serviço 18 André Santos da Costa
02/01/2019 1.0.4 Inclusão tabela V - OCORRÊNCIAS; Item 3.1: André Santos da Costa
propriedade “DpvatAtual.Identificacao” renomeada
para “DpvatAtual.TipoVeiculo”, propriedade
“Dpvats.Identificacao” renomeada para
“Dpvats.TipoVeiculo”; Item 3.2: propriedade
“ListaDebitos.DataMovimento” descrição alterada de
"DD/MM/AAAA" para "AAAA-MM-DD", propriedade
“ListaDebitos.DataHoraConsulta” descrição alterada
de "DD/MM/AAAA HH:MM:SS" para "AAAA-MM-DD
HH:MM:SS"; Item 3.3: propriedade
“ListaDebitos.DpvatAtual.Categoria” renomeada para
“ListaDebitos.DpvatAtual.CategoriaDpvat”,
propriedade “ListaDebitos.Dpvats.Categoria”
renomeada para
“ListaDebitos.Dpvats.CategoriaDpvat”, propriedade
“ListaDebitos.DataMovimento” descrição alterada de
"DD/MM/AAAA" para "AAAA-MM-DD", propriedade
“ListaDebitos.DataHoraConsulta” descrição alterada
de "DD/MM/AAAA HH:MM:SS" para "AAAA-MM-DD
HH:MM:SS", propriedade
“ListaDebitos.IpvaAtual.DataVencComDesc” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.IpvaAtual.DataVencSemDesc” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.IpvaAtual.DataVencParcela1” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.IpvaAtual.DataVencParcela2” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.IpvaAtual.DataVencParcela3” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.IpvaAtual.DataVencParcela4” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.IpvaAtual.DataVencParcela5” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.IpvaAtual.DataVencParcela6” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.DpvatAtual.DataVencimento” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.DpvatAtual.DataVencParcela1”
descrição alterada de "DD/MM/AAAA" para "AAAA-
MM-DD", propriedade
“ListaDebitos.DpvatAtual.DataVencParcela2”
descrição alterada de "DD/MM/AAAA" para "AAAA-
MM-DD", propriedade
“ListaDebitos.DpvatAtual.DataVencParcela3”
descrição alterada de "DD/MM/AAAA" para "AAAA-
MM-DD", propriedade
“ListaDebitos.DpvatAtual.DataVencParcela4”
descrição alterada de "DD/MM/AAAA" para "AAAA-
MM-DD", propriedade
“ListaDebitos.DpvatAtual.DataVencParcela5”
descrição alterada de "DD/MM/AAAA" para "AAAA-
MM-DD", propriedade
“ListaDebitos.DpvatAtual.DataVencParcela6”
descrição alterada de "DD/MM/AAAA" para "AAAA-
MM-DD", propriedade
“ListaDebitos.Multas.DataInfracao” descrição alterada
de "DD/MM/AAAA" para "AAAA-MM-DD", propriedade
“ListaDebitos.Multas.DataVencimento” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.MultasRenainf.DataInfracao” descrição
alterada de "DD/MM/AAAA" para "AAAA-MM-DD",
propriedade
“ListaDebitos.MultasRenainf.DataVencimento”
descrição alterada de "DD/MM/AAAA" para "AAAA-
MM-DD"; Item 4.1: propriedade
“listaParametroPagamentoVeiculo.IpvaAtual.Cota”
renomeada para
“listaParametroPagamentoVeiculo.IpvaAtual.CotaIpva”
, propriedade
“listaParametroPagamentoVeiculo.IpvaAtual.PlacaAtu
al” renomeada para
“listaParametroPagamentoVeiculo.IpvaAtual.Placa”,
propriedade
“listaParametroPagamentoVeiculo.IpvaAtual.ValorTota
l” renomeada para
“listaParametroPagamentoVeiculo.IpvaAtual.Valor”,
propriedade
“listaParametroPagamentoVeiculo.Ipvas.Cota”
renomeada para
“listaParametroPagamentoVeiculo.Ipvas.CotaIpva”,
propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.Cota”
renomeada para
“listaParametroPagamentoVeiculo.DpvatAtual.CotaDp
vat”, propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.Categor
ia” renomeada para
“listaParametroPagamentoVeiculo.DpvatAtual.Categor
iaDpvat”, propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.ValorTo
tal” renomeada para
“listaParametroPagamentoVeiculo.DpvatAtual.Valor”,
propriedade
“listaParametroPagamentoVeiculo.Dpvats.Cota”
renomeada para
“listaParametroPagamentoVeiculo.Dpvats.CotaDpvat”,
propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.Identific
acao” renomeada para
“listaParametroPagamentoVeiculo.DpvatAtual.TipoVei
culo”, propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.InicioVi
gencia” renomeada para
“listaParametroPagamentoVeiculo.DpvatAtual.DataInic
ioVigencia”, propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.FimVige
ncia” renomeada para
“listaParametroPagamentoVeiculo.DpvatAtual.DataFi
mVigencia”, propriedade
“listaParametroPagamentoVeiculo.Gares” renomeada
para “listaParametroPagamentoVeiculo.TaxaAtual”,
propriedade
“listaParametroPagamentoVeiculo.IpvaAtual.ValorBas
e” removida, propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.ValorBa
se” removida, propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.ValorBil
hete” removida, propriedade
“listaParametroPagamentoVeiculo.IpvaAtual.DataVenc
imento” descrição alterada de "DD/MM/AAAA" para
"AAAA-MM-DD", propriedade
“listaParametroPagamentoVeiculo.IpvaAtual.DataCom
pra” descrição alterada de "DD/MM/AAAA" para
"AAAA-MM-DD", propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.DataInic
ioVigencia” descrição alterada de "DD/MM/AAAA"
para "AAAA-MM-DD", propriedade
“listaParametroPagamentoVeiculo.DpvatAtual.DataFi
mVigencia” descrição alterada de "DD/MM/AAAA"
para "AAAA-MM-DD", propriedade
“listaParametroPagamentoVeiculo.TaxaAtual.DataVen
cimento” descrição alterada de "DD/MM/AAAA" para
"AAAA-MM-DD".
18/01/2019 1.0.5 Alteração URL acesso ambiente Produção; Inclusão André Santos da Costa
do método de consulta do saldo disponível.
01/03/2019 1.0.6 Alteração tabela TABELA I – CÓDIGO DOS André Santos da Costa
SERVIÇOS, descrição coluna CodServico; Alteração
tabela TABELA II – CÓDIGOS DOS SUB-SERVIÇOS,
descrição coluna CodServico, descrição coluna
CodSubServico;
31/07/2019 1.0.7 Item 3.3: propriedade André Santos da Costa
"ListaDebitos.IpvaAtual.DataVencComDesc"
renomeada para "DataVencimentoComDesconto",
propriedade "ListaDebitos.IpvaAtual.ValorComDesc"
renomeada para "ValorComDesconto", propriedade
"ListaDebitos.IpvaAtual.DataVencSemDesc"
renomeada para "DataVencimentoSemDesconto",
propriedade "ListaDebitos.IpvaAtual.ValorSemDesc"
renomeada para "ValorSemDesconto", propriedade
"ListaDebitos.IpvaAtual.DataVencParcela1"
renomeada para "DataVencimentoParcela1",
propriedade
"ListaDebitos.IpvaAtual.DataVencParcela2"
renomeada para "DataVencimentoParcela2",
propriedade
"ListaDebitos.IpvaAtual.DataVencParcela3"
renomeada para "DataVencimentoParcela3",
propriedade
"ListaDebitos.IpvaAtual.DataVencParcela4"
renomeada para "DataVencimentoParcela4",
propriedade
"ListaDebitos.IpvaAtual.DataVencParcela5"
renomeada para "DataVencimentoParcela5",
propriedade
"ListaDebitos.IpvaAtual.DataVencParcela6"
renomeada para "DataVencimentoParcela6",
propriedade
"ListaDebitos.DpvatAtual.DataVencParcela1"
renomeada para "DataVencimentoParcela1",
propriedade
"ListaDebitos.DpvatAtual.DataVencParcela2"
renomeada para "DataVencimentoParcela2",
propriedade
"ListaDebitos.DpvatAtual.DataVencParcela3"
renomeada para "DataVencimentoParcela3",
propriedade
"ListaDebitos.DpvatAtual.DataVencParcela4"
renomeada para "DataVencimentoParcela4",
propriedade
"ListaDebitos.DpvatAtual.DataVencParcela5"
renomeada para "DataVencimentoParcela5",
propriedade
"ListaDebitos.DpvatAtual.DataVencParcela6"
renomeada para "DataVencimentoParcela6"
15/10/2019 1.0.8 Endereço de acesso ambiente de homologação Evandro Medeiros
alterado de: http://172.23.64.62:8901/swagger/ Novais
para: http://187.9.76.122:8901/swagger/
Produção de: http://172.23.64.61:8090/
para: http://172.23.64.82:8090
14/11/2019 1.0.9 Inclusão do método Consulta Débitos v2; Inclusão do André Santos da Costa
método Consulta Limite Disponível;
Item 2: Adicionada forma de pagamento troca de
cheques; Item 3: Adicionado indicador de pagamento
duplicado
22/11/2019 1.0.10 Inclusão do método Emitir Título; Inclusão do método André Santos da Costa
Reimprimir Título; Inclusão do método Consultar
Título; Inclusão do método Consultar Pagamento
13/01/2020 1.0.11 Inserido /Debito/ nos métodos de débito veicular; Evandro Medeiros
Inserido /Titulo/ nos endereços de títulos; Novais
Inserido /Pagamento/ no método de consulta de
pagamentos.
05/03/2020 1.0.12 Alteração na obrigatoriedade dos campos Evandro Medeiros
"EnderecoPagador", "CidadePagador", "UfPagador" Novais
do método “EmitirTitulo” (item 13.1).
16/04/2020 1.0.13 Substituído a propriedade “FlagCorreio” por Evandro Medeiros
“TipoCorreio”. Novais
08/05/2020 1.0.14 Retirado o serviço 62 – Cópia de CRLV da somatória Evandro Medeiros
do valor das taxas. Novais
Retirado os serviços 61 Cópia de CRLV e 62 – Cópia
de CRLV via Correio da Tabela II
Retirado o serviço 04 2ª via de Licenciamento da
Tabela I
Retirado o campo “LocalEntrega” para o serviço 2-
Licenciamento
Retirado os exemplos de pagamento dos serviços 2, 4
61 e 62.
17/07/2020 1.0.15 Alteração de opcional para obrigatório do campo Evandro Medeiros
“Nome (Contribuinte)”, na tabela II CodServiço 12, Novais
Cod Subserviços: 35, 36, 37, 39, 40, 43, 44, 45, 46,
47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 60, 66,
67, 73, 82, 84.