Skip to content

BTCPay Server CLINK Plugin

WoompaLoompa edited this page Jul 12, 2026 · 1 revision

Accept Bitcoin Lightning payments on your BTCPay Server via the CLINK protocol. Customers pay with ShockWallet, ZEUS, Amethyst, or any CLINK-compatible Lightning wallet. All communication flows over Nostr relays — no web server required for your Lightning node.

Quick Start

  1. Install the plugin — Installation Guide
  2. Configure your CLINK offer — Configuration Guide
  3. Receive payments — customers see "Lightning (CLINK)" at checkout

Features

  • CLINK Offer (noffer) based Lightning payments via Nostr
  • No web server required — your Lightning node communicates through Nostr relays
  • Client-side invoice generation using the CLINK SDK
  • QR code display for easy mobile payment
  • Payment polling and automatic status updates
  • Subscription auto-pay via nDebit strings (learn more)
  • Configurable invoice timeout and poll interval
  • Multiple relay support for redundancy
  • Admin configuration page for store-level settings

Requirements

Requirement Version
BTCPay Server v2.4.0+
.NET SDK 10.0+
Node.js 22+ (for Nostr bridge)
CLINK-compatible wallet ShockWallet, Lightning.Pub, ZEUS, or Amethyst

Supported Wallets

Wallet Platform nOffer Support nDebit Support
ShockWallet Mobile + Browser Extension
ZEUS Mobile
Amethyst Mobile
Lightning.Pub Self-hosted

How It Works

  1. Merchant generates a CLINK Offer string (noffer1...) from their CLINK-compatible Lightning node
  2. Customer checks out and selects "Lightning (CLINK)" as payment method
  3. The plugin requests a BOLT11 Lightning invoice from the merchant's node over Nostr
  4. Customer scans the QR code and pays with any Lightning wallet
  5. Payment is confirmed via CLINK protocol receipt

Documentation

Page Description
Installation Install from release or build from source
Configuration Store settings and options
Generating a nOffer Step-by-step wallet guides
How It Works Technical architecture and Nostr flow
Subscription Auto-Pay nDebit feature for recurring payments
Development Build, debug, and test the plugin
API Reference HTTP endpoints and Nostr bridge protocol
Troubleshooting Common issues and solutions
Changelog Version history

License

MIT

Clone this wiki locally