Skip to main content
POST
Criar Link de Pagamento
Cria um link de pagamento — uma URL própria onde o comprador paga (Pix, boleto ou cartão). O link nasce escopado ao lojista da sua chave de API; você não envia merchant_id. A resposta traz a url para compartilhar. Veja o guia em Links de Pagamento.

Parâmetros

string
required
Título do link (aparece no checkout). Máx. 255 caracteres.
string
required
fixed (valor fixo — envie amount) ou customer_defined (o comprador digita o valor).
integer
Valor em centavos. Obrigatório quando amount_type = fixed. Mínimo 500 (R$ 5,00).
array
required
Métodos aceitos (mínimo 1): pix, credit_card, debit_card, bank_slip.
string
Descrição opcional exibida no checkout.
integer
Máximo de parcelas no cartão (1 a 12).
string
none (sem juros) ou installments (juros por parcela, conforme a tabela do lojista).
integer
Até quantas parcelas ficam sem juros (1 a 12).
boolean
Captura automática do cartão. Padrão: true.
integer
Validade do boleto em dias (1 a 60).
integer
Validade do QR Pix em minutos (5 a 1440).
string
Data/hora de expiração do link (ISO 8601, no futuro). Depois disso o link não paga mais.
integer
Número máximo de pagamentos aceitos pelo link. Atingido o limite, o link deixa de ser pagável.
boolean
Coletar o telefone do comprador no checkout.
boolean
Exigir endereço do comprador. É forçado para true quando bank_slip está entre os métodos.
string
Texto que aparece na fatura do cartão do comprador. Máx. 22 caracteres.
string
URL de webhook específica deste link (além dos webhooks globais). Deve ser HTTPS e pública.
boolean
Enviar recibo por e-mail ao comprador quando o pagamento for aprovado.
string
URL do logo exibido no checkout. Máx. 255 caracteres.
string
Cor de destaque do checkout (hex). Máx. 9 caracteres.
string
Transforma o link numa assinatura. Presente = todo pagamento pelo link cria uma assinatura recorrente (cartão, valor fixo).Valores: monthly, quarterly, half-yearly, yearly.Exige amount_type: "fixed" (link recorrente tem valor fixo).
integer
Dias de teste grátis antes da primeira cobrança da assinatura. Mínimo: 1 | Máximo: 365.
O link recorrente é o jeito mais simples de vender assinatura: sem produto, sem cadastro prévio de cliente. Para uma régua de preços (valores diferentes por ciclo), use uma oferta recorrente em vez do link.

Resposta

Compartilhe o campo url com o comprador. O checkout é público (resolvido pelo hash do link) — não exige a chave de API.