Skip to main content
GET
/
api
/
checkout
/
sessions
Listar Checkout Sessions
curl --request GET \
  --url https://garu.com.br/api/checkout/sessions \
  --header 'Authorization: Bearer <token>'
{
  "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

​
page
integer
default:"1"
Número da página
​
limit
integer
default:"10"
Itens por página (máx 100)
​
status
string
Filtrar por status: open, complete ou expired

​
Exemplo 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"

​
Resposta de Sucesso

​
data
array
Lista de checkout sessions
​
count
integer
Número de sessions na página atual
​
total_count
integer
Total de sessions (considerando filtros)
​
total_pages
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

StatusDescrição
openSession ativa, aguardando pagamento
completePagamento bem-sucedido, transação criada
expiredSession expirou antes do pagamento

​
Erros Comuns

{
  "statusCode": 401,
  "message": "Unauthorized"
}
Solução: Verifique se o header Authorization está correto.
{
  "statusCode": 429,
  "message": "Too Many Requests"
}
Solução: Aguarde antes de fazer novas requisições. Limite: 100 requisições por minuto.

​
Próximos Passos

Detalhes da Session

Consulte uma session específica

Criar Session

Crie novas checkout sessions