Cancelar Vale-Pedágio Obrigatório

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/vale-pedagio/{uuid}/cancelar

cancelarValePedagioBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Cancela o Vale-Pedágio perante a ANTT e a operadora credenciada.

Regra estrita de 3 horas: O cancelamento é aceito estritamente dentro da janela regulamentar de até 3 horas após a emissão e antes do uso em praça de pedágio. O saldo debitado é estornado integralmente na Conta Operacional Swap da empresa.

Autenticação

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

uuidpath · stringObrigatório

UUID do Vale-Pedágio Obrigatório devolvido na emissão (/vale-pedagio/comprar).

Restrições

{
  "type": "string",
  "format": "uuid"
}

Corpo da Requisição

Opcional

`application/json`

CancelarVpoRequest ↗

motivostring | nullOpcional

Motivo do cancelamento (opcional).

Respostas

200 Resposta HTTP

Vale-Pedágio cancelado com sucesso e saldo estornado

`application/json`

CancelarVpoResponse ↗

successbooleanOpcional

messagestringOpcional

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Resposta HTTP

Vale-Pedágio não encontrado

`application/json`

Erro ↗

errorobjectOpcional

422 Resposta HTTP

Cancelamento recusado (prazo de 3 horas expirado ou já utilizado)

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "tags": [
    "Vale-Pedágio (VPO)"
  ],
  "summary": "Cancelar Vale-Pedágio Obrigatório",
  "operationId": "cancelarValePedagio",
  "description": "Cancela o Vale-Pedágio perante a ANTT e a operadora credenciada.\n\n**Regra estrita de 3 horas:** O cancelamento é aceito estritamente dentro da janela regulamentar de\naté 3 horas após a emissão e antes do uso em praça de pedágio. O saldo debitado é estornado integralmente\nna Conta Operacional Swap da empresa.\n",
  "parameters": [
    {
      "$ref": "#/components/parameters/VpoUuid"
    }
  ],
  "requestBody": {
    "required": false,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CancelarVpoRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Vale-Pedágio cancelado com sucesso e saldo estornado",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CancelarVpoResponse"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "description": "Vale-Pedágio não encontrado",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Cancelamento recusado (prazo de 3 horas expirado ou já utilizado)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "POST",
  "path": "/vale-pedagio/{uuid}/cancelar"
}