Developer API

API documentation

Use the Paylynk.online API from any website or app. Create a monetized unlock link for a destination URL, share that link with users, and they reach your content after completing the ad steps.

Overview

1. Your backend (or site) calls POST /api/v1/links with the real download / page URL.

2. We return a short unlock URL like https://paylynk.online/link/abc123.

3. Show that URL to the user (button, redirect, embed, bot message — whatever fits your product).

4. After ads, the visitor is sent to your original destination. You earn from the unlock traffic.

Base URL

https://paylynk.online

All paths below are relative to this host.

Authentication

Generate a key in Dashboard → Settings → Generate API key.

Send it on every request using either header:

X-Api-Key: pk_your_key_here

# or
Authorization: Bearer pk_your_key_here

Keep the key on your server. Never put it in public frontend JS if users can view source.

Create a link

POST /api/v1/links

Create a monetized unlock URL for any destination.

Request body (JSON)

Field	Required	Description
destinationUrl	Yes	Final URL after unlock (download, page, Discord invite, etc.)
title	No	Label in your dashboard (default: Untitled)
code	No	Custom slug for `/link/{code}`. Auto-generated if omitted.

Example

curl -X POST https://paylynk.online/api/v1/links \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: pk_YOUR_KEY" \
  -d '{
    "title": "Premium download",
    "destinationUrl": "https://example.com/file.zip"
  }'

Response 201

{
  "id": "…",
  "code": "a1b2c3d",
  "title": "Premium download",
  "destinationUrl": "https://example.com/file.zip",
  "adSteps": 3,
  "skipSeconds": 10,
  "url": "https://paylynk.online/link/a1b2c3d"
}

Give users url. That's the only link they need.

List your links

GET /api/v1/links

Returns up to 100 of your most recent links.

curl https://paylynk.online/api/v1/links \
  -H "X-Api-Key: pk_YOUR_KEY"

Using it on your site

Server-side (recommended): when a user needs a download or gated page, your backend creates a link and returns url to the client.

Bots / Discord apps: same idea — create a link when they run a command, reply with the unlock URL.

Ad steps come from your Paylynk monetization level in Settings (not per request). Default is Level 3.

Unlock path format: https://paylynk.online/link/{code}

Rate limits

Create link: 60 requests per hour per API key. Over limit → 429.

Errors

401 — missing or invalid API key
400 — missing destinationUrl, invalid title/code, or blocked words
409 — custom code already taken
429 — rate limit exceeded

Payouts (account)

Earnings from unlocks go to your Paylynk.online creator account. Hit $10, get approved once, then monthly PayPal payouts when your balance is at least $10.

Details: Earnings & payouts.