Create Checkout
curl --request POST \
--url https://api.example.com/api/v1/customer/checkouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tickets": [
{
"tripItineraryId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"seatId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e",
"passenger": {
"name": "Mariana Costa",
"document": "12345678909",
"documentType": "CPF",
"birthDate": null
},
"isCustomer": false
}
],
"creditAmount": 1500,
"payment": {
"paymentMethodId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890"
}
}
'import requests
url = "https://api.example.com/api/v1/customer/checkouts"
payload = {
"tickets": [
{
"tripItineraryId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"seatId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e",
"passenger": {
"name": "Mariana Costa",
"document": "12345678909",
"documentType": "CPF",
"birthDate": None
},
"isCustomer": False
}
],
"creditAmount": 1500,
"payment": { "paymentMethodId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890" }
}
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({
tickets: [
{
tripItineraryId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d',
seatId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e',
passenger: {
name: 'Mariana Costa',
document: '12345678909',
documentType: 'CPF',
birthDate: null
},
isCustomer: false
}
],
creditAmount: 1500,
payment: {paymentMethodId: 'f1a2b3c4-d5e6-7890-abcd-ef1234567890'}
})
};
fetch('https://api.example.com/api/v1/customer/checkouts', 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/checkouts",
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([
'tickets' => [
[
'tripItineraryId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d',
'seatId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e',
'passenger' => [
'name' => 'Mariana Costa',
'document' => '12345678909',
'documentType' => 'CPF',
'birthDate' => null
],
'isCustomer' => false
]
],
'creditAmount' => 1500,
'payment' => [
'paymentMethodId' => 'f1a2b3c4-d5e6-7890-abcd-ef1234567890'
]
]),
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/checkouts"
payload := strings.NewReader("{\n \"tickets\": [\n {\n \"tripItineraryId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d\",\n \"seatId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e\",\n \"passenger\": {\n \"name\": \"Mariana Costa\",\n \"document\": \"12345678909\",\n \"documentType\": \"CPF\",\n \"birthDate\": null\n },\n \"isCustomer\": false\n }\n ],\n \"creditAmount\": 1500,\n \"payment\": {\n \"paymentMethodId\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\"\n }\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/checkouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tickets\": [\n {\n \"tripItineraryId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d\",\n \"seatId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e\",\n \"passenger\": {\n \"name\": \"Mariana Costa\",\n \"document\": \"12345678909\",\n \"documentType\": \"CPF\",\n \"birthDate\": null\n },\n \"isCustomer\": false\n }\n ],\n \"creditAmount\": 1500,\n \"payment\": {\n \"paymentMethodId\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/checkouts")
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 \"tickets\": [\n {\n \"tripItineraryId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d\",\n \"seatId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e\",\n \"passenger\": {\n \"name\": \"Mariana Costa\",\n \"document\": \"12345678909\",\n \"documentType\": \"CPF\",\n \"birthDate\": null\n },\n \"isCustomer\": false\n }\n ],\n \"creditAmount\": 1500,\n \"payment\": {\n \"paymentMethodId\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\"\n }\n}"
response = http.request(request)
puts response.read_body{
"checkoutId": "0197a812-b835-79c4-8f0b-0e3863eb6d34",
"customerId": "0197a7f6-4d36-7c0a-a7cb-54fcb33a3148",
"customer": {
"customerId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"document": null,
"documentType": null,
"userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"user": {
"name": "Maria Silva",
"phoneDdi": "55",
"phoneIso": "BR",
"phoneNumber": "99999999999",
"userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"email": "maria@example.com"
}
},
"orders": [
{
"amount": 15000,
"code": "ORD-20260412-A1B2",
"orderId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"paidAmount": 15000,
"status": "PENDING",
"type": "ONLINE"
}
],
"code": "OAB-CHK-20260703-0001",
"baseAmount": 28900,
"discountAmount": 3400,
"creditAmount": 1500,
"paidAmount": 24000,
"amount": 25500,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"checkoutSessionId": "01981255-3c7a-7bd4-bb5f-8b47bc4dce91",
"createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
"updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
"checkoutSession": {
"checkoutSessionId": "01981255-3c7a-7bd4-bb5f-8b47bc4dce91",
"tripId": "0197a80f-2d8f-7710-b243-b67fb477a1c0",
"paymentMethod": "CASH",
"expiresAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"confirmedAt": "2023-11-07T05:31:56Z"
}
}{
"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
}Checkout
Create Checkout
Creates a checkout.
POST
/
api
/
v1
/
customer
/
checkouts
Create Checkout
curl --request POST \
--url https://api.example.com/api/v1/customer/checkouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tickets": [
{
"tripItineraryId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"seatId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e",
"passenger": {
"name": "Mariana Costa",
"document": "12345678909",
"documentType": "CPF",
"birthDate": null
},
"isCustomer": false
}
],
"creditAmount": 1500,
"payment": {
"paymentMethodId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890"
}
}
'import requests
url = "https://api.example.com/api/v1/customer/checkouts"
payload = {
"tickets": [
{
"tripItineraryId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"seatId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e",
"passenger": {
"name": "Mariana Costa",
"document": "12345678909",
"documentType": "CPF",
"birthDate": None
},
"isCustomer": False
}
],
"creditAmount": 1500,
"payment": { "paymentMethodId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890" }
}
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({
tickets: [
{
tripItineraryId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d',
seatId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e',
passenger: {
name: 'Mariana Costa',
document: '12345678909',
documentType: 'CPF',
birthDate: null
},
isCustomer: false
}
],
creditAmount: 1500,
payment: {paymentMethodId: 'f1a2b3c4-d5e6-7890-abcd-ef1234567890'}
})
};
fetch('https://api.example.com/api/v1/customer/checkouts', 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/checkouts",
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([
'tickets' => [
[
'tripItineraryId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d',
'seatId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e',
'passenger' => [
'name' => 'Mariana Costa',
'document' => '12345678909',
'documentType' => 'CPF',
'birthDate' => null
],
'isCustomer' => false
]
],
'creditAmount' => 1500,
'payment' => [
'paymentMethodId' => 'f1a2b3c4-d5e6-7890-abcd-ef1234567890'
]
]),
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/checkouts"
payload := strings.NewReader("{\n \"tickets\": [\n {\n \"tripItineraryId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d\",\n \"seatId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e\",\n \"passenger\": {\n \"name\": \"Mariana Costa\",\n \"document\": \"12345678909\",\n \"documentType\": \"CPF\",\n \"birthDate\": null\n },\n \"isCustomer\": false\n }\n ],\n \"creditAmount\": 1500,\n \"payment\": {\n \"paymentMethodId\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\"\n }\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/checkouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tickets\": [\n {\n \"tripItineraryId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d\",\n \"seatId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e\",\n \"passenger\": {\n \"name\": \"Mariana Costa\",\n \"document\": \"12345678909\",\n \"documentType\": \"CPF\",\n \"birthDate\": null\n },\n \"isCustomer\": false\n }\n ],\n \"creditAmount\": 1500,\n \"payment\": {\n \"paymentMethodId\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/checkouts")
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 \"tickets\": [\n {\n \"tripItineraryId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d\",\n \"seatId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e\",\n \"passenger\": {\n \"name\": \"Mariana Costa\",\n \"document\": \"12345678909\",\n \"documentType\": \"CPF\",\n \"birthDate\": null\n },\n \"isCustomer\": false\n }\n ],\n \"creditAmount\": 1500,\n \"payment\": {\n \"paymentMethodId\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\"\n }\n}"
response = http.request(request)
puts response.read_body{
"checkoutId": "0197a812-b835-79c4-8f0b-0e3863eb6d34",
"customerId": "0197a7f6-4d36-7c0a-a7cb-54fcb33a3148",
"customer": {
"customerId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"document": null,
"documentType": null,
"userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"user": {
"name": "Maria Silva",
"phoneDdi": "55",
"phoneIso": "BR",
"phoneNumber": "99999999999",
"userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"email": "maria@example.com"
}
},
"orders": [
{
"amount": 15000,
"code": "ORD-20260412-A1B2",
"orderId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"paidAmount": 15000,
"status": "PENDING",
"type": "ONLINE"
}
],
"code": "OAB-CHK-20260703-0001",
"baseAmount": 28900,
"discountAmount": 3400,
"creditAmount": 1500,
"paidAmount": 24000,
"amount": 25500,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"checkoutSessionId": "01981255-3c7a-7bd4-bb5f-8b47bc4dce91",
"createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
"updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
"checkoutSession": {
"checkoutSessionId": "01981255-3c7a-7bd4-bb5f-8b47bc4dce91",
"tripId": "0197a80f-2d8f-7710-b243-b67fb477a1c0",
"paymentMethod": "CASH",
"expiresAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"confirmedAt": "2023-11-07T05:31:56Z"
}
}{
"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
Response
Created
Checkout identifier
Example:
"0197a812-b835-79c4-8f0b-0e3863eb6d34"
Customer identifier
Example:
"0197a7f6-4d36-7c0a-a7cb-54fcb33a3148"
Customer identity
Show child attributes
Show child attributes
Checkout orders
Show child attributes
Show child attributes
Readable checkout code
Example:
"OAB-CHK-20260703-0001"
Base amount in cents
Example:
28900
Discount amount in cents
Example:
3400
Credit amount in cents
Example:
1500
Externally paid amount in cents
Example:
24000
Commercial amount in cents
Example:
25500
Checkout session identifier
Example:
"01981255-3c7a-7bd4-bb5f-8b47bc4dce91"
Created by
Example:
"0197a805-0910-7eb2-bae7-90a13df2a9b2"
Updated by
Example:
"0197a805-0910-7eb2-bae7-90a13df2a9b2"
Show child attributes
Show child attributes