Buscar checkout link
Retorna a configuração completa de um template, com itens, métodos, splits e branding.
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.
status: "archived". Arquivar muda o estado, não
apaga — é o que permite reler a configuração de um Link que saiu do ar.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 do CheckoutLink
Response
Link encontrado
Identificador único do registro.
Slug único global usado na URL pública /c/{slug}.
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).
Nome de exibição do registro.
Descrição exibida no checkout.
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.
Snapshot da configuração do checkout (formas de pagamento, itens e personalização visual).
Campos do comprador exigidos no checkout (ex.: email, document, phone, address).
Definições dos campos personalizados solicitados no checkout.
URL de redirecionamento após o pagamento ser concluído com sucesso.
URL de redirecionamento quando o comprador cancela o checkout.
Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.
Tempo de validade da sessão de checkout, em minutos.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
URL pública do checkout para o comprador finalizar o pagamento.