Referência

Links de pagamento

Links com valor fixo ou aberto, limite de usos e validade.

Exige o produto LINK ativo para a empresa em Produção. No Sandbox basta não estar desativado.

GET/v1/payment-links

Lista links

Escopo checkout.manage

Parâmetros de consulta

page

inteiroPágina (começa em 1).

pageSize

inteiro ≤ 200Itens por página (padrão 25).

POST/v1/payment-links

Cria link

Escopo checkout.manage

Corpo (JSON)

titleobrigatório

stringTítulo exibido.

amount

centavosValor fixo. Vazio = pagador informa (respeitando minAmount).

minAmount

centavosMínimo quando o valor é aberto.

methodsobrigatório

listaMétodos aceitos.

maxInstallments

inteiro 1–12Parcelas no cartão.

maxUses / quantity

inteiroLimite de pagamentos / quantidade.

slug

stringEndereço amigável.

expiresAt

ISO 8601Validade.

GET/v1/payment-links/:id

Consulta link

Escopo checkout.manage

PATCH/v1/payment-links/:id

Atualiza link (inclui status)

Escopo checkout.manage

DELETE/v1/payment-links/:id

Arquiva link

Escopo checkout.manage

GET/v1/payment-links/:id/stats

Visitas, conversão e volume

Escopo checkout.manage