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

Atualizar link de pagamento

PUT
https://api.bestfy.io/public-api/payment-link/{paymentLinkId}
Use este endpoint para alterar um link de pagamento existente. A operação é uma substituição completa: envie todos os campos do payload de criação, não apenas os que mudaram. Um campo omitido não é preservado, a requisição é recusada por validação (com excessão dos campos bankSlipEnabled e bankSlipDueDays, que são opcionais e, quando omitidos, preservam o valor original).
O slug e a url não mudam em nenhuma hipótese, então links já compartilhados continuam válidos depois da edição.

Regras de uso#

Todos os campos do payload são obrigatórios, exatamente como na criação, e passam pelas mesmas regras de negócio:
paymentLinkId precisa estar no formato correto.
Ao menos um método de pagamento habilitado.
O método habilitado precisa estar permitido para a sua empresa.
maxInterestFreeInstallments não pode exceder maxInstallments.
Com cartão habilitado, amountInCents / maxInstallments precisa ser no mínimo 500, ou seja R$ 5,00 por parcela.
name continua único por empresa. Mudar apenas a caixa do nome, de consultoria para CONSULTORIA, não dispara conflito com o próprio link.
A descrição de cada campo está em Criar link de pagamento.

Efeito sobre vendas já realizadas#

Editar um link não altera vendas passadas. Cada venda guarda o nome e o valor vigentes no momento do pagamento, então relatórios e dashboard continuam mostrando o que o comprador de fato pagou.
A partir da atualização, a página passa a cobrar o novo valor. Se alguém estiver com a página aberta, a cobrança é recalculada no servidor no momento do pagamento — o comprador nunca paga um valor desatualizado.

Resposta#

204, sem corpo. Para conferir o estado resultante, chame Buscar link de pagamento.

Erros comuns#

CódigoMotivo.
400paymentLinkId fora do formato correto.
400Requisição inválida, por campo ausente ou valor fora dos limites.
400PAYMENT_LINK_E002 — já existe outro link de pagamento com este nome.
400PAYMENT_LINK_E003 — método de pagamento não permitido para esta empresa.
400PAYMENT_LINK_E004 — habilite ao menos um método de pagamento no link.
400PAYMENT_LINK_E005 — parcelas sem juros acima do parcelamento máximo.
400PAYMENT_LINK_E006 — valor por parcela abaixo do mínimo de R$ 5,00.
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

Body Params application/jsonRequired

Examples

Responses

🟢204 Link de pagamento atualizado 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 PUT 'https://api.bestfy.io/public-api/payment-link/' \
--header 'User-Agent: <nome-do-projeto>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Consultoria 1h",
  "amountInCents": 15000,
  "pixEnabled": true,
  "bankSlipEnabled": false,
  "bankSlipDueDays": 1
  "creditCardEnabled": true,
  "maxInstallments": 12,
  "maxInterestFreeInstallments": 3,
  "isActive": true
}'
Response Response Example
204 - Success
No content
Modified at 2026-09-16 14:59:43
Previous
Buscar link de pagamento
Next
Ativar ou desativar link de pagamento
Built with