Consultar detalles de un vale de peaje

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

GET/vale-pedagio/{uuid}

consultarValePedagioBase 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.

Consulta el estado, datos de emisión, número de registro ANTT, NSU y comprobante de un vale de peaje.

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

Respuestas

200 Respuesta HTTP

Datos del vale de peaje

`application/json`

DetalhesVpoResponse ↗

successbooleanOpcional

dataobjectOpcional

ValePedagioDetalhe ↗

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

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