Referência da API

Listar links de pagamento

Lista paginada de QuickLinks da sua conta, ordenados por `status ASC, createdAt DESC` (ativos primeiro). Valores em centavos.

GET/v2/quick-links

Paginação 0-indexed

page Mesmo padrão dos outros endpoints V2: `page=0` é a primeira página.

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Parâmetros

status'ACTIVE' | 'PAUSED' | 'ARCHIVED' (query)opcional

Filtra por status específico. Sem esse parâmetro, retorna todos (exceto deletados, a menos que `includeDeleted=true`).

Exemplo: ACTIVE

searchstring (query)opcional

Busca case-insensitive em `name`, `description` e `slug`.

Exemplo: doacao

pagenumber (query, 0-indexed)opcional

Página, começando em 0. Padrão: 0.

Exemplo: 0

limitnumber (query)opcional

Por página. Default: 20. Máximo: 100.

Exemplo: 20

includeDeletedboolean (query, string)opcional

Passe `true` para incluir links arquivados. Default: false.

Exemplo: false

Respostas

200

Lista paginada. amount e totalRevenue em centavos.

JSON

{
  "result": [
    {
      "id": "ql_a8f3d2e1-...",
      "name": "Doação de Natal",
      "slug": "doacao-natal",
      "description": "Sua contribuição pro projeto",
      "amount": 5000,
      "status": "ACTIVE",
      "validFrom": "2026-12-01T00:00:00.000Z",
      "validUntil": "2026-12-31T23:59:59.000Z",
      "maxUses": 1000,
      "currentUses": 127,
      "transactionsGenerated": 127,
      "totalRevenue": 635000,
      "createdAt": "2026-05-26T14:32:01.923Z"
    }
  ],
  "totalCount": 8
}

Exemplos

cURL

curl -X GET "https://api.pagnovo.com/v2/quick-links?status=ACTIVE&limit=50" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"