Links de pagamento
Crie um link fixo para cobrar por PIX sem escrever uma tela de pagamento. Quem abre o link já cai na página de pagamento da VamPay.
Como funciona
Cada link tem um slug e abre em https://vampay.com.br/pay/link/{slug}. Se o link tem valor fixo, o pagador só confere e paga. Sem valor fixo (amount vazio), quem paga informa o valor, respeitando os limites que a API devolve em minimumAmount e maximumAmount.
Os valores mínimo e máximo dependem da sua conta (taxas e limites da rota) e vêm em toda resposta. O pagamento de um link gera uma transação normal: você recebe
transaction.created e transaction.completed nos seus webhooks.Criar
POST
/payment-links| Parâmetro | Tipo | Descrição |
|---|---|---|
slug* | string | Endereço do link: 3 a 40 letras, números e hífen, começando e terminando com letra ou número. Precisa ser único (409 se já existir) |
name* | string | Nome do link, só pra você identificar |
amount | number | Valor fixo em reais. Se omitir, quem paga escolhe o valor |
description | string | Descrição mostrada na página de pagamento |
pixelIds | string[] | IDs dos pixels (Meta) cadastrados no painel para rastrear este link |
tiktokPixelIds | string[] | IDs dos pixels do TikTok |
googleAdsIds | string[] | IDs das contas do Google Ads |
curlbash
curl -X POST "https://api.vampay.com.br/payment-links" \
-H "X-API-Key: vampay_sua_api_key" \
-H "Content-Type: application/json" \
-d '{
"slug": "assinatura-premium",
"name": "Assinatura Premium",
"amount": 49.90,
"description": "Acesso por 30 dias"
}'201 Createdjson
{
"success": true,
"data": {
"id": "6720a1b2c3d4e5f6a7b8c9d0",
"slug": "assinatura-premium",
"name": "Assinatura Premium",
"amount": 49.9,
"description": "Acesso por 30 dias",
"active": true,
"totalPaid": 0,
"usageCount": 0,
"minimumAmount": 1.5,
"maximumAmount": 10000,
"createdAt": "2026-10-29T14:00:00.000Z"
}
}Listar
GET
/payment-linksDevolve todos os seus links (do mais novo pro mais antigo), com totalPaid (soma já paga) e usageCount (quantas vezes foi usado), e em meta os limites de valor da sua conta.
Editar
PATCH
/payment-links/{id}| Parâmetro | Tipo | Descrição |
|---|---|---|
name | string | Novo nome |
amount | number | null | Novo valor fixo. Envie null pra deixar o valor livre |
description | string | Nova descrição |
active | boolean | false desativa o link sem apagar |
pixelIds / tiktokPixelIds / googleAdsIds | string[] | Troca os pixels do link |
O slug não muda depois de criado. Pra usar outro endereço, crie um novo link.
Remover
DELETE
/payment-links/{id}200 OKjson
{ "success": true, "message": "Link excluído" }Responde 404 se o link não existir ou não for seu. Quem abrir o endereço depois disso não consegue pagar.
