Cancelar - POST

Registra o cancelamento de vale-pedágio, enviando as informações necessárias para processar de forma assíncrona. Ao receber a solicitação, o sistema inicia seu processamento e retorna um GUID para acompanhamento posterior.

Método e rota

• Solicitação (POST): /valePedagio/cancelar/{enterpriseId}
• Parâmetros de Rota:
  • enterpriseId: CNPJ associado à operação (string).

Corpo

O corpo da requisição deve ser um JSON contendo os dados para cancelamento, com a seguinte estrutura:

Consulte aqui as referências

{
	"cnpj": "CNPJ associado à operação (string)",
  "ndvp": "Número ou identificação NDVP do vale-pedágio (string).",
  "codigoVerificador": "Código verificador do NDVP (string)",
  "motivo": "Solicitamos o cancelamento do OVP."
}

Nome do Campo	Tipo	Observação
cancelamento	Object	Objeto que contém os dados do cancelamento do vale-pedágio.
cnpj (em cancelamento)	String(14)	CNPJ associado à operação.
ndvp (em cancelamento)	String	Número ou identificação do NDVP do vale-pedágio.
codigoVerificador (em cancelamento)	String	Código verificador do NDVP.
motivo (em cancelamento)	String	Motivo pelo qual o vale-pedágio está sendo cancelado.

Resposta do POST

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

• O campo "sucesso" indica se o lote foi aceito (true) ou não (false).
• "guid" contém o identificador único para acompanhar o processamento do cancelamento.
• Os campos "codigo" e "mensagem" podem servir para informações gerais ou mensagens de aviso, conforme a implementação.

Exemplo de resposta de sucesso:

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

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 solicitação de cancelamento.

---