ENOQ PayDocs
v3

Desativar Link

POST/v1/paymentlink/disable?id={id}

Desativa um link de pagamento, impedindo que ele seja utilizado para pagamentos.

Desativar Link de Pagamento

Parâmetros

Exemplo de requisição
curl --request POST \
  --url 'https://api.enoqpay.com.br/gateway/v1/paymentlink/disable?id={id}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta
{
  "id": "aed32670-c3e5-4192-8ab0-0e96f92e3408",
  "sucess": true,
  "message": "Link de pagamento desabilitado com sucesso!"
}

Dicionário de dados

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Exemplo documentado

[
  {
    "tag": "",
    "description": "Nenhum link de pagamento cadastrado"
  }
]

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.

Todo token tem prazo de validade. Renove antes da expiração.