Skip to main content
GET
Get Boarding Ticket

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tripId
string<uuid>
required

Trip identifier.

code
string
required

Ticket code or QR code value.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

OK

Passagens emitidas vinculando pedido, viagem, itinerário, assento e passageiro

ticketId
string<uuid>
required

Identificador único

orderId
string<uuid>
required

Referência ao pedido

cooperativeId
string<uuid>
required

Referência à cooperativa responsável pelo ticket

transportOperatorId
string<uuid>
required

Referência ao permissionário responsável pela viagem

tripId
string<uuid>
required

Referência à viagem

tripItineraryId
string<uuid>
required

Referência ao itinerário

seatId
string<uuid>
required

Referência ao assento

seatTypeId
string<uuid>
required

Referência ao tipo de assento

passengerId
string<uuid>
required

Referência ao Passenger

passengerBenefitRequestId
string<uuid> | null
required

Solicitação aprovada usada pelo passageiro neste ticket

benefitDocumentValidationId
string<uuid> | null
required

Documento validado que comprovou o benefício aplicado

seatPrice
integer
required

Preço do tipo de assento no momento da emissão (centavos)

tripItineraryPrice
integer
required

Preço do itinerário no momento da emissão (centavos)

baseAmount
integer
required

Valor bruto da passagem antes de descontos e crédito

benefitDiscountAmount
integer
required

Desconto aplicado por benefício tarifário

discountAmount
integer
required

Soma dos descontos aplicados

creditAmount
integer
required

Crédito corporativo capturado neste ticket

paidAmount
integer
required

Valor pago por meio externo depois de descontos e crédito

price
integer
required

Valor final comercial da passagem após descontos, antes do crédito

qrCode
string
required

Payload codificado para validação de embarque

code
string
required

Código legível da passagem

snapshot
object | null
required

Snapshot denormalizado (trip, itinerário, assento, tipo, passageiro) para exibição

boardedAt
string<date-time> | null
required

Data/hora do embarque (null se ainda não embarcou)

issuedAt
string<date-time>
required

Data de emissão da passagem

status
enum<string>
required

Status da passagem (default VALID)

Available options:
VALID,
CANCELLED
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

createdAt
string<date-time>
required

Data de criação

updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

updatedAt
string<date-time>
required

Data da última atualização