Pular para o conteúdo principal

Consulta de cancelamento - GET

Consultar o status e o resultado do processamento do cancelamento de vale-pedágio utilizando o GUID retornado no POST.

Método e rota

  • Consulta (GET): /valePedagio/cancelar/{enterpriseId}/{guid}
    • Parâmetros de Rota:
      • enterpriseId: CNPJ associado à operação (string).
      • guid: Identificador GUID da requisição POST

Corpo

Consulte aqui as referências

Resposta do GET

Exemplo de resposta para a consulta (em caso de sucesso ou com erros):

{
"sucesso": true,
"erros": [
{
"codigo": 400,
"mensagem": "Falha ao processar a operação: dados inválidos."
}
]
}
  • sucesso: booleano que indica se a operação foi processada com êxito (true).
  • erros: array de objetos para reporte de erros (neste exemplo, contém um objeto de erro, mesmo que sucesso seja true, podendo ser utilizado para comunicar avisos ou inconsistências não críticas).
  • Cada objeto de erro contém:
  • codigo: (number) Código do erro (ex.: 400 para erro de validação).
  • mensagem: (string) Descrição do erro.

Códigos de Status HTTP

  • 200 : Indicam que o cancelamento foi processado com sucesso.
  • 202 : Indica que está em processamento.
  • 400: Erro de validação (por exemplo, campo motivo ausente ou {id} inválido).
  • 401: Não autorizado (token JWT ausente ou inválido).
  • 500: Erro interno do servidor.

Consulte aqui todas as mensagens e códigos de retorno