WysePayDocs

Listar links de pagamento

GET
/api/v1/payment-links

Os links da conta, do mais novo para o mais antigo.

Permissão da chave: payment_links:read.

Autenticação

headerx-api-key<token>

Sua chave de API, criada no painel em Desenvolvedores → Chaves de API.

Parâmetros de consulta

limit?integer

Quantos itens por página (1 a 100).

Faixa1 <= value <= 100
Padrão20
startingAfter?string

O id do último item da página anterior. A página seguinte começa depois dele.

Tamanholength <= 64
active?string

true só os ativos; false só os desativados ou esgotados.

Valores aceitos"true""false"

Corpo da resposta

Uma página de links.

application/json
  1. response
data*array<>
hasMore*boolean

true quando há mais itens: peça de novo com startingAfter = o id do último.

curl -X GET "https://example.com/api/v1/payment-links"
{  "data": [    {      "id": "plk_01k6g8m2v4x7z9b3c5d7f9h0j2",      "url": "https://app.wysepay.com.br/checkout/pay_2sngtnj5fkcnnm1m6v39xfe5b3",      "amountCents": 8990,      "description": "Camiseta básica · Tamanho M",      "active": true,      "maxPayments": 0,      "askAddress": true,      "returnUrl": "string",      "metadata": {        "property1": null,        "property2": null      },      "livemode": true,      "expiresAt": "2026-10-04T15:30:00.000Z",      "createdAt": "2026-10-04T15:30:00.000Z"    }  ],  "hasMore": true}

Criar um link de pagamento POST

Cria um checkout com o valor e a descrição. Envie a `url` ao cliente: ele preenche os dados, paga com Pix e vê o comprovante. Permissão da chave: `payment_links:write`.

Consultar um link GET

Um link de pagamento e se ele ainda aceita pagamentos (`active`). Permissão da chave: `payment_links:read`.