Criar Link

POST/v1/paymentlink/new

Cria um link de pagamento pronto, com valor definido, fornecendo um checkout para o pagador. O link gerado será válido apenas até a data de expiração (expirationDate).

Dicionário de dados - Body

Exemplo de requisição

{
  "description": "Descrição do produto ou serviço",
  "value": 10.00,
  "qttyInstallments": 12,
  "qttyInstallmentsIntFree": 6,
  "installmentsFee": 1.5,
  "expirationDate": "2025-08-29",
  "urlCallBack": "https://meusite.com.br/webhook"
}

Retorno (200)

Exemplo de resposta

{
  "id": "3c228652-122e-4da6-b572-4aea64caad63",
  "message": "Link de pagamento cadastrado com sucesso!",
  "description": "MENSALIDADE JOÃO DA SILVA",
  "value": 10.00,
  "expirationDate": "2025-08-29",
  "link": "https://faturas.enoqpay.com.br/link/3c228652-122e-4da6-b572-4aea64caad63"
}

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": "Bandeira não identificada"
  }
]

Observado em homologação

Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.

[
  {
    "tag": "Description",
    "description": "Descrição é obrigatória."
  },
  {
    "tag": "Value",
    "description": "Valor deve ser maior que R$ 1,00."
  }
]

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.