Buscar session
Retorna uma compra pelo cs_ — estado, valor congelado, dados do comprador e a transação ligada.
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.linkId, que vem null
quando não houve template.Exemplo
Authorizations
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 da Session (cs_*)
Response
Session encontrada
Identificador único do registro.
Identificador do link de checkout que originou o registro; nulo em sessões ad-hoc.
Estado atual do registro.
Modo do checkout: 'payment' (pagamento único) ou 'subscription' (assinatura).
Moeda no padrão ISO 4217 (ex.: BRL).
Idioma do checkout (ex.: pt-BR, en-US, es-ES).
Snapshot da configuração do checkout (formas de pagamento, itens e personalização visual).
Dados do comprador (nome, e-mail, documento e demais informações).
Valores preenchidos nos campos personalizados, indexados pela key de cada campo.
Forma de pagamento selecionada pelo comprador na sessão (ex.: credit_card, pix, boleto).
Soma dos itens antes dos descontos, em centavos.
Total de descontos aplicados, em centavos.
Valor total a ser cobrado, em centavos.
Descontos aplicados ao valor da sessão.
Quantidade de tentativas de pagamento realizadas na sessão.
Identificador da transação gerada pelo pagamento da sessão; nulo até haver pagamento.
Identificador da assinatura criada a partir da sessão; nulo até a ativação.
Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
Data e hora em que a sessão foi aberta pelo comprador (ISO 8601); nula se ainda não aberta.
Data e hora em que o pagamento foi confirmado (ISO 8601); nula se não pago.
Data e hora do cancelamento (ISO 8601); nula se não cancelado.
Data e hora de expiração (ISO 8601).
URL pública do checkout para o comprador finalizar o pagamento.