1. Links de pagamento
Bestfy API
  • Sobre a Bestfy
    • Comece aqui
  • Webhooks
    • O que é um Webhook?
  • Tokenização
    • O que é Tokenização?
    • Criar token de cartão
      POST
  • Status de transação
    • Status de Pagamento na Bestfy
  • Transações
    • Anotações
      • Criar anotações
      • Listar anotações
      • Buscar anotação
      • Editar anotação
      • Remover anotação
    • Criar transações
      POST
    • Estornar transação
      POST
    • Buscar transação
      GET
    • Listar transações
      GET
    • Atualizar status de rastreio
      PATCH
    • Obter Token 3DS
      GET
    • Obter configurações do 3DS
      GET
  • Links de pagamento
    • Listar links de pagamento
      GET
    • Criar link de pagamento
      POST
    • Buscar link de pagamento
      GET
    • Atualizar link de pagamento
      PUT
    • Ativar ou desativar link de pagamento
      PATCH
    • Excluir link de pagamento
      DELETE
  • Saldo
    • Buscar saldo
      GET
  • API Key
    • Validar API Key
      GET
  1. Links de pagamento

Excluir link de pagamento

DELETE
https://api.bestfy.io/public-api/payment-link/{paymentLinkId}
Use este endpoint para excluir um link de pagamento. A exclusão é lógica: o link para de aceitar pagamento, some da listagem e passa a responder 404 nos demais endpoints, mas o registro permanece na Bestfy porque as vendas já feitas apontam para ele.
Na prática, para quem integra, o efeito é o de uma exclusão definitiva: não existe endpoint para restaurar um link excluído. Se a intenção é apenas tirar o link do ar temporariamente, use Ativar ou desativar link de pagamento em vez deste endpoint.

Regras de uso#

paymentLinkId precisa estar no formato correto.
Excluir um link já excluído responde 404.
A exclusão funciona com o link ativo ou inativo; não é preciso desativar antes.

O que acontece com as vendas#

As transações geradas pelo link continuam intactas: valor, status, webhooks e saldo não mudam.
No dashboard, a coluna de produto dessas vendas continua exibindo o nome que o link tinha no momento de cada pagamento.
O slug não é liberado para reuso. Uma URL de link excluído nunca passa a apontar para outro link, nem para outra empresa.
O nome, ao contrário do slug, volta a ficar disponível: você pode criar um link novo com o mesmo nome de um excluído.

Resposta#

204, sem corpo.

Erros comuns#

CódigoMotivo.
400paymentLinkId fora do formato correto.
401x-api-key ausente ou inválida.
403API_KEY_E001 — chave revogada.
403Links de pagamento não habilitados para a sua conta.
404PAYMENT_LINK_E001 — link inexistente, excluído ou de outra empresa.
429Acima de 60 requisições por minuto, contadas por empresa e não por IP.
500Erro interno — tente novamente após alguns segundos.
O 400 de formato do paymentLinkId vem como { "message": "ID inválido", "error": "Bad Request", "statusCode": 400 }. Os erros de regra de negócio vêm com code e sem statusCode; os de api-key vêm com statusCode no corpo.

Request

Path Params

Header Params

Responses

🟢204Link de pagamento excluído com sucesso
text/plain
🟠401API Key inválida/ausente
🟠403Link de pagamento não habilitado para a conta dona da chave
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://api.bestfy.io/public-api/payment-link/' \
--header 'User-Agent: <nome-do-projeto>' \
--header 'x-api-key: <api-key>'
Response Response Example
204 - Success
No content
Modified at 2026-09-11 13:48:55
Previous
Ativar ou desativar link de pagamento
Next
Buscar saldo
Built with