Cancelar un vale de peaje obligatorio

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/vale-pedagio/{uuid}/cancelar

cancelarValePedagioBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Cancela el vale de peaje ante ANTT y la operadora acreditada.

Regla estricta de 3 horas: La cancelación se acepta únicamente dentro del plazo reglamentario de hasta 3 horas después de la emisión y antes de su uso en una plaza de peaje. El importe debitado se reintegra íntegramente a la Cuenta Operativa Swap de la empresa.

Autenticación

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

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

uuidpath · stringObligatorio

UUID del vale de peaje obligatorio devuelto al emitir (/vale-pedagio/comprar).

Restricciones

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

Cuerpo de la Solicitud

Opcional

`application/json`

CancelarVpoRequest ↗

motivostring | nullOpcional

Motivo de cancelación (opcional).

Respuestas

200 Respuesta HTTP

Vale de peaje cancelado correctamente y saldo devuelto

`application/json`

CancelarVpoResponse ↗

successbooleanOpcional

messagestringOpcional

401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Respuesta HTTP

Ámbito no habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Respuesta HTTP

Vale de peaje no encontrado

`application/json`

Erro ↗

errorobjectOpcional

422 Respuesta HTTP

Cancelación rechazada (plazo de 3 horas vencido o ya utilizado)

`application/json`

Erro ↗

errorobjectOpcional

429 Respuesta HTTP

Límite de solicitudes excedido (limite_requisicoes). Espera el intervalo indicado en el encabezado Retry-After antes de reintentar. Puede provenir del proveedor o del límite antiabuso de FleetPay, calculado por empresa autenticada y grupo de rutas, con una ventana corta para ráfagas y otra larga para tráfico automatizado lento. Los límites son amplios deliberadamente: las integraciones reales, incluidos lotes grandes procesados de una vez, deberían quedar muy por debajo. Si tu integración alcanza un límite, contacta con FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Respuesta HTTP

Error interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definición Completa de la Operación

{
  "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"
}