Parâmetros de Caminho
Segredo do checkout link. Disponível no campo
client_secret do objeto retornado ao criar ou buscar um link.Parâmetros de Query
Origem para checkout incorporado (embedded). Quando informado, é preservado na URL de redirecionamento e também adicionado à sessão de checkout.
ID de referência externa. Adicionado aos metadados da sessão de checkout criada.
Parâmetro UTM de origem da campanha. Adicionado aos metadados da sessão.
Parâmetro UTM de meio da campanha.
Parâmetro UTM de termo da campanha.
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
| Status | Descrição |
|---|---|
302 Found | Redirecionamento bem-sucedido para a página de checkout |
400 Bad Request | client_secret ausente |
404 Not Found | Checkout link não encontrado |
422 Unprocessable Entity | Link sem produtos ou produto sem preço disponível |
500 Internal Server Error | Erro ao criar a sessão de checkout |
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.
