Skip to main content
GET
/
v0
/
payment-links
/
{slug}
Get a payment link by slug
curl --request GET \
  --url https://api.sumvin.com/v0/payment-links/{slug} \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {
    "pint": {
      "href": "/v0/pint/sr%3Aus%3Apint%3Aabc123"
    },
    "public": {
      "href": "/v0/payment-links/public/q79Rx34K..."
    },
    "self": {
      "href": "/v0/payment-links/q79Rx34K..."
    }
  },
  "payment_link": {
    "accepted_chains": [
      1329
    ],
    "amount": "100.00",
    "created_at": 1704067200000,
    "description": "Invoice #1234",
    "expires_at": 1704153600000,
    "max_uses": 1,
    "pay_to": "0x742d35Cc6634C0532925a3b844Bc9e7595f2bD78",
    "pint_uri": "sr:us:pint:abc123",
    "slug": "q79Rx34K...",
    "status": "pending",
    "usage_count": 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"

Path Parameters

​
slug
string
required

Query Parameters

​
expand
string[] | null

Relations to hydrate. Supports 'pint' and 'transaction'.

Response

Successful Response

Owner-view single payment link response.

​
_links
Links · object
required

HAL-style hypermedia links for navigation and available actions.

​
payment_link
PaymentLinkData · object
required

Payment link resource.

Example:
{
  "accepted_chains": [1329],
  "amount": "100.00",
  "asset": {
    "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "decimals": 6,
    "symbol": "USDC"
  },
  "created_at": 1704067200000,
  "description": "Invoice #1234",
  "expires_at": 1704153600000,
  "max_uses": 1,
  "pay_to": "0x742d35Cc6634C0532925a3b844Bc9e7595f2bD78",
  "pint_uri": "sr:us:pint:abc123",
  "slug": "q79Rx34K...",
  "status": "pending",
  "usage_count": 0
}