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
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 campo | Tipo | Obrigatório | Observação |
|---|---|---|---|
valePedagio | object | Sim | Raiz do payload "Comprar Vale Pedágio". |
└─ ide | object | Sim | Informações sobre a operação de vale-pedágio. |
└─ cnpj | string(14) | Sim | CNPJ da contratante (14 dígitos). |
└─ numero | string | Sim | Número identificador da operação de vale-pedágio. |
└─ serie | string | Sim | Série para a operação de vale-pedágio. |
└─ ptEmissor | string(30) | Sim | Ponto emissor responsável pela operação (1–30). |
└─ dataFinal | date/string | Não | Data de término (AAAA-MM-DD). Se não informada, assume +30 dias após a data inicial. |
└─ tipoPagamento | number | Não | 1 = Tag. |
└─ transp | object | Sim | Informações sobre o transportador do vale-pedágio. |
└─ rntrc | number(9) | Sim | RNTRC do transportador responsável. |
└─ cpfCnpjTransportador | string(14) | Sim | CNPJ do transportador (14 dígitos). |
└─ cadastro | object | Não | Dados do transportador para cadastro. |
└─ nomeRazao | string(150) | Sim | Nome completo do transportador (1–150). |
└─ tipo | number | Sim | 1 = TAC, 2 = ETC, 3 = CTC. |
└─ dadosPF | object | Não | Dados do transportador TAC (quando aplicável). |
└─ dataNascimento | date | Sim (se TAC) | Data no formato AAAA-MM-DD. |
└─ identidade | string(20) | Sim (se TAC) | RG do transportador TAC (sem máscara). |
└─ condutor | object | Não | Dados do condutor. |
└─ cpf | number(11) | Sim | CPF do condutor (11 dígitos). |
└─ nomeCompleto | string(150) | Sim | Nome completo do condutor (1–150). |
└─ infRota | object | Não | Campos contendo dados da rota para integração. |
└─ categoriaPedagio | number | Sim | Categoria de pedágio (0–16 conforme tabela ANTT). |
└─ rota | string(30) | Sim | Nome da rota no ERP/TMS (1–30). |
└─ informacoes | object | Não | Dados para inserir ou atualizar rota. |
└─ tipoRotaPadrao | number | Não | 1 = Rápida, 2 = Curta. |
└─ utilizarRoteirizador | number | Não | 1 = Sim, 2 = Não. |
└─ pontosParada | array | Sim | Lista de pontos de parada. |
└─ parada | array | Sim (2–N) | Cada item representa um ponto de parada. |
└─ cep | string(8) | Não | CEP do ponto de parada. |
└─ codigoIBGE | number(7) | Não | Código IBGE do ponto. |
└─ latlong | array | Condicional | Conjunto de latitude e longitude. |
└─ latitude | string | Não | Latitude do ponto. |
└─ longitude | string | Não | Longitude do ponto. |
└─ observacao | string(500) | Não | Observação livre exibida na impressão do NDVP. |
└─ veiculo | object | Não | Dados do veículo. |
└─ placa | string(7) | Sim | Placa do veículo. |
└─ cadastro | object | Não | Dados para cadastro do veículo. |
└─ modelo | string(100) | Sim | Modelo do veículo (1–100). |
└─ RNTRCTransportador | number(9) | Sim | RNTRC do transportador responsável pelo veículo na ANTT. |
└─ informacoesTag | object | Não | Informações da TAG (quando utilizada). |
└─ codigoFornecedor | number | Sim | 1 = ConectCar, 2 = Sem Parar, 3 = Veloe, 4 = Move Mais. |
└─ codigoTagAtivacao | string(30) | Não | Có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.