curl --request POST \
--url https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ticketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tripId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tripItineraryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passengerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passengerBenefitRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"benefitDocumentValidationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatPrice": 123,
"tripItineraryPrice": 123,
"baseAmount": 123,
"benefitDiscountAmount": 123,
"discountAmount": 123,
"creditAmount": 123,
"paidAmount": 123,
"price": 123,
"qrCode": "<string>",
"code": "<string>",
"snapshot": {},
"boardedAt": "2023-11-07T05:31:56Z",
"issuedAt": "2023-11-07T05:31:56Z",
"status": "VALID",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [
{
"code": "invalid_type",
"message": "Required",
"path": "name"
}
]
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}Board Ticket
Marks a ticket as boarded and returns the updated ticket.
curl --request POST \
--url https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/driver/trips/{tripId}/tickets/{code}/board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ticketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tripId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tripItineraryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passengerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passengerBenefitRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"benefitDocumentValidationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatPrice": 123,
"tripItineraryPrice": 123,
"baseAmount": 123,
"benefitDiscountAmount": 123,
"discountAmount": 123,
"creditAmount": 123,
"paidAmount": 123,
"price": 123,
"qrCode": "<string>",
"code": "<string>",
"snapshot": {},
"boardedAt": "2023-11-07T05:31:56Z",
"issuedAt": "2023-11-07T05:31:56Z",
"status": "VALID",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [
{
"code": "invalid_type",
"message": "Required",
"path": "name"
}
]
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Trip identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Readable ticket code
"BIL-A1B2C3"
Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Response
OK
Passagens emitidas vinculando pedido, viagem, itinerário, assento e passageiro
Identificador único
Referência ao pedido
Referência à cooperativa responsável pelo ticket
Referência ao permissionário responsável pela viagem
Referência à viagem
Referência ao itinerário
Referência ao assento
Referência ao tipo de assento
Solicitação aprovada usada pelo passageiro neste ticket
Documento validado que comprovou o benefício aplicado
Preço do tipo de assento no momento da emissão (centavos)
Preço do itinerário no momento da emissão (centavos)
Valor bruto da passagem antes de descontos e crédito
Desconto aplicado por benefício tarifário
Soma dos descontos aplicados
Crédito corporativo capturado neste ticket
Valor pago por meio externo depois de descontos e crédito
Valor final comercial da passagem após descontos, antes do crédito
Payload codificado para validação de embarque
Código legível da passagem
Snapshot denormalizado (trip, itinerário, assento, tipo, passageiro) para exibição
Data/hora do embarque (null se ainda não embarcou)
Data de emissão da passagem
Status da passagem (default VALID)
VALID, CANCELLED Usuário que criou o registro, quando aplicável
Data de criação
Usuário que fez a última atualização, quando aplicável
Data da última atualização