Skip to main content

​
Visão geral

Use este endpoint para gerar um link de pagamento que pode ser compartilhado com seus clientes via e-mail, WhatsApp ou redes sociais. O cliente acessa uma página de checkout hospedada pela Avantti Finance e pode pagar via PIX, cartão ou boleto, conforme habilitado.

​
Endpoint

curl -X POST https://api.avanttifinance.com/v1/payment-links \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 15000,
    "description": "Consultoria - Sessão única",
    "payment_methods": ["pix", "card", "boleto"],
    "expires_at": "2025-02-01T23:59:59Z"
  }'

​
Parâmetros do corpo

​
amount
integer
required
Valor a ser cobrado, em centavos (ex: 15000 representa R$ 150,00). Caso omitido, o valor pode ser definido pelo próprio pagador no checkout.
​
description
string
required
Descrição exibida na página de checkout, identificando o motivo da cobrança.
​
payment_methods
array
required
Lista dos métodos de pagamento habilitados para este link. Valores aceitos: pix, card, boleto.
​
expires_at
string
Data e hora de expiração do link, no formato ISO 8601. Após essa data, o link não aceitará novos pagamentos.
​
redirect_url
string
URL para a qual o cliente será redirecionado após concluir o pagamento.
​
metadata
object
Conjunto de pares chave-valor para armazenar informações adicionais sobre o link.

​
Resposta

​
id
string
Identificador único do link de pagamento, no formato plink_xxxxxxxxxxxx.
​
url
string
URL pública do checkout que pode ser compartilhada com o cliente.
​
amount
integer
Valor configurado para a cobrança, em centavos.
​
status
string
Status atual do link. Valores possíveis: active, expired, disabled.
​
created_at
string
Data e hora de criação do link, no formato ISO 8601.

​
Exemplo de resposta

{
  "id": "plink_8f72a1b3c4d5",
  "url": "https://pay.avanttifinance.com/plink_8f72a1b3c4d5",
  "amount": 15000,
  "description": "Consultoria - Sessão única",
  "payment_methods": ["pix", "card", "boleto"],
  "status": "active",
  "expires_at": "2025-02-01T23:59:59Z",
  "created_at": "2025-01-15T10:30:00Z"
}
Links de pagamento são ideais para vendas pontuais sem a necessidade de integração técnica — basta compartilhar a URL gerada.

​
Erros comuns

Código HTTPSignificado
400Dados inválidos ou campos obrigatórios ausentes
401Token de autenticação inválido ou ausente
422Método de pagamento inválido ou expires_at no passado

​
Próximos passos

Listar links

Consulte todos os links de pagamento criados.

Editar link

Atualize as configurações de um link existente.