← HomeFleetPay / API

Cancel a mandatory toll voucher

Parameters, data structure and responses from the versioned contract.

POST/vale-pedagio/{uuid}/cancelar

cancelarValePedagioSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Cancels the toll voucher with ANTT and the accredited operator.

Strict 3-hour rule: Cancellation is accepted strictly within the regulatory window of up to 3 hours after issuance and before use at a toll plaza. The debited amount is refunded in full to the company's Swap Operational Account.

Authentication

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

Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

uuidpath · stringRequired

Mandatory toll voucher UUID returned at issuance (/vale-pedagio/comprar).

Constraints

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

Request Body

Optional

`application/json`

CancelarVpoRequest ↗

motivostring | nullOptional

Cancellation reason (optional).

Responses

200 HTTP Response

Toll voucher successfully canceled and balance refunded

`application/json`

CancelarVpoResponse ↗

successbooleanOptional

messagestringOptional

401 HTTP Response

Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.

`application/json`

Erro ↗

errorobjectOptional

403 HTTP Response

Scope not enabled for these credentials

`application/json`

Erro ↗

errorobjectOptional

404 HTTP Response

Toll voucher not found

`application/json`

Erro ↗

errorobjectOptional

422 HTTP Response

Cancellation rejected (3-hour deadline expired or already used)

`application/json`

Erro ↗

errorobjectOptional

429 HTTP Response

Request limit exceeded (limite_requisicoes). Wait for the interval specified in the Retry-After header before retrying. This may be a limit forwarded from the provider or FleetPay's own anti-abuse limit, counted per authenticated company and route group, with a short window for bursts and a long window for slower automated traffic. Limits are intentionally generous: genuine integrations, including large batches processed at once, should remain well below them. If yours reaches a limit, contact FleetPay.

`application/json`

Erro ↗

errorobjectOptional

500 HTTP Response

Internal error (erro_interno)

`application/json`

Erro ↗

errorobjectOptional

Complete Operation Definition

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