Obter uma sessão de checkout

Consulta feita pelo seu servidor ou painel administrativo, com API key de escopo read. O browser do comprador nunca chama esta rota: a página hospedada carrega e acompanha a sessão sozinha, autorizada pelo próprio id que viaja em url. Retorna o objeto checkout.session completo pelo ID da sessão. A API key da própria organização atua diretamente. A API key de plataforma exige o header Organization: <id> apontando para uma organização conectada ativa.

Parâmetros de caminho

string

obrigatório

ID da checkout session (cs_*).

curl -X GET "https://api.chargefy.io/v1/checkout-sessions/cs_Wwz6A9P364XFq31K" \
  -H "Authorization: Bearer {{API_KEY}}"

Resposta

Retorna o mesmo DTO de POST /v1/checkout-sessions. O campo payment_data fica null antes da confirmação e aparece preenchido quando a sessão já foi confirmada.

{
  "id": "cs_Wwz6A9P364XFq31K",
  "object": "checkout.session",
  "allow_discount_codes": false,
  "amount_discount": 0,
  "amount_subtotal": 19990,
  "amount_tax": 0,
  "amount_total": 19990,
  "cancel_url": "https://meusite.com/cancelado",
  "checkout_experience": {
    "banner": null,
    "confirmation_message": null,
    "cover_image_url": null,
    "footer_expanded": false,
    "funnel": null,
    "header_shows_logo": true,
    "header_shows_name": true,
    "installment_teaser_mode": "maximum_installment",
    "order_summary_mode": "expanded",
    "product_description": null,
    "product_description_mode": "summary",
    "product_image_mode": "thumbnail",
    "product_subtitle_source": "description",
    "require_billing_address": false,
    "require_document": true,
    "require_phone": false,
    "show_compare_at_amount": false,
    "summary_style": "product",
    "tracking": {
      "destinations": [],
      "mode": "inherit"
    }
  },
  "client_reference_id": null,
  "client_secret": null,
  "composition_revision": 0,
  "created_at": "2026-05-19T18:31:00Z",
  "currency": "brl",
  "customer": "cus_AqS7dhPduv5PuKqf",
  "customer_document": "12345678901",
  "customer_document_type": "cpf",
  "customer_email": "[email protected]",
  "customer_name": "Cliente Exemplo",
  "discount": null,
  "expires_at": "2026-05-20T18:31:00Z",
  "has_surcharge": false,
  "invoice_creation": false,
  "line_items": [
    {
      "id": "li_v3zoBS78P8fgfK6x",
      "adjustable_quantity": {
        "enabled": false,
        "maximum": null,
        "minimum": null
      },
      "amount_discount": 0,
      "amount_subtotal": 19990,
      "amount_tax": 0,
      "amount_total": 19990,
      "currency": "brl",
      "description": "Plano Pro mensal",
      "metadata": {},
      "optional_item": null,
      "position": 0,
      "price": "price_L5yEaLBX4FvkcVrX",
      "price_data": null,
      "product": "prod_ciM8ubnYU2T9DkUP",
      "quantity": 1,
      "recurring_interval": null,
      "recurring_interval_count": null,
      "role": "main",
      "unit_amount": 19990
    }
  ],
  "livemode": true,
  "marketing_attribution": null,
  "metadata": {},
  "mode": "payment",
  "optional_items": [],
  "payment_data": null,
  "payment_intent": null,
  "payment_method_collection": "always",
  "payment_method_options": {
    "credit_card": {
      "installments": {
        "interest_payer": "buyer",
        "max_count": 12
      }
    }
  },
  "payment_method_types": [
    "credit_card",
    "pix"
  ],
  "payment_status": "unpaid",
  "status": "open",
  "submit_type": "auto",
  "subscription": null,
  "success_url": "https://meusite.com/sucesso",
  "template": "split",
  "ui_mode": "hosted",
  "url": "https://pay.chargefy.io/session/cs_Wwz6A9P364XFq31K"
}

Para Pix e boleto, status: "complete" significa que o comprador submeteu o formulário, não que o pagamento foi compensado. Acompanhe payment_status (unpaid -> paid) ou ouça o webhook checkout.session.async.payment.succeeded.

Erros

HTTP	Razão
401	API key ausente, mal formada ou inválida
403	API key de plataforma sem `Organization`, ou `Organization` sem vínculo ativo
404	Checkout session não encontrada

404

{
  "error": {
    "code": "resource_missing",
    "message": "Checkout session not found",
    "type": "invalid_request_error"
  }
}

401

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API Key provided: ch_live_***************************************9f2c",
    "type": "authentication_error"
  }
}

Fundamentos da API

MCP

Objetos de sistema

Webhooks e eventos

SDKs

Obter uma sessão de checkout

Parâmetros de caminho

Resposta

Erros

​Parâmetros de caminho

​Resposta

​Erros

Parâmetros de caminho

Resposta

Erros