Skip to main content
GET
Get a payment link
Returns the public view of an active payment link — everything a page needs to render its own “Pay” screen before materializing a checkout. Merchant identity is limited to the display name.
No API key required. The slug comes from the link’s /p/{slug} URL (find it in your dashboard or in the share dialog).

Field highlights

An unknown slug or an inactive link returns 404 Payment link not found or inactive — inactive links never leak that they once existed.

Authorizations

x-api-key
string
header
required

Path Parameters

slug
string
required

Public slug from the link's /p/{slug} URL.

Response

Active payment link

slug
string
name
string | null
description
string | null
amount
string | null

Fixed amount, or null for custom-amount links.

currency
string
coin_symbol
string | null
chain
enum<string> | null
Available options:
solana,
sui,
null
allow_custom_amount
boolean
require_email
boolean
require_name
boolean
processing_fee_enabled
boolean
is_test
boolean
merchant_name
string