Pular para o conteúdo principal

Comprar - POST

Registra a compra de vale-pedágio, enviando as informações necessárias para processar de forma assíncrona. A operação engloba dados de identificação, transportador, condutor, rota, valor, observações, veículo e informações da tag. Ao receber o lote, o sistema inicia seu processamento e retorna um GUID para acompanhamento posterior.

Método e rota

  • Criação (POST): /valePedagio/comprar/{enterpriseId}

Corpo

Consulte aqui as referências

Exemplo
{
"ide": {
"cnpj": "12345678901234",
"numero": "123456",
"serie": "1",
"ptEmissor": "Ponto Emissor XPTO",
"dataFinal": "2025-02-15",
"tipoPagamento": 1
},
"transp": {
"rntrc": "123456789",
"cpfCnpjTransportador": "12345678901234",
"cadastro": {
"nomeRazao": "Transportadora TAC Exemplo SA",
"tipo": 1,
"dataNascimento": "1980-05-10",
"identidade": "MG1234567"
}
},
"condutor": {
"cpf": "12345678901",
"nomeCompleto": "Condutor Exemplo"
},
"infRota": {
"categoriaPedagio": 2,
"rota": "Rota SP-RJ",
"informacoes": {
"tipo": 1,
"utilizarRoteirizador": true,
"pontosParada": [
{
"CEP": "12345678"
},
{
"codigoIBGE": 1234567
},
{
"latitude": "-25.09492",
"longitude": "-50.16311"
}
]
}
},
"observacao": "Observações gerais sobre a operação de vale-pedágio.",
"veiculo": {
"placa": "ABC1234",
"cadastro": {
"modelo": "VW 19.320",
"RNTRCTransportador": 987654321
}
},
"infTag": {
"codigoFornecedor": 2,
"codigoTagAtivacao": "TAG1234567"
}
}
Layout
Nome do campoTipoObrigatórioObservação
valePedagioobjectSimRaiz do payload "Comprar Vale Pedágio".
└─ ideobjectSimInformações sobre a operação de vale-pedágio.
  └─ cnpjstring(14)SimCNPJ da contratante (14 dígitos).
  └─ numerostringSimNúmero identificador da operação de vale-pedágio.
  └─ seriestringSimSérie para a operação de vale-pedágio.
  └─ ptEmissorstring(30)SimPonto emissor responsável pela operação (1–30).
  └─ dataFinaldate/stringNãoData de término (AAAA-MM-DD). Se não informada, assume +30 dias após a data inicial.
  └─ tipoPagamentonumberNão1 = Tag.
└─ transpobjectSimInformações sobre o transportador do vale-pedágio.
  └─ rntrcnumber(9)SimRNTRC do transportador responsável.
  └─ cpfCnpjTransportadorstring(14)SimCNPJ do transportador (14 dígitos).
  └─ cadastroobjectNãoDados do transportador para cadastro.
    └─ nomeRazaostring(150)SimNome completo do transportador (1–150).
    └─ tiponumberSim1 = TAC, 2 = ETC, 3 = CTC.
  └─ dadosPFobjectNãoDados do transportador TAC (quando aplicável).
    └─ dataNascimentodateSim (se TAC)Data no formato AAAA-MM-DD.
    └─ identidadestring(20)Sim (se TAC)RG do transportador TAC (sem máscara).
└─ condutorobjectNãoDados do condutor.
  └─ cpfnumber(11)SimCPF do condutor (11 dígitos).
  └─ nomeCompletostring(150)SimNome completo do condutor (1–150).
└─ infRotaobjectNãoCampos contendo dados da rota para integração.
  └─ categoriaPedagionumberSimCategoria de pedágio (0–16 conforme tabela ANTT).
  └─ rotastring(30)SimNome da rota no ERP/TMS (1–30).
  └─ informacoesobjectNãoDados para inserir ou atualizar rota.
    └─ tipoRotaPadraonumberNão1 = Rápida, 2 = Curta.
    └─ utilizarRoteirizadornumberNão1 = Sim, 2 = Não.
    └─ pontosParadaarraySimLista de pontos de parada.
      └─ paradaarraySim (2–N)Cada item representa um ponto de parada.
        └─ cepstring(8)NãoCEP do ponto de parada.
        └─ codigoIBGEnumber(7)NãoCódigo IBGE do ponto.
        └─ latlongarrayCondicionalConjunto de latitude e longitude.
          └─ latitudestringNãoLatitude do ponto.
          └─ longitudestringNãoLongitude do ponto.
└─ observacaostring(500)NãoObservação livre exibida na impressão do NDVP.
└─ veiculoobjectNãoDados do veículo.
  └─ placastring(7)SimPlaca do veículo.
  └─ cadastroobjectNãoDados para cadastro do veículo.
    └─ modelostring(100)SimModelo do veículo (1–100).
    └─ RNTRCTransportadornumber(9)SimRNTRC do transportador responsável pelo veículo na ANTT.
└─ informacoesTagobjectNãoInformações da TAG (quando utilizada).
  └─ codigoFornecedornumberSim1 = ConectCar, 2 = Sem Parar, 3 = Veloe, 4 = Move Mais.
  └─ codigoTagAtivacaostring(30)NãoCódigo do adesivo da TAG. Obrigatório para ativar TAG nova.

Resposta do POST

Após o envio do vale-pedágio, a resposta retornará um JSON contendo o status do envio e um GUID para acompanhamento:

Exemplo de resposta de sucesso:

{
"sucesso": true,
"guid": "xxxxxxxxxxxxxxx",
"codigo": "000",
"mensagem": "Lote recebido para processamento."
}

Observação:

sucesso: indica se o lote foi aceito para processamento (true) ou rejeitado (false).

guid: identificador único para consultar o processamento do lote posteriormente.

codigo: código de retorno (ex.: "000" para sucesso).

mensagem: descrição do resultado da requisição ou mensagens informativas.


Exemplo de resposta de erro:

{
"sucesso": false,
"guid": "",
"codigo": "400",
"mensagem": "Erro na validação dos parâmetros do lote."
}

Próximos passos

Acesse a consulta da compra ou veja como cancelar um Vale-Pedágio.