← HomeFleetPay / API

Quote toll voucher routes and charges

Parameters, data structure and responses from the versioned contract.

POST/vale-pedagio/cotacao

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

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

Alias of the routing endpoint for toll voucher cost simulation and quotation.

Authentication

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

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

Parameters

No parameters declared for this operation.

Request Body

Required

`application/json`

CotarVpoRequest ↗

origemstringRequired

Postal code (with or without a hyphen) or departure city name/address.

minLength3

maxLength150

destinostringRequired

Postal code (with or without a hyphen) or destination city name/address.

minLength3

maxLength150

eixosintegerRequired

Total axle count of the commercial vehicle or vehicle combination.

minimum2

maximum10

placastring | nullOptional

Commercial vehicle license plate (Mercosur or legacy Brazilian format).

maxLength10

modalidadestring | nullOptional

Requested route option (planejada: optimized direct route; estendida: route allowing detours; customizada: specific toll plazas).

"planejada" · "estendida" · "customizada"

pontos_paradaarray | nullOptional

Intermediate waypoints, in the order the vehicle visits them, between origem and destino. The operator does not accept a polyline: the route is defined by waypoints. Each waypoint can be a city (cidade, in "City, State" format) or a latitude/longitude pair in decimal degrees (for example, relevant vertices of your own route). If a waypoint includes both a city and coordinates, the city takes precedence. Use this field to route through a specific highway or reproduce a route from your routing engine. Without this field, the operator chooses the route between origin and destination.

VpoPontoParada ↗

maxItems20

tipo_rotastring | nullOptional

Operator's criterion for determining the main route between the points.

"mais_rapida" · "mais_curta"

Responses

200 HTTP Response

Quote calculated successfully

`application/json`

CotarVpoResponse ↗

successbooleanOptional

rotasarrayOptional

RotaPedagio ↗

400 HTTP Response

Invalid request

`application/json`

Erro ↗

errorobjectOptional

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

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": "Cotação de rotas e tarifas de Vale-Pedágio",
  "operationId": "cotarValePedagio",
  "description": "Alias do endpoint de roteirização para simulação e cotação de custos do Vale-Pedágio.\n",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CotarVpoRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Cotação calculada com sucesso",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CotarVpoResponse"
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/Erro400"
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "POST",
  "path": "/vale-pedagio/cotacao",
  "parameters": []
}