GET /api/links/{slug} to fetch the public details of a payment link. This endpoint returns everything your checkout page or integration needs to display link information — the business name, expected amount, deposit address, and current status. It does not include private merchant data.
Request
Path parameters
The unique identifier for the payment link. You receive the
slug in the response when you create the link via POST /api/links.Example request
cURL
Response
A successful request returns200 OK with the following fields.
The unique identifier for this payment link.
Your business name as it was provided when the link was created.
The USDC amount expected for this payment link (e.g.
"49.00").The current payment status. Possible values are
pending, confirmed, partial, excess, and error. See Payment status for definitions.The on-chain USDC deposit address on Base associated with this link.
The optional product description provided at creation time.
null if none was supplied.Example response
200