GET /api/v1/checkouts/:id - Chargefy

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

string

required

ID único do checkout

Resposta

Campo	Tipo	Descrição
`id`	`string`	ID único do checkout
`status`	`string`	Status: `open`, `confirmed`, `succeeded`, `expired`, `failed`
`client_secret`	`string`	Secret para uso no frontend
`product_price_id`	`string`	ID do preço do produto
`amount`	`integer`	Valor em centavos
`currency`	`string`	Moeda (ex: `BRL`)
`customer_email`	`string`	Email do cliente
`customer_id`	`string`	ID do cliente (se associado)
`payment_method`	`string`	Metodo de pagamento utilizado
`success_url`	`string`	URL de sucesso
`metadata`	`object`	Metadados personalizados
`created_at`	`string`	Data/hora de criação
`updated_at`	`string`	Data/hora da última atualização
`expires_at`	`string`	Data/hora de expiração

Exemplo

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

import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const checkout = await chargefy.checkouts.get('chk_1a2b3c4d5e6f');

Resposta de Exemplo

{
  "id": "chk_1a2b3c4d5e6f",
  "status": "open",
  "client_secret": "chk_secret_xyz789",
  "product_price_id": "pp_abc123",
  "amount": 9900,
  "currency": "BRL",
  "customer_email": "cliente@exemplo.com",
  "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"
}