Skip to main content
GET
List Paylinks

Authorizations

X-API-KEY
string
header
required

Query Parameters

limit
integer

Page size. Defaults to 100. Minimum 1, maximum 100.

Required range: 1 <= x <= 100
page
integer

Page number (1-based). Defaults to 1.

Required range: x >= 1
reference
string

Exact match on the merchant-defined reference set when the paylink was created. Unlike search, this matches the whole value and nothing else. Multiple results indicate inconsistent legacy data and should be handled as provisioning drift.

Case-insensitive search over paylink name and related fields.

since
string<date-time>

Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at.

sort
enum<string>

Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc.

Available options:
asc,
desc
status
enum<string>

Filter by paylink status.

Available options:
active,
inactive
until
string<date-time>

Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at.

Response

OK

data
object

Paginated payload.

error
boolean

True when the request failed.