Obter recibo/comprovante do Vale-Pedágio

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/vale-pedagio/{uuid}/recibo

obterReciboValePedagioBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Obtém os dados do comprovante e cupom oficial emitido pela operadora para impressão ou guarda documental.

Autenticação

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

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

uuidpath · stringObrigatório

UUID do Vale-Pedágio Obrigatório devolvido na emissão (/vale-pedagio/comprar).

Restrições

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

Respostas

200 Resposta HTTP

Recibo do Vale-Pedágio

`application/json`

ReciboVpoResponse ↗

successbooleanOpcional

dataobjectOpcional

ReciboValePedagio ↗

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Resposta HTTP

Vale-Pedágio não encontrado

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "tags": [
    "Vale-Pedágio (VPO)"
  ],
  "summary": "Obter recibo/comprovante do Vale-Pedágio",
  "operationId": "obterReciboValePedagio",
  "description": "Obtém os dados do comprovante e cupom oficial emitido pela operadora para impressão ou guarda documental.\n",
  "parameters": [
    {
      "$ref": "#/components/parameters/VpoUuid"
    }
  ],
  "responses": {
    "200": {
      "description": "Recibo do Vale-Pedágio",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ReciboVpoResponse"
          }
        }
      }
    },
    "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}/recibo"
}