Payment Links & Checkout
Gere um link de pagamento e use em qualquer lugar, sem código.
Payment Links & Checkout
Se você não quer chamar a API, o jeito mais rápido de vender é com um link de pagamento: você cria no painel e usa a URL onde quiser — botão no Typebot, bio do Instagram, WhatsApp, e-mail.
Criar um link
No painel, em Links de Pagamento, crie um link informando (principais campos):
description— nome/descrição.currency— moeda (ex.:BRL).amount— valor (opcional; também dá pra ter opções de valor).expiresAt,maxPayments,maxPerEmail— limites opcionais.
O link gerado tem o formato:
https://seu-dominio-de-checkout/checkout/link-<hash>
Abra essa URL e você tem um checkout hospedado completo (PIX e cartão) — é essa URL que você cola no Typebot, na bio, etc.
Criando por API? Ao chamar
POST /api/v1/payment-links, use sempre o campourlque a resposta devolve — ele já vem no domínio próprio do seller. Não monte a URL na mão. Se o seller tiver mais de um domínio, informe qual usar no campo opcionalcheckoutDomain(liste os domínios emGET /api/v1/payment-links/available-domains).
Checkout hospedado (comprador)
O comprador abre o link, preenche os dados e paga (PIX ou cartão). Endpoints públicos envolvidos (o front do checkout já usa por você):
| Método | Endpoint | Pra quê |
|---|---|---|
GET | /api/v1/payment-links/{hash} | Carrega os dados do link (público). |
POST | /api/v1/payments | Processa o pagamento do link. |
GET | /api/v1/public/checkout/{slug}/{productId} | Dados de checkout de um produto da loja. |
POST | /api/v1/public/checkout/process | Processa o pagamento do checkout de produto. |
Métodos e status
- Métodos: PIX e cartão.
- O PIX retorna um
qrCode(copia-e-cola) e o status viraFINISHEDquando pago; o cartão retorna umclient_secretpara finalizar.
Para ser notificado quando o link for pago, configure um Webhook — você pode inclusive filtrar por
paymentLinkIds.
Domínio próprio (obrigatório)
O checkout do link é servido exclusivamente no domínio próprio da loja (ex.: sualoja.com.br), nunca no domínio da plataforma. Por isso:
- O seller precisa ter um domínio próprio ativo para publicar links. Conecte em Domínio Personalizado (verificação de DNS + SSL automático).
- Sem domínio ativo, o link não é publicável e o checkout é bloqueado no domínio da plataforma.
- Acessos ao link por um domínio que não seja o da loja são bloqueados (o checkout não existe fora do domínio próprio).
Isso vale para links de pagamento (checkout hospedado). Se você integra por cobrança direta (
POST /api/v1/direct/payment) e usa seu próprio checkout, não precisa de domínio próprio — o comprador nunca sai do seu site.
Updated about 1 month ago

