Skip to main content
GET
Buscar checkout link
GET /checkout/links/{id} Faz parte do recurso Links — o conceito e os estados estão lá. Devolve o Link inteiro, no mesmo formato da resposta da criação: items, paymentMethods, splits e branding vêm aninhados dentro de config, e os demais campos no topo. É por aqui que se relê a configuração para espelhá-la numa venda rápida.
Aqui só o chk_ funciona — o slug não. O slug vale na URL pública (/c/{slug}), que é onde o comprador entra; nesta rota, buscar pelo slug responde 404. Guarde o chk_ ao criar o Link.
Link arquivado continua sendo devolvido, com status: "archived". Arquivar muda o estado, não apaga — é o que permite reler a configuração de um Link que saiu do ar.

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 do CheckoutLink

Response

Link encontrado

id
string

Identificador único do registro.

slug
string | null

Slug único global usado na URL pública /c/{slug}.

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).

name
string | null

Nome de exibição do registro.

description
string | null

Descrição exibida no checkout.

sellable
boolean

Se o Link pode vender agora. É false quando um recebedor do splits, ou o dono da conta, não está ativo no PSP — o comprador vê uma página de indisponível. Independente do status.

config
object

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

requiredFields
string[] | null

Campos do comprador exigidos no checkout (ex.: email, document, phone, address).

customFields
object[] | null

Definições dos campos personalizados solicitados no checkout.

successUrl
string | null

URL de redirecionamento após o pagamento ser concluído com sucesso.

cancelUrl
string | null

URL de redirecionamento quando o comprador cancela o checkout.

metadata
object | null

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

expirationMinutes
integer | null

Tempo de validade da sessão de checkout, em minutos.

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).

url
string

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