Skip to main content
GET
Listar sessions
GET /checkout/sessions Faz parte do recurso Links — o que é uma Session e os estados dela estão lá. Devolve todas as suas Sessions, da mais recente para a mais antiga, em páginas de 20 por padrão (máximo 100). Os filtros são opcionais e se somam. As Sessions de Link e as de venda rápida aparecem misturadas — o que as distingue é o linkId, que vem preenchido nas primeiras e null nas segundas.
Para ver só as vendas rápidas, use a listagem delas. GET /checkout/charges é a mesma Session com o filtro já aplicado. Aqui, ?linkId=chk_... faz o contrário: restringe às Sessions de um template específico.
status aceita mais de um valor, separados por vírgula: ?status=paid,opened. Um valor fora da lista responde 400 com os aceitos.

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

Query Parameters

page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100

Apenas as compras geradas por este Link (chk_). Correspondência exata. Omitido, traz também as vendas rápidas.

status
enum<string>[]

Situação da compra. Aceita vários valores, separados por vírgula ou repetindo o parâmetro. Um valor inválido responde 400 com a lista dos aceitos.

Available options:
created,
opened,
filling,
paying,
partially_paid,
paid,
failed,
abandoned,
expired,
canceled

Response

Lista paginada

data
object[]

Lista de registros retornados nesta página.

pagination
object

Metadados de paginação do resultado (página, limite e totais).