WysePayDocs

Consultar um link

GET
/api/v1/payment-links/{id}

Um link de pagamento e se ele ainda aceita pagamentos (active).

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 da URL

id*string

O id do link (plk_…).

Corpo da resposta

O link.

application/json
  1. response

Um link de pagamento.

id*string
url*string

Endereço do checkout para enviar ao cliente.

Formatouri
amountCents*integer
description*string
active*boolean

false depois de desativado ou esgotado.

maxPayments*|

Quantos pagamentos o link aceita. null = ilimitado; 1 = uso único.

askAddress*boolean

O checkout pede o endereço do cliente.

returnUrl*|

Para onde o cliente volta depois de pagar, com wysepay_transaction_id na URL.

metadata*|null
livemode*boolean
expiresAt*|null
createdAt*string
Formato^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time
curl -X GET "https://example.com/api/v1/payment-links/string"
{  "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"}

Listar links de pagamento GET

Os links da conta, do mais novo para o mais antigo. Permissão da chave: `payment_links:read`.

Desativar um link POST

O link para de aceitar pagamentos e o checkout mostra que ele não está disponível. Cobranças já geradas continuam valendo. Permissão da chave: `payment_links:write`.