Campo
|
Elem.
|
Pai
|
Tipo
|
Ocor.
|
Tam.
|
Dec.
|
Observação
|
retornoOperacaoPagamento
|
Raiz
|
|
|
1
|
|
|
|
mensagens
|
Raiz
|
retornoOperacaoPagamento
|
|
0-1
|
|
|
Dados das mensagens
|
mensagem
|
Raiz
|
mensagens
|
|
1-N
|
|
|
Dados da mensagem de retorno.
|
categoria
|
E
|
mensagem
|
N
|
1
|
3
|
|
Categoria da mensagem.
|
codigo
|
E
|
mensagem
|
N
|
1
|
1-3
|
|
Código de mensagem de retorno.
|
mensagem
|
E
|
mensagem
|
S
|
1
|
1-2000
|
|
Descrição da mensagem.
|
observacao
|
E
|
mensagem
|
S
|
0-1
|
1-2000
|
|
Observação sobre a mensagem.
Neste campo poderão ser apresentadas informações mais técnicas sobre o que ocorreu no processo.
|
pagamento
|
Raiz
|
retornoOperacaoPagamento
|
|
0-1
|
|
|
Informações sobre o pagamento
|
impAuto
|
A
|
pagamento
|
N
|
0-1
|
1
|
|
Indica se ocorrerá impressão automática.
1 = Sim
2 = Não
Caso não seja informada será tomada por padrão o valor 1.
Este atributo não tem validade para integrações que não utilizam o módulo agente.
|
envioOperacaoPagamento
|
Raiz
|
pagamento
|
|
1
|
|
|
Dados da solicitação de cadastro
|
ID
|
A
|
envioOperacaoPagamento
|
S
|
0-1
|
|
|
GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo.
|
Id
|
A
|
envioOperacaoPagamento
|
S
|
0-1
|
|
|
GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima.
|
token
|
A
|
envioOperacaoPagamento
|
S
|
1
|
24
|
|
O token será usado para determinar quais os níveis de permissionamento podem ser aceitos. Por exemplo: determinar um valor limite de operações de transporte por token.
|
ide
|
Raiz
|
envioOperacaoPagamento
|
|
1
|
|
|
Informações sobre a Operação de Pagamento
|
cnpj
|
E
|
ide
|
N
|
1
|
14
|
|
CNPJ da Contratante.
|
ptEmissor
|
E
|
ide
|
S
|
1
|
1-30
|
|
Nome do ponto de emissão de Operação de Pagamento, dentro da Contratante. Os pontos emissores são configurados no cadastro da Contratante, no portal nddCargo.
|
numero
|
E
|
ide
|
N
|
1
|
1-9
|
|
Número da Operação de Pagamento.
|
serie
|
E
|
ide
|
N
|
1
|
1-4
|
|
Série da Operação de Pagamento.
|
colaborador
|
Raiz
|
envioOperacaoPagamento
|
|
1
|
|
|
Dados do colaborador que receberá o pagamento
|
cpf
|
E
|
colaborador
|
N
|
1
|
11
|
|
CPF do colaborador
|
informacoes
|
Raiz
|
colaborador
|
|
0-1
|
|
|
Dados para cadastro do colaborador
|
nomeCompleto
|
E
|
informacoes
|
S
|
1
|
1-150
|
|
Nome do colaborador.
|
nomeMae
|
E
|
informacoes
|
S
|
1
|
1-150
|
|
Nome da mãe do colaborador.
|
nomePai
|
E
|
informacoes
|
S
|
0-1
|
1-150
|
|
Nome do pai do colaborador.
|
dataNascimento
|
E
|
informacoes
|
S
|
1
|
|
|
Data de nascimento do colaborador.
|
identidade
|
E
|
informacoes
|
S
|
1
|
1-20
|
|
Identidade do colaborador.
|
endereco
|
Raiz
|
informacoes
|
|
1
|
|
|
Dados de endereço do colaborador.
|
UF
|
E
|
endereco
|
S
|
1
|
2
|
|
Sigla UF do colaborador.
|
cidade
|
E
|
endereco
|
S
|
1
|
1-100
|
|
Nome do Município do colaborador.
|
bairro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Bairro do colaborador.
|
logradouro
|
E
|
endereco
|
S
|
1
|
1-255
|
|
Logradouro do colaborador.
|
numero
|
E
|
endereco
|
N
|
0-1
|
1-8
|
|
Número do colaborador.
|
CEP
|
E
|
endereco
|
N
|
0-1
|
8
|
|
CEP do colaborador.
|
complemento
|
E
|
endereco
|
S
|
0-1
|
1-255
|
|
Complemento do endereço
|
telefone
|
E
|
informacoes
|
N
|
1
|
10|11
|
|
Informar o número do celular do colaborador, juntamente com o DDD. Caso não haja um número válido, informar 9999999999 ou 99999999999.
|
cartao
|
Raiz
|
colaborador
|
|
0-1
|
|
|
Dados do cartão vinculado ao colaborador
|
cartaoId
|
E
|
cartao
|
N
|
1
|
1-15
|
|
Identificador do cartão entregue ao colaborador.
|
gestoraCartao
|
E
|
cartao
|
N
|
1
|
3
|
|
Gestora do cartão entregue ao colaborador.
|
rota
|
Raiz
|
envioOperacaoPagamento
|
|
1
|
|
|
Informações da rota
|
rotaERP
|
E
|
rota
|
S
|
1
|
1-30
|
|
Nome da rota no ERP para a integração.
|
informacoes
|
Raiz
|
rota
|
|
0-1
|
|
|
Dados para inserção de uma rota no sistema ou atualização de uma já existente.
|
nome
|
E
|
informacoes
|
S
|
1
|
1-50
|
|
Nome de apresentação da rota dentro do sistema.
|
tipoRotaPadrao
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Define o tipo de rota padrão a ser utilizado nos pontos de parada.
1 = Rápida
2 = Curta
|
pontosParada
|
Raiz
|
informacoes
|
|
1
|
|
|
Dados dos pontos da parada da rota.
|
pontoParada
|
Raiz
|
pontosParada
|
|
2-N
|
|
|
Dados do ponto de parada.
|
codigoIBGE
|
E
|
pontoParada
|
N
|
1
|
7
|
|
Código IBGE do ponto de parada.
Deverá ser informada esta tag ou a tag cep
|
cep
|
E
|
pontoParada
|
N
|
1
|
8
|
|
CEP do ponto de parada.
Deverá ser informada esta tag ou a tag codigoIBGE
|
tipoRotaEspecifico
|
E
|
pontoParada
|
N
|
0-1
|
1
|
|
Tipo de rota específico para o ponto de parada em relação ao ponto anterior.
1 = Rápida
2 = Curta
|
responsaveis
|
Raiz
|
informacoes
|
|
0-1
|
|
|
Dados dos responsáveis pela rota.
|
responsavel
|
Raiz
|
responsaveis
|
|
1-N
|
|
|
Dados do responsável.
|
nome
|
E
|
responsavel
|
S
|
1
|
1-50
|
|
Nome do responsável pela rota na Contratante.
|
email
|
E
|
responsavel
|
S
|
1
|
1-255
|
|
E-mail do responsável pela rota na Contratante. Em caso de alterações na rota, o aviso será encaminhado para este e-mail.
|
utilizarRoteirizador
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Possibilita a utilização do roteirizador para calcular a distância e valores de pedágio.
1 = Sim
2 = Não
|
totalKm
|
E
|
informacoes
|
N
|
0-1
|
1-15
|
2
|
Total de quilômetros da rota.
|
notificarRespContratante
|
E
|
informacoes
|
N
|
0-1
|
1
|
|
Define a notificação para os responsáveis na Contratante, caso o roteirizador identifique alterações na rota.
1 = Sim
2 = Não
|
pagamento
|
Raiz
|
envioOperacaoPagamento
|
|
1
|
|
|
Informações sobre o pagamento
|
gestoraCartao
|
E
|
pagamento
|
N
|
1
|
3
|
|
Gestora do cartão.
|
valor
|
E
|
pagamento
|
N
|
0-1
|
1-15
|
2
|
Valor a ser pago.
|
valorPedagio
|
E
|
pagamento
|
N
|
0-1
|
1-15
|
2
|
Valor de pedágio a ser pago.
|
categoriaPedagio
|
E
|
envioOperacaoPagamento
|
N
|
0-1
|
1-2
|
|
Categoria de pedágio.
Valores possíveis disponíveis nos anexos desse documento.
|
retornoOperacaoPagamento
|
Raiz
|
pagamento
|
|
0-1
|
|
|
Dados do retorno de cadastro.
|
mensagens
|
Raiz
|
retornoOperacaoPagamento
|
|
1
|
|
|
Dados das mensagens .
|
mensagem
|
Raiz
|
mensagens
|
|
1-N
|
|
|
Dados da mensagem de retorno.
|
categoria
|
E
|
mensagem
|
N
|
1
|
3
|
|
Categoria da mensagem.
|
codigo
|
E
|
mensagem
|
N
|
1
|
1-3
|
|
Código de mensagem de retorno.
|
mensagem
|
E
|
mensagem
|
S
|
1
|
1-2000
|
|
Descrição da mensagem.
|
observacao
|
E
|
mensagem
|
S
|
0-1
|
1-2000
|
|
Observação sobre a mensagem.
Neste campo poderão ser apresentadas informações mais técnicas sobre o que ocorreu no processo.
|
autorizacao
|
Raiz
|
retornoOperacaoPagamento
|
|
0-1
|
|
|
Dados referentes à autorização do NDOP
|
ndop
|
Raiz
|
autorizacao
|
|
1
|
|
|
|
numero
|
E
|
ndop
|
N
|
1
|
12
|
|
Número de identificação da Operação de Pagamento.
|
ndopCodVerificador
|
E
|
ndop
|
N
|
1
|
4
|
|
Protocolo de autorização do NDOP.
|
pedagio
|
Raiz
|
retornoOperacaoPagamento
|
|
0-1
|
|
|
Dados referentes ao pedágio da Operação de Pagamento
|
valor
|
E
|
pedagio
|
N
|
1
|
1-15
|
2
|
Valor do pedágio.
|
origem
|
E
|
pedagio
|
S
|
0-1
|
1-200
|
|
Cidade e estado de origem.
|
destino
|
E
|
pedagio
|
S
|
0-1
|
1-200
|
|
Cidade e estado de destino.
|
pracas
|
Raiz
|
pedagio
|
|
0-1
|
|
|
Dados das praças de pedágio.
|
praca
|
Raiz
|
pracas
|
|
1-N
|
|
|
Dados da praça.
|
nome
|
E
|
praca
|
S
|
1
|
1-200
|
|
Nome da praça de pedágio.
|
valor
|
E
|
praca
|
N
|
1
|
1-15
|
2
|
Valor a ser pago no pedágio.
|
localizacao
|
E
|
praca
|
S
|
1
|
1-200
|
|
Localização da praça de pedágio.
|
saldo
|
Raiz
|
retornoOperacaoPagamento
|
|
0-1
|
|
|
Informações sobre o saldo do cartão
|
saldoDisponivel
|
E
|
saldo
|
N
|
1
|
1-15
|
2
|
Saldo disponível no cartão.
|
dataConsulta
|
E
|
saldo
|
D
|
1
|
|
|
Data e hora da consulta do saldo.
|
statusPagamentoValor
|
E
|
autorizacao
|
N
|
0-1
|
1
|
|
Status do pagamento
Valores possíveis:
0=Aberto
1=Pago
2=Cancelado
3=Erro
|
statusPagamentoPedagio
|
E
|
autorizacao
|
N
|
0-1
|
1
|
|
Status do pagamento de pedágio
Valores possíveis:
0=Aberto
1=Pago
2=Cancelado
3=Erro
|