Expirar Checkout Session
curl --request POST \
--url https://garu.com.br/api/checkout/sessions/{id}/expire \
--header 'Authorization: Bearer <token>'import requests
url = "https://garu.com.br/api/checkout/sessions/{id}/expire"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://garu.com.br/api/checkout/sessions/{id}/expire', 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}/expire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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}/expire"
req, _ := http.NewRequest("POST", 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.post("https://garu.com.br/api/checkout/sessions/{id}/expire")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/checkout/sessions/{id}/expire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyCheckout Sessions
Expirar Checkout Session
Expire manualmente uma checkout session aberta
POST
/
api
/
checkout
/
sessions
/
{id}
/
expire
Expirar Checkout Session
curl --request POST \
--url https://garu.com.br/api/checkout/sessions/{id}/expire \
--header 'Authorization: Bearer <token>'import requests
url = "https://garu.com.br/api/checkout/sessions/{id}/expire"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://garu.com.br/api/checkout/sessions/{id}/expire', 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}/expire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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}/expire"
req, _ := http.NewRequest("POST", 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.post("https://garu.com.br/api/checkout/sessions/{id}/expire")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/checkout/sessions/{id}/expire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyVisão Geral
Expira manualmente uma checkout session que ainda está aberta. Útil quando o pedido foi cancelado no seu sistema ou você precisa invalidar a session.Sessions expiram automaticamente após 24 horas por padrão. Use este endpoint apenas quando precisar expirar antes desse prazo.
Parâmetros de Path
string
required
ID da session a ser expirada (ex:
cs_ABC123xyz)Exemplo de Requisição
curl -X POST "https://api.garu.com.br/api/checkout/sessions/cs_ABC123xyz/expire" \
-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 + '/expire',
{
method: 'POST',
headers: {
'Authorization': 'Bearer ' + process.env.GARU_API_KEY
}
}
);
const result = await response.json();
console.log('Session expirada:', result.data.status); // 'expired'
import requests
import os
session_id = 'cs_ABC123xyz'
response = requests.post(
'https://api.garu.com.br/api/checkout/sessions/' + session_id + '/expire',
headers={'Authorization': 'Bearer ' + os.environ['GARU_API_KEY']}
)
data = response.json()['data']
print('Session expirada:', data['status']) # 'expired'
Resposta de Sucesso
Retorna a session atualizada comstatus: "expired".
Exemplo de Resposta (200 OK)
{
"data": {
"id": "cs_ABC123xyz",
"status": "expired",
"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",
"cancel_url": "https://seusite.com/cancelado",
"client_reference_id": "order_abc123",
"affiliate_id": null,
"transaction_id": null,
"expires_at": "2025-01-19T15:00:00.000Z",
"completed_at": null,
"created_at": "2025-01-19T12:00:00.000Z"
}
}
Webhook de Expiração
Quando uma session é expirada, um webhook é enviado para seu endpoint configurado:{
"event": "checkout.session.expired",
"data": {
"id": "cs_ABC123xyz",
"status": "expired",
"product_id": 123,
"metadata": {
"order_id": "12345"
},
"client_reference_id": "order_abc123",
"expires_at": "2025-01-19T15:00:00.000Z"
},
"created_at": "2025-01-19T15:00:01.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"
}
409 - Session não pode ser expirada
409 - Session não pode ser expirada
{
"statusCode": 409,
"message": "Session cannot be expired"
}
complete ou expired. Apenas sessions com status open podem ser expiradas.Próximos Passos
Criar Session
Crie uma nova checkout session
Webhooks
Configure notificações de expiração
Was this page helpful?