Preview Checkout Session
curl --request POST \
--url https://api.example.com/api/v1/customer/checkout-sessions/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"qrToken": "nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8"
}
'import requests
url = "https://api.example.com/api/v1/customer/checkout-sessions/preview"
payload = { "qrToken": "nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({qrToken: 'nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8'})
};
fetch('https://api.example.com/api/v1/customer/checkout-sessions/preview', 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/customer/checkout-sessions/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'qrToken' => 'nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/customer/checkout-sessions/preview"
payload := strings.NewReader("{\n \"qrToken\": \"nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/customer/checkout-sessions/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"qrToken\": \"nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/checkout-sessions/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"qrToken\": \"nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8\"\n}"
response = http.request(request)
puts response.read_body{
"checkoutSessionId": "01981255-3c7a-7bd4-bb5f-8b47bc4dce91",
"status": "CREATED",
"paymentMethod": "CASH",
"expiresAt": "2026-07-08T12:15:00.000Z",
"trip": {
"tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"status": "SCHEDULED",
"departureAt": "2026-04-15T08:00:00.000Z",
"estimatedArrivalAt": "2026-04-15T14:00:00.000Z",
"itineraries": [
{
"tripItineraryId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"price": 15000,
"fromStop": {
"tripStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"stopOrder": 1,
"point": {
"name": "São Paulo",
"pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"description": "Terminal Rodoviário Tietê",
"lat": -23.5155,
"lng": -46.6254
}
},
"toStop": {
"tripStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"stopOrder": 1,
"point": {
"name": "São Paulo",
"pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"description": "Terminal Rodoviário Tietê",
"lat": -23.5155,
"lng": -46.6254
}
}
}
]
}
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}CheckoutSession
Preview Checkout Session
Previews a checkout session from a QR token.
POST
/
api
/
v1
/
customer
/
checkout-sessions
/
preview
Preview Checkout Session
curl --request POST \
--url https://api.example.com/api/v1/customer/checkout-sessions/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"qrToken": "nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8"
}
'import requests
url = "https://api.example.com/api/v1/customer/checkout-sessions/preview"
payload = { "qrToken": "nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({qrToken: 'nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8'})
};
fetch('https://api.example.com/api/v1/customer/checkout-sessions/preview', 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/customer/checkout-sessions/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'qrToken' => 'nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/customer/checkout-sessions/preview"
payload := strings.NewReader("{\n \"qrToken\": \"nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/customer/checkout-sessions/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"qrToken\": \"nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/checkout-sessions/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"qrToken\": \"nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8\"\n}"
response = http.request(request)
puts response.read_body{
"checkoutSessionId": "01981255-3c7a-7bd4-bb5f-8b47bc4dce91",
"status": "CREATED",
"paymentMethod": "CASH",
"expiresAt": "2026-07-08T12:15:00.000Z",
"trip": {
"tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"status": "SCHEDULED",
"departureAt": "2026-04-15T08:00:00.000Z",
"estimatedArrivalAt": "2026-04-15T14:00:00.000Z",
"itineraries": [
{
"tripItineraryId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"price": 15000,
"fromStop": {
"tripStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"stopOrder": 1,
"point": {
"name": "São Paulo",
"pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"description": "Terminal Rodoviário Tietê",
"lat": -23.5155,
"lng": -46.6254
}
},
"toStop": {
"tripStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"stopOrder": 1,
"point": {
"name": "São Paulo",
"pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"description": "Terminal Rodoviário Tietê",
"lat": -23.5155,
"lng": -46.6254
}
}
}
]
}
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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.
Body
application/json
Raw QR token returned only on creation
Example:
"nL7m2oM5zMwdON44BpQ_WteULcSGMjQm53WJb5xVZC8"
Response
OK
Checkout session identifier
Example:
"01981255-3c7a-7bd4-bb5f-8b47bc4dce91"
Computed checkout session status
Available options:
CREATED, LINKED, PREPARED, CONFIRMED, EXPIRED, CANCELED Example:
"CREATED"
Checkout payment method
Available options:
CASH, CREDIT_GRANT Example:
"CASH"
Expiration date
Example:
"2026-07-08T12:15:00.000Z"
Session trip
Show child attributes
Show child attributes
⌘I