Parâmetros de Caminho
string
required
Segredo do checkout link. Disponível no campo
client_secret do objeto retornado ao criar ou buscar um link.Parâmetros de Query
string
Origem para checkout incorporado (embedded). Quando informado, é preservado na URL de redirecionamento e também adicionado à sessão de checkout.
string
ID de referência externa. Adicionado aos metadados da sessão de checkout criada.
string
Parâmetro UTM de origem da campanha. Adicionado aos metadados da sessão.
string
Parâmetro UTM de meio da campanha.
string
Parâmetro UTM de termo da campanha.
string
Parâmetro UTM de conteúdo da campanha.
Comportamento
- Busca o checkout link pelo
client_secret - Obtém o primeiro produto e seu preço disponível
- Cria uma nova sessão de checkout com os parâmetros do link (desconto,
success_url,require_billing_address,no_fees_installments, preço customizado) - Mescla os query params recebidos nos metadados da sessão
- Retorna
302 Foundredirecionando para a URL do checkout
Cache-Control: no-store para evitar cache de redirecionamentos no browser e em CDNs.
Resposta
Exemplo
cURL
Use a URL do campo
url retornado ao criar o checkout link — ela já aponta para este endpoint com o client_secret correto. Ideal para compartilhar em campanhas de marketing, emails e redes sociais.
