Listar Checkout Sessions
curl --request GET \
--url https://garu.com.br/api/checkout/sessions \
--header 'Authorization: Bearer <token>'import requests
url = "https://garu.com.br/api/checkout/sessions"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/checkout/sessions")
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{
"data": [
{}
],
"count": 123,
"total_count": 123,
"total_pages": 123
}Checkout Sessions
Listar Checkout Sessions
Consulte suas checkout sessions com paginação e filtros
GET
/
api
/
checkout
/
sessions
Listar Checkout Sessions
curl --request GET \
--url https://garu.com.br/api/checkout/sessions \
--header 'Authorization: Bearer <token>'import requests
url = "https://garu.com.br/api/checkout/sessions"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/checkout/sessions")
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{
"data": [
{}
],
"count": 123,
"total_count": 123,
"total_pages": 123
}Visão Geral
Retorna uma lista paginada de todas as suas checkout sessions, com opção de filtrar por status.Parâmetros de Query
integer
default:"1"
Número da página
integer
default:"10"
Itens por página (máx 100)
string
Filtrar por status:
open, complete ou expiredExemplo de Requisição
curl -X GET "https://api.garu.com.br/api/checkout/sessions?page=1&limit=10&status=complete" \
-H "Authorization: Bearer sk_test_sua_chave_api"
const params = new URLSearchParams({
page: '1',
limit: '10',
status: 'complete'
});
const response = await fetch(
'https://api.garu.com.br/api/checkout/sessions?' + params,
{
headers: {
'Authorization': 'Bearer ' + process.env.GARU_API_KEY
}
}
);
const result = await response.json();
console.log('Total de sessions:', result.total_count);
import requests
import os
response = requests.get(
'https://api.garu.com.br/api/checkout/sessions',
headers={'Authorization': 'Bearer ' + os.environ['GARU_API_KEY']},
params={
'page': 1,
'limit': 10,
'status': 'complete'
}
)
result = response.json()
print('Total de sessions:', result['total_count'])
Resposta de Sucesso
array
Lista de checkout sessions
integer
Número de sessions na página atual
integer
Total de sessions (considerando filtros)
integer
Total de páginas
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"
},
"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"
}
],
"count": 1,
"total_count": 150,
"total_pages": 15
}
Status de Session
| Status | Descrição |
|---|---|
open | Session ativa, aguardando pagamento |
complete | Pagamento bem-sucedido, transação criada |
expired | Session expirou antes do pagamento |
Erros Comuns
401 - Não autorizado
401 - Não autorizado
{
"statusCode": 401,
"message": "Unauthorized"
}
Authorization está correto.429 - Rate limit excedido
429 - Rate limit excedido
{
"statusCode": 429,
"message": "Too Many Requests"
}
Próximos Passos
Detalhes da Session
Consulte uma session específica
Criar Session
Crie novas checkout sessions
Was this page helpful?