Skip to main content
Returns a paginated list of your payment links, newest first. Requires the payment_links:read scope.

Request

GET https://api.blockra.io/payment-links

Query parameters

integer
default:"1"
Page number (1-based).
integer
default:"25"
Items per page (max 100).
string
Sort column: id, label, amount, uses, status, or created_at.
string
default:"desc"
asc or desc.
string
Exact payment link ID.
string
Substring match on the label.
string
Comma-separated: active, inactive.
number
Minimum amount.
number
Maximum amount.
string
ISO date string — return links created on or after this date (e.g. 2026-01-01).
string
ISO date string — return links created before this date.

Response

array
The payment links on this page (each: id, label, amount, currency, uses, is_active, created_at).
integer
Total matching links.
integer
Current page.
integer
Page size.
integer
Total number of pages.