Skip to main content
GET
Buscar session
GET /checkout/sessions/{id} Faz parte do recurso Links — o que é uma Session e os estados dela estão lá. Devolve a Session com o snapshot congelado na criação: itens, amount, métodos e branding, mais o customer até onde o comprador preencheu, o metadata que você gravou e o transactionId.
transactionId só existe a partir de paying. Antes disso a compra ainda não virou transação, e o campo vem null. É por ele que se puxam os detalhes de processamento em GET /transactions/{id} — e, no sentido inverso, o referenceCode da transação é o próprio cs_. Veja Reconciliação.
Session de venda rápida também é encontrada aqui. O que muda é o linkId, que vem null quando não houve template.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API key unificada (z2_{live|test}{sk|pk}...) — secret (sk) para integração backend, publishable (pk) para uso no frontend público

Path Parameters

id
string
required

ID da Session (cs_*)

Response

Session encontrada

id
string

Identificador único do registro.

Identificador do link de checkout que originou o registro; nulo em sessões ad-hoc.

status
string

Estado atual do registro.

mode
string

Modo do checkout: 'payment' (pagamento único) ou 'subscription' (assinatura).

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

locale
string

Idioma do checkout (ex.: pt-BR, en-US, es-ES).

config
object

Snapshot da configuração do checkout (formas de pagamento, itens e personalização visual).

customer
object | null

Dados do comprador (nome, e-mail, documento e demais informações).

customFieldValues
object | null

Valores preenchidos nos campos personalizados, indexados pela key de cada campo.

paymentMethodSelected
string | null

Forma de pagamento selecionada pelo comprador na sessão (ex.: credit_card, pix, boleto).

subtotal
integer

Soma dos itens antes dos descontos, em centavos.

discountTotal
integer

Total de descontos aplicados, em centavos.

amount
integer

Valor total a ser cobrado, em centavos.

discounts
object[] | null

Descontos aplicados ao valor da sessão.

paymentAttempts
integer

Quantidade de tentativas de pagamento realizadas na sessão.

transactionId
string | null

Identificador da transação gerada pelo pagamento da sessão; nulo até haver pagamento.

subscriptionId
string | null

Identificador da assinatura criada a partir da sessão; nulo até a ativação.

metadata
object | null

Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).

openedAt
string<date-time> | null

Data e hora em que a sessão foi aberta pelo comprador (ISO 8601); nula se ainda não aberta.

paidAt
string<date-time> | null

Data e hora em que o pagamento foi confirmado (ISO 8601); nula se não pago.

canceledAt
string<date-time> | null

Data e hora do cancelamento (ISO 8601); nula se não cancelado.

expiresAt
string<date-time>

Data e hora de expiração (ISO 8601).

url
string

URL pública do checkout para o comprador finalizar o pagamento.