← HomeFleetPay / API

Get toll voucher details

Parameters, data structure and responses from the versioned contract.

GET/vale-pedagio/{uuid}

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

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

Queries a toll voucher's status, issuance data, ANTT registration number, NSU and receipt.

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

Responses

200 HTTP Response

Toll voucher data

`application/json`

DetalhesVpoResponse ↗

successbooleanOptional

dataobjectOptional

ValePedagioDetalhe ↗

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

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": "Consultar detalhes de um Vale-Pedágio",
  "operationId": "consultarValePedagio",
  "description": "Consulta o status, dados da emissão, número de registro ANTT, NSU e comprovante de um Vale-Pedágio.\n",
  "parameters": [
    {
      "$ref": "#/components/parameters/VpoUuid"
    }
  ],
  "responses": {
    "200": {
      "description": "Dados do Vale-Pedágio",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DetalhesVpoResponse"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "GET",
  "path": "/vale-pedagio/{uuid}"
}