Detalhes da Checkout Session
curl --request GET \
--url https://garu.com.br/api/checkout/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://garu.com.br/api/checkout/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://garu.com.br/api/checkout/sessions/{id}', 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://garu.com.br/api/checkout/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://garu.com.br/api/checkout/sessions/{id}"
req, _ := http.NewRequest("GET", 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.get("https://garu.com.br/api/checkout/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/checkout/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"url": "<string>",
"product_id": 123,
"price_id": "<string>",
"customer_email": "<string>",
"customer_name": "<string>",
"metadata": {},
"success_url": "<string>",
"cancel_url": "<string>",
"client_reference_id": "<string>",
"affiliate_id": 123,
"transaction_id": 123,
"expires_at": "<string>",
"completed_at": "<string>",
"created_at": "<string>"
}Checkout Sessions
Detalhes da Checkout Session
Consulte os detalhes de uma checkout session específica
GET
/
api
/
checkout
/
sessions
/
{id}
Detalhes da Checkout Session
curl --request GET \
--url https://garu.com.br/api/checkout/sessions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://garu.com.br/api/checkout/sessions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://garu.com.br/api/checkout/sessions/{id}', 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://garu.com.br/api/checkout/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://garu.com.br/api/checkout/sessions/{id}"
req, _ := http.NewRequest("GET", 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.get("https://garu.com.br/api/checkout/sessions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/checkout/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"url": "<string>",
"product_id": 123,
"price_id": "<string>",
"customer_email": "<string>",
"customer_name": "<string>",
"metadata": {},
"success_url": "<string>",
"cancel_url": "<string>",
"client_reference_id": "<string>",
"affiliate_id": 123,
"transaction_id": 123,
"expires_at": "<string>",
"completed_at": "<string>",
"created_at": "<string>"
}Visão Geral
Retorna os detalhes completos de uma checkout session específica.Parâmetros de Path
string
required
ID da session (ex:
cs_ABC123xyz)Exemplo de Requisição
curl -X GET "https://api.garu.com.br/api/checkout/sessions/cs_ABC123xyz" \
-H "Authorization: Bearer sk_test_sua_chave_api"
const sessionId = 'cs_ABC123xyz';
const response = await fetch(
'https://api.garu.com.br/api/checkout/sessions/' + sessionId,
{
headers: {
'Authorization': 'Bearer ' + process.env.GARU_API_KEY
}
}
);
const result = await response.json();
console.log('Status:', result.data.status);
console.log('Transaction ID:', result.data.transaction_id);
import requests
import os
session_id = 'cs_ABC123xyz'
response = requests.get(
'https://api.garu.com.br/api/checkout/sessions/' + session_id,
headers={'Authorization': 'Bearer ' + os.environ['GARU_API_KEY']}
)
data = response.json()['data']
print('Status:', data['status'])
print('Transaction ID:', data['transaction_id'])
Resposta de Sucesso
string
Identificador único da session
string
Status da session:
open, complete ou expiredstring
URL do checkout
integer
ID do produto
string
ID do preço de assinatura (se aplicável)
string
Email do cliente
string
Nome do cliente
object
Metadados personalizados
string
URL de redirecionamento de sucesso
string
URL de redirecionamento de cancelamento
string
ID de referência do cliente
integer
ID do afiliado
integer
ID da transação (preenchido quando
status = complete)string
Data de expiração (ISO 8601)
string
Data de conclusão (ISO 8601)
string
Data de criação (ISO 8601)
Exemplo de Resposta (200 OK)
{
"data": {
"id": "cs_ABC123xyz",
"status": "complete",
"url": "https://pay.garu.com.br/pay/session/abc123...",
"product_id": 123,
"price_id": null,
"customer_email": "joao@email.com",
"customer_name": "João Silva",
"metadata": {
"order_id": "12345"
},
"success_url": "https://seusite.com/sucesso?session_id={SESSION_ID}",
"cancel_url": "https://seusite.com/cancelado",
"client_reference_id": "order_abc123",
"affiliate_id": null,
"transaction_id": 789,
"expires_at": "2025-01-20T12:00:00.000Z",
"completed_at": "2025-01-19T14:30:00.000Z",
"created_at": "2025-01-19T12:00:00.000Z"
}
}
Erros Comuns
401 - Não autorizado
401 - Não autorizado
{
"statusCode": 401,
"message": "Unauthorized"
}
Authorization está correto.404 - Session não encontrada
404 - Session não encontrada
{
"statusCode": 404,
"message": "Checkout session not found"
}
Próximos Passos
Expirar Session
Expire manualmente uma session
Listar Sessions
Consulte todas as suas sessions
Was this page helpful?