Skip to main content

Visão geral

Este endpoint permite atualizar parcialmente um link de pagamento já criado, como título, valor, descrição ou status (ativar/desativar).

Endpoint

curl --request PATCH \
  --url https://api.avanttifinance.com/v1/payment-links/{payment_link_id} \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Plano Premium - Promoção",
    "amount": 7990,
    "status": "active"
  }'

Parâmetros de path

Identificador único do link de pagamento a ser atualizado.

Parâmetros do corpo

title
string
Novo título exibido na página de pagamento.
amount
integer
Novo valor cobrado, em centavos.
status
string
Novo status do link: active ou inactive. Links inativos não aceitam novos pagamentos.
expires_at
string
Nova data de expiração do link, no formato ISO 8601.

Resposta

Retorna o objeto do link de pagamento com os dados atualizados.
{
  "id": "plink_3f8a9c1b2d",
  "title": "Plano Premium - Promoção",
  "amount": 7990,
  "status": "active",
  "url": "https://pay.avanttifinance.com/plink_3f8a9c1b2d",
  "updated_at": "2026-06-11T10:00:00Z"
}
Para desativar um link sem excluí-lo, defina status como inactive — o link continuará existindo, mas não aceitará novos pagamentos.

Erros comuns

Código HTTPSignificado
400Dados inválidos no corpo da requisição
401Token de autenticação inválido ou ausente
404Link de pagamento não encontrado

Próximos passos

Listar / Filtrar

Consulte todos os links de pagamento criados.

Criar link

Crie um novo link de pagamento.