Skip to main content
GET
/
v1
/
payment-links
cURL
curl "https://api.troqpay.com/v1/payment-links?limit=24" \
  -H "Authorization: Bearer trq_test_xxx"
{
  "data": [
    {
      "paymentLinkId": "pl_4a8b3c1d5e6f2a9b0c1d",
      "livemode": false,
      "active": true,
      "productId": "plano-pro",
      "amount": 12990,
      "currency": "BRL",
      "name": "Plano Pro",
      "description": "Assinatura mensal do Plano Pro",
      "imageUrl": null,
      "paymentCycle": "MONTHLY",
      "expiresInSeconds": 1800,
      "successUrl": "https://loja.example.com/obrigado",
      "returnUrl": "https://loja.example.com/carrinho",
      "createdAt": "2026-04-25T14:00:00.000Z",
      "updatedAt": "2026-04-25T14:00:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Request-Id
string

Identificador opcional fornecido pelo cliente para correlação. A API aceita também X-Request-Id. O valor é ecoado de volta no header de resposta Request-Id. Se nenhum dos dois é enviado, a API gera req_<24 hex>.

Example:

"req_4a8b3c1d5e6f2a9b0c1d2e3f"

Query Parameters

​
limit
integer
default:24

Tamanho da página, entre 1 e 100. O padrão é 24.

Required range: 1 <= x <= 100
Example:

24

​
cursor
string

Cursor opaco da próxima página, retornado em nextCursor. Trate o valor como opaco — não o construa manualmente.

Example:

"MjAyNi0wNC0yNVQxNDowMDowMC4wMDBafHBsXzRhOGIzYzFkNWU2ZjJhOWIwYzFk"

Response

Página de links de pagamento.

Página de links de pagamento, paginada por cursor.

​
data
object[]
required

Links de pagamento da página atual.

​
hasMore
boolean
required

true quando há mais resultados além desta página.

Example:

false

​
nextCursor
string | null
required

Cursor opaco para a próxima página; null quando não há mais resultados.

Example:

null