Skip to main content
POST
Escopo payments:write; o link que aceita cartão ou cripto (methods) pede também card:write ou crypto:write. Até 200 links por conta e 60 criações ou edições por hora. O endereço público aparece no painel, na forma /pagar/LNK-....
string
required
Até 80 caracteres.
string | null
Até 280 caracteres.
integer | null
Valor fixo em centavos. null = valor livre: o pagador escolhe entre suggestedAmounts e, com allowCustomAmount, digita outro entre minAmount e maxAmount.
integer[] | null
Até 6 valores sugeridos, só no valor livre.
boolean
Aceita outro valor digitado.
integer
Mínimo do valor livre.
integer | null
Máximo do valor livre (até 100.000.000).
string[]
default:"[\"pix\"]"
Formas que quem paga pode escolher na página: pix, card, crypto (pelo menos uma; vazio: METHODS_REQUIRED). Sem o campo, só Pix. Uma forma que fique indisponível some da página até voltar.
string[]
Dados a pedir antes de pagar: name, email, phone, document. Cada um escolhido é obrigatório e quem paga vira cliente seu.
string | null
Nome mostrado na página (até 60). O nome da conta continua como recebedor.
string | null
Cor de destaque, #RRGGBB.
string
auto, light ou dark.
string | null
Pagar com Pix, Comprar, Doar, Contribuir, Assinar, Garantir minha vaga ou Apoiar.
string | null
Mensagem depois do pagamento (até 280).
string | null
Para onde levar depois de pagar. Só https://.
integer | null
Depois dessa quantidade de pagamentos, o link fica sold_out.
string | null
Data e hora (ISO 8601) em que o link vence.
boolean
false cria o link pausado.
string | null
sacc_... ou externalId de uma subconta: cada pagamento pelo link é creditado a ela, como na cobrança com subaccountId. Desativada na criação: 422 SUBACCOUNT_INACTIVE; desativada ou excluída depois, os pagamentos ficam com você.

Resposta

string
LNK- + 12.
string
Título.
string | null
Descrição.
integer | null
Valor fixo, ou null no valor livre.
integer | null
Mínimo do valor livre.
integer | null
Máximo do valor livre.
integer[]
Valores sugeridos.
boolean
Aceita valor digitado.
string[]
Formas aceitas no link: pix, card, crypto.
boolean
true se algum dado é pedido.
string[]
Dados pedidos.
string | null
Nome na página.
string | null
Cor de destaque.
string
auto, light ou dark.
string | null
Texto do botão.
string | null
Mensagem depois do pagamento.
string | null
Destino depois do pagamento.
integer | null
Limite de pagamentos.
string | null
Vencimento.
boolean
Ligado ou pausado.
string
active, paused, expired ou sold_out.
string
Ativo, Pausado, Vencido ou Esgotado.
integer
Quantidade de cobranças pagas pelo link.
integer
Soma recebida pelo link (centavos).
string | null
Último pagamento.
object | null
A subconta do link: { id, name }. null sem subconta.
string
Criação.