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"
}

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.sopague.com.br/link/3c228652-122e-4da6-b572-4aea64caad63"
}

Dicionário de dados - Retorno

Respostas de Erro

400 - Erro na requisição

[
  {
    "tag": "",
    "description": "Bandeira não identificada"
  }
]

500 - Erro interno

[
  {
    "tag": "",
    "description": "Não foi possível executar comando. Erro desconhecido."
  }
]

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