> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clubfix.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Recupera o PayPerUse

> A recuperação de um objeto de seguro viagem acontece através do `número do bilhete` passado na URL. Assim como na listagem, é possível aninhar outros objetos, como status, histórico de status e o cliente segurado.


<ParamField path="ticketNumber" type="string" initialValue="1101542023EXCL01715000" required>
  Número do bilhete do seguro viagem. Este número é único e é retornado após a contratação do seguro.
</ParamField>

<ParamField header="Accept" type="string" initialValue="application/json" required>
  Cabeçalho que indica o tipo de conteúdo aceito na resposta. Deve ser sempre `application/json`.
</ParamField>

<ParamField query="include" type="string" initialValue="status,customer,model">
  Inclui na requisição objetos aninhados. Valores possíveis: `status`, `historic`, `customer`. Você pode combinar múltiplos valores separados por vírgula.

  Exemplo: `status,customer,model`
</ParamField>


## OpenAPI

````yaml GET /payperuse/insurances/{ticketNumber}
openapi: 3.0.3
info:
  title: PayPerUse Unified API
  description: >
    API para contratação e gerenciamento de seguros viagem para dispositivos
    móveis.


    Esta API permite cotar planos, contratar seguros, processar pagamentos e
    gerenciar seguros viagem.


    Observação: Utilize sempre os cabeçalhos `Content-Type` e `Accept` como
    `application/json`
  version: 1.0.0
servers:
  - url: https://homolog.clubfix.com.br/webservice
    description: Ambiente de Homologação
  - url: https://clubfix.com.br/webservice
    description: Ambiente de Produção
security:
  - bearerAuth: []
tags:
  - name: Autenticação
    description: Endpoints para autenticação e obtenção de tokens
  - name: Cotação
    description: Endpoints para cotação de planos de seguro viagem
  - name: Contratação
    description: Endpoints para contratação de seguros viagem
  - name: Pagamento
    description: Endpoints para processamento de pagamentos
  - name: Anexos
    description: Endpoints para anexar documentos
  - name: Seguros
    description: Endpoints para consulta e gerenciamento de seguros
paths:
  /payperuse/insurances/{ticketNumber}:
    get:
      tags:
        - Seguros
      summary: Recupera um seguro viagem
      description: >
        A recuperação de um objeto de seguro viagem acontece através do `número
        do bilhete` passado na URL. Assim como na listagem, é possível aninhar
        outros objetos, como status, histórico de status e o cliente segurado.
      operationId: getTravelInsurance
      parameters:
        - name: ticketNumber
          in: path
          required: true
          description: Número do bilhete do seguro
          schema:
            type: string
            example: 1101542023EXCL01715000
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            default: application/json
        - name: include
          in: query
          description: >-
            Inclui na requisição objetos aninhados (apenas: status, historic,
            customer)
          schema:
            type: string
            example: status,customer,model
      responses:
        '200':
          description: Seguro viagem encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insurance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    Insurance:
      type: object
      properties:
        id:
          type: integer
          example: 14
        days:
          type: integer
          description: Número de dias de vigência
          example: 12
        starts_at:
          type: string
          format: date
          example: '2025-12-20'
        ends_at:
          type: string
          format: date
          example: '2025-12-31'
        cancel_limit_date:
          type: string
          format: date
          description: Data limite para cancelamento
          example: '2025-12-19'
        maxima:
          type: integer
          example: 10000
        amount:
          type: number
          format: float
          example: 90
        origin:
          type: string
          example: Curitiba - PR
        local:
          type: string
          nullable: true
          example: null
        created_at:
          type: string
          format: date-time
          example: '2025-12-19T20:06:26.000000Z'
        status:
          $ref: '#/components/schemas/InsuranceStatus'
        ticket:
          $ref: '#/components/schemas/Ticket'
          nullable: true
        ticket_number:
          type: string
          example: '11015420250171'
    InsuranceStatus:
      type: object
      properties:
        status:
          type: string
          example: pending
        created_at:
          type: string
          format: date-time
          example: '2025-12-19T20:06:26.000000Z'
    Ticket:
      type: object
      properties:
        link:
          type: string
          format: uri
          description: Link para impressão do bilhete
          example: >-
            http://localhost:8000/partnership/payperuse/events/bilhetes/6022a54610f94d05ab73905057a8be73
        expires_at:
          type: string
          format: date-time
          description: Data de expiração do link
          example: '2025-12-19 17:16:00'
  responses:
    Unauthorized:
      description: Não autorizado. Token inválido ou ausente.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthenticated.
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Resource not found.
    ServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Internal server error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de autenticação obtido através do endpoint de autenticação

````