Skip to main content
GET

Two views

  • Public subset. No authentication. This is what the hosted checkout at pay.xenarch.com reads: the signed params, status, expiry, the latest payment and, for metered subscriptions, the suggested spending caps. Each public read counts as a view of the link.
  • Owner detail. Returned when the request carries the xen_session cookie of the wallet that owns the link. It adds stats (views, paid count, revenue, payer wallets, last payment time), metadata, suggested_cap_usdc and suggested_period_cap_usdc. A merchant API key does not return owner detail on this endpoint.
The API re-checks signed_params against params on every read and returns 403 if they no longer match.

Fields

Use latest_payment to show state in your UI. To fulfill orders, rely on a verified webhook.

Errors

Path Parameters

Response

Successful Response

params
Params · object
required
signed_params
string
required
status
enum<string>
required
Available options:
active,
expired,
revoked
kind
string
required
created_at
string<date-time>
required
expires_at
string<date-time> | null
required
stats
PayLinkStats · object
required
events
PayLinkEventItem · object[]
required
paid_and_single_use
boolean
default:false
latest_state
enum<string>
default:AWAIT_PAY
Available options:
AWAIT_PAY,
TX_SUBMITTED,
CONFIRMED,
UNDERPAID,
OVERPAID,
EXPIRED,
REVOKED,
PAID
latest_payment
PayLinkLatestPayment · object | null
metadata
Metadata · object | null
suggested_cap_usdc
string | null
suggested_period_cap_usdc
string | null