Skip to main content
Recupera as informações completas de uma sessão de checkout, incluindo status, valores e dados do cliente.

​
Autenticação

Requer Organization Access Token (OAT) via header Authorization: Bearer.

​
Parâmetros de Path

​
id
string
required
ID único do checkout

​
Resposta

CampoTipoDescrição
idstringID único do checkout
statusstringStatus: open, confirmed, succeeded, expired, failed
client_secretstringSecret para uso no frontend
product_price_idstringID do preço do produto
amountintegerValor em centavos
currencystringMoeda (ex: BRL)
customer_emailstringEmail do cliente
customer_idstringID do cliente (se associado)
payment_methodstringMetodo de pagamento utilizado
success_urlstringURL de sucesso
metadataobjectMetadados personalizados
created_atstringData/hora de criação
updated_atstringData/hora da última atualização
expires_atstringData/hora de expiração

​
Exemplo

curl -X GET https://api.chargefy.io/api/v1/checkouts/chk_1a2b3c4d5e6f \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​
Resposta de Exemplo

{
  "id": "chk_1a2b3c4d5e6f",
  "status": "open",
  "client_secret": "chk_secret_xyz789",
  "product_price_id": "pp_abc123",
  "amount": 9900,
  "currency": "BRL",
  "customer_email": "[email protected]",
  "customer_id": "cus_def456",
  "payment_method": null,
  "success_url": "https://meusite.com/sucesso",
  "metadata": {},
  "created_at": "2026-03-12T10:00:00Z",
  "updated_at": "2026-03-12T10:00:00Z",
  "expires_at": "2026-03-12T10:30:00Z"
}