Skip to main content
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>'
{
  "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

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

​
Resposta de Sucesso

​
id
string
Identificador único da session
​
status
string
Status da session: open, complete ou expired
​
url
string
URL do checkout
​
product_id
integer
ID do produto
​
price_id
string
ID do preço de assinatura (se aplicável)
​
customer_email
string
Email do cliente
​
customer_name
string
Nome do cliente
​
metadata
object
Metadados personalizados
​
success_url
string
URL de redirecionamento de sucesso
​
cancel_url
string
URL de redirecionamento de cancelamento
​
client_reference_id
string
ID de referência do cliente
​
affiliate_id
integer
ID do afiliado
​
transaction_id
integer
ID da transação (preenchido quando status = complete)
​
expires_at
string
Data de expiração (ISO 8601)
​
completed_at
string
Data de conclusão (ISO 8601)
​
created_at
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

{
  "statusCode": 401,
  "message": "Unauthorized"
}
Solução: Verifique se o header Authorization está correto.
{
  "statusCode": 404,
  "message": "Checkout session not found"
}
Solução: Verifique se o ID da session está correto e pertence ao seu vendedor.

​
Próximos Passos

Expirar Session

Expire manualmente uma session

Listar Sessions

Consulte todas as suas sessions