Loading…

The payment link object

`id` stringoptional	Unique identifier.
`slug` stringoptional	URL slug for the hosted page.
`memo` stringoptional	Stellar text memo used to match payments.
`url` stringoptional	Full hosted payment page URL.
`active` booleanoptional	Inactive links reject payments.
`paymentCount` numberoptional	Payments received via this link.
`product` objectoptional	Summary of the linked product.
`createdAt` stringoptional	ISO 8601 timestamp.

Create a payment link

POST/api/v1/payment-links

productId

stringrequired

Product to create a link for.

curl https://your-app.com/api/v1/payment-links \  -H "Authorization: Bearer $STELLARHOOKS_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "productId": "PRODUCT_ID" }'

json

{  "data": {    "id": "plink_123",    "slug": "abc123xyz0",    "memo": "abc123xyz0",    "url": "https://your-app.com/p/abc123xyz0",    "active": true,    "paymentCount": 0,    "product": { "id": "prod_123", "name": "Pro plan", "assetCode": "XLM", "priceType": "FIXED", "price": "25" },    "createdAt": "2026-01-01T00:00:00.000Z"  },  "error": null}

List, update, delete

GET/api/v1/payment-links

PATCH/api/v1/payment-links/{id}

DELETE/api/v1/payment-links/{id}

List accepts productId and active filters plus page/pageSize. PATCH toggles active.

bash

curl -X PATCH https://your-app.com/api/v1/payment-links/LINK_ID \  -H "Authorization: Bearer $STELLARHOOKS_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "active": false }'

Payment links

Hosted payment pages for a product. Each link carries a unique memo used to match payments.

The hosted page lives at url (e.g. /p/abc123xyz0) and shows the product, amount, a QR code, the receiving address, and the memo. Share this with customers.