Skip to main content
GET
List payment links
Returns results in the data array with a pagination object. Links are scoped to your API key’s entity level.

Pagination

To fetch the next page, pass the next_cursor value from the previous response as the cursor query parameter:
Unknown query parameter names are rejected. Use date_from, date_to, and cursor; legacy names such as created_after, created_before, and page_token are not accepted.

Authorizations

X-API-Key
string
header
required

API key enabled for the requested payment-link operation and associated with an eligible partner, merchant, or branch account.

Query Parameters

status
enum<string>[]

Filter by one or more statuses. Repeatable values are serialised as a comma-separated list, for example ACTIVE,CONSUMED.

Current status of the payment link.

Available options:
ACTIVE,
CONSUMED,
EXPIRED,
CANCELLED
Example:
merchant_branch_reference_number
string

Filter by branch. String; no length constraint is imposed.

date_from
string<date-time>

RFC 3339 timestamp. Only return links created after this time.

date_to
string<date-time>

RFC 3339 timestamp. Only return links created before this time.

page_size
integer
default:20

Number of results per page.

Required range: 1 <= x <= 200
cursor
string

Opaque, non-empty pagination cursor from a previous response's next_cursor. Do not construct or parse it.

Response

A paginated list of payment links

data
object[]
required

Payment links in the current page, ordered from newest to oldest.

pagination
object
required

Cursor-pagination state for this result page.