Pular para o conteúdo principal

Consulta de compra - GET

Consulta o status e o resultado do processamento da compra de vale-pedágio utilizando o GUID retornado no POST.

Método e rota

  • Consulta (GET): /valePedagio/comprar/{enterpriseId}/{guid}

Corpo

Consulte aqui as referências

Resposta do GET

Exemplo de resposta bem-sucedida para a consulta:

{
"valor": 500.0,
"numeroVP": 123456789012,
"codigoVerificadorVP": "ABCD",
"idANTT": "12345678901234567890",
"sucesso": true,
"erros": []
}

Descrição dos Campos:

  • valor: Valor total do vale-pedágio.
  • numeroVP: Número gerado pelo sistema para o Vale Pedágio.
  • codigoVerificadorVP: Código verificador associado ao Vale Pedágio.
  • idANTT: Identificador ANTT único do registro do Vale Pedágio.
  • sucesso: Indica que o processamento foi concluído com êxito.
  • erros: Array vazio, indicando que não ocorreram erros.

Exemplo de resposta de erro para a consulta:

{
"sucesso": false,
"erros": [
{
"codigo": 400,
"mensagem": "Falha ao processar a operação: Sem saldo em conta de pagamento"
}
]
}
``

**Descrição dos campos (para cenário de erro):**

- Somente os campos abaixo são retornados:
- **sucesso:** `false`, indicando que houve falha no processamento.
- **erros:** Array contendo um objeto com:
- `codigo`: Código do erro (exemplo: 400 para erro de validação ou condição específica).
- `mensagem`: Descrição do erro ocorrido (exemplo: "Falha ao processar a operação: Sem saldo em conta de pagamento").

---

## **Próximos passos**


Acesse a [**consulta do processamento do lote**](./get-consulta-do-processamento-do-lote) ou veja como [**cancelar uma operação de transporte**](./cancelar-operacao-de-transporte).

---