Ativar ou desativar link de pagamento
PATCH
https://api.bestfy.io/public-api/payment-link/{paymentLinkId}/toggle-active
isActive com Buscar link de pagamento antes de chamar.Regras de uso
paymentLinkId precisa estar no formato correto.400, e a falha nunca é sobre o que você enviou, e sim sobre o estado do link e da empresa.O que o comprador vê
Resposta
200 com o estado resultante, no campo isActive.Erros comuns
| Código | Motivo. |
|---|---|
400 | paymentLinkId fora do formato correto. |
400 | PAYMENT_LINK_E003 — método do link não é mais permitido para esta empresa. |
400 | PAYMENT_LINK_E004 — o link não tem nenhum método de pagamento habilitado. |
400 | PAYMENT_LINK_E006 — valor por parcela abaixo do mínimo de R$ 5,00. |
401 | x-api-key ausente ou inválida. |
403 | API_KEY_E001 — chave revogada. |
403 | Links de pagamento não habilitados para a sua conta. |
404 | PAYMENT_LINK_E001 — link inexistente, excluído ou de outra empresa. |
429 | Acima de 60 requisições por minuto, contadas por empresa e não por IP. |
500 | Erro interno — tente novamente após alguns segundos. |
400 de regra de negócio só acontecem na ativação. Na desativação, os únicos erros possíveis são de formato, autenticação e não encontrado.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
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.bestfy.io/public-api/payment-link//toggle-active' \
--header 'User-Agent: <nome-do-projeto>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"isActive": false
}'Response Response Example
200 - Success
{
"isActive": false
}Modified at 2026-09-11 13:37:51