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

Buscar link de pagamento

GET
https://api.bestfy.io/public-api/payment-link/{paymentLinkId}
Use este endpoint para consultar um link de pagamento específico, pelo identificador devolvido na criação. Útil para conferir o estado atual do link antes de atualizá-lo, ou para recuperar a url de compartilhamento.
O escopo é sempre a empresa da x-api-key: um link de outra empresa responde 404, exatamente como um link inexistente. Isso é intencional — a resposta não revela que o identificador existe em outra conta.

Regras de uso#

paymentLinkId precisa estar no formato correto. Fora do formato, a resposta é 400.
Links inativos são retornados normalmente. Use isActive para saber se o link aceita pagamento.
Links excluídos respondem 404: a exclusão é lógica, mas o link deixa de ser acessível por aqui.

Campos da resposta#

São os mesmos da listagem: id, name, slug, url, amountInCents, pixEnabled, bankSlipEnabled, bankSlipDueDays, creditCardEnabled, maxInstallments, maxInterestFreeInstallments, isActive, companyId, createdAt e updatedAt. A descrição de cada um está em Listar links de pagamento.

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

🟢200Link de pagamento encontrado
application/json
Bodyapplication/json

🟠401Chave ausente/inválida
🟠403Link de pagamento não habilitado para a conta dona da chave
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.bestfy.io/public-api/payment-link/' \
--header 'User-Agent: <nome-do-projeto>' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Success
{
    "id": "f1ed95e8-8ae7-4c77-85d8-8825107e3ac6",
    "name": "Consultoria 1h",
    "slug": "aB3dE9fGh1k",
    "amountInCents": 15000,
    "pixEnabled": true,
    "creditCardEnabled": true,
    "maxInstallments": 12,
    "maxInterestFreeInstallments": 1,
    "isActive": true,
    "companyId": "f196ef96-6456-4c90-a466-eb1b22ab8f2e",
    "createdAt": "2026-02-03T03:16:35.289Z",
    "updatedAt": "2026-09-10T12:04:05.824Z",
    "url": "https://checkout.bestfy.io/pay/aB3dE9fGh1k"
}
Modified at 2026-09-16 14:54:38
Previous
Criar link de pagamento
Next
Atualizar link de pagamento
Built with