Requer escopo
links:write para criar/editar e links:read para consultar.Criar rascunho
EnviePOST /v1/payment-links com Idempotency-Key obrigatorio. A criacao gera um rascunho (draft); nao publica uma URL de pagamento nem emite uma cobranca.
curl
Publicar ou desativar um link
UsePATCH /v1/payment-links/{id} para alterar o status ou editar dados.
curl
URL publica
Apos publicar, o link fica disponivel em:slug e retornado nos dados do link e segue o padrao ^[a-f0-9]{32}$.
Fluxo de checkout publico
O checkout publico e feito sem chave de API. O pagador acessa o link, o frontend consulta os dados publicos e cria a intencao de pagamento.1
Consultar dados publicos do link
O frontend chama A resposta inclui
GET /public/payment-links/{slug} para obter titulo, descricao, valor e version.curl
version (hash de 64 caracteres hex), necessario no proximo passo.2
Criar ou recuperar Pix do checkout
Envie Se o link foi alterado desde a consulta, a API retorna erro
POST /public/payment-links/{slug}/checkout com:- Header
If-Matchcontendo aversionconsultada. - Header
Idempotency-Keypara identificar a compra. - Corpo vazio
{}.
curl
LINK_CHANGED (HTTP 428). Atualize os dados e repita.3
Guardar checkoutToken
A resposta do checkout devolve
checkoutToken (43 caracteres). Guarde-o de forma segura e nao o inclua na URL.4
Acompanhar situacao da compra
Use A consulta funciona mesmo se o link for desativado posteriormente.
GET /public/payment-links/{slug}/checkouts/{id} com header X-Checkout-Token para consultar o status do Pix.curl
A repeticao idempotente pode recuperar a intencao original apos edicao ou desativacao do link.