Criar Link de Pagamento
Links de Pagamento
Criar Link de Pagamento
Cria um link de pagamento compartilhável, escopado ao seu lojista
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
Título do link (aparece no checkout). Máx. 255 caracteres.
fixed (valor fixo — envie amount) ou customer_defined (o comprador digita o valor).Valor em centavos. Obrigatório quando
amount_type = fixed. Mínimo 500 (R$ 5,00).Métodos aceitos (mínimo 1):
pix, credit_card, debit_card, bank_slip.Descrição opcional exibida no checkout.
Máximo de parcelas no cartão (1 a 12).
none (sem juros) ou installments (juros por parcela, conforme a tabela do lojista).Até quantas parcelas ficam sem juros (1 a 12).
Captura automática do cartão. Padrão:
true.Validade do boleto em dias (1 a 60).
Validade do QR Pix em minutos (5 a 1440).
Data/hora de expiração do link (ISO 8601, no futuro). Depois disso o link não paga mais.
Número máximo de pagamentos aceitos pelo link. Atingido o limite, o link deixa de ser pagável.
Coletar o telefone do comprador no checkout.
Exigir endereço do comprador. É forçado para
true quando bank_slip está entre os métodos.Texto que aparece na fatura do cartão do comprador. Máx. 22 caracteres.
URL de webhook específica deste link (além dos webhooks globais). Deve ser HTTPS e pública.
Enviar recibo por e-mail ao comprador quando o pagamento for aprovado.
URL do logo exibido no checkout. Máx. 255 caracteres.
Cor de destaque do checkout (hex). Máx. 9 caracteres.
cURL
Resposta
Compartilhe o campo
url com o comprador. O checkout é público (resolvido pelo hash do link) —
não exige a chave de API.