← HomeFleetPay / API

Download Mandatory Electronic Toll (VPO) PDF receipt

Parameters, data structure and responses from the versioned contract.

GET/vale-pedagio/{uuid}/recibo/pdf
obterReciboPdfValePedagioSandbox Base: https://api.fleetpay.site/v1

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

Returns the official PDF receipt file for Mandatory Electronic Toll (VPO) purchase.

Authentication

Required Scope
operacao — Operations
Module
Mandatory Electronic Toll (VPO)
Target Profiles
Shipper · Transport Manager · Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

uuidpath · stringRequired

Issued Electronic Toll (VPO) UUID.

Constraints
{
  "type": "string"
}

Responses

200 HTTP Response

PDF receipt binary.

application/json

401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

404 HTTP Response

Electronic Toll (VPO) not found.

Complete Operation Definition
{
  "tags": [
    "Vale-Pedágio (VPO)"
  ],
  "operationId": "obterReciboPdfValePedagio",
  "summary": "Baixar recibo em PDF do Vale-Pedágio Obrigatório",
  "description": "Retorna o arquivo PDF oficial do comprovante de compra do Vale-Pedágio Obrigatório (VPO).",
  "parameters": [
    {
      "name": "uuid",
      "in": "path",
      "required": true,
      "description": "UUID do Vale-Pedágio emitido.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Binário PDF do recibo.",
      "content": {
        "application/json": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "404": {
      "description": "Vale-Pedágio não encontrado."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "vale-pedagio",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/vale-pedagio/{uuid}/recibo/pdf"
}