Skip to main content
GET
/
v0
/
payment-links
List payment links
curl --request GET \
  --url https://api.sumvin.com/v0/payment-links \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {
    "first": {
      "href": "/v0/payment-links?limit=50&offset=0"
    },
    "self": {
      "href": "/v0/payment-links?limit=50&offset=0"
    }
  },
  "data": [],
  "limit": 50,
  "offset": 0,
  "total": 0
}

Authorizations

​
x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

​
x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

​
x-sumvin-token
string | null
​
x-sumvin-pat
string | null
​
x-juno-jwt
string | null
​
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Query Parameters

​
status
string | null

Filter by payment link status (e.g. 'pending', 'settled').

​
from_date
string | null

Filter payment links created on or after this date. Accepts epoch ms or YYYY-MM-DD.

​
to_date
string | null

Filter payment links created on or before this date. Accepts epoch ms or YYYY-MM-DD.

​
limit
integer
default:50
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

Owner-view list response with pagination.

​
_links
Links · object
required

HAL-style hypermedia links for navigation and available actions.

​
data
PaymentLinkData · object[]
required

Page of payment links.

​
offset
integer
required

Number of items skipped from the beginning of the result set.

​
limit
integer
required

Maximum number of items returned per page (1-100).

​
total
integer
required

Total number of items across all pages.