DOCSEARCHbyAlgolia
Submit Docs

LNbits Documentation

website·Indexed 34 days ago

https://docs.lnbits.com

Developer documentation for LNbits, featuring a complete REST API for managing wallets, payments, users, and extensions. Includes guides on building and deploying extensions, database migrations, authentication methods, and integration with fiat providers like Stripe and PayPal.

Tokens
103.6K
Snippets
524
Records
891
Agent score
63%

What's inside LNbits

  1. Overview of the LNbits Orders extension

    The Orders extension provides an order management system that stores a normalized copy of paid TPoS (Tipping Point of Sale) receipts, including line items, totals, tax, and exchange rate data. It automatically captures paid TPoS invoices and tracks the TPoS ID, name, and payment hash. It also supports optional notifications via Telegram, Nostr, and Email, which can be configured in the Orders Settings.

  2. Overview of the LNbits Extension Builder

    The Extension Builder is a built-in no-code application in LNbits (since v1.3.0) that generates complete extensions. It automates the creation of database models, CRUD operations, API endpoints, Vue.js admin pages, public-facing pages, and Lightning payment logic through a guided wizard.

  3. Overview of TPoS Wrapper

    TPoS Wrapper is a standalone Android application (not an LNbits extension) that allows merchants to accept credit cards, debit cards, Google Pay, and Apple Pay via Stripe, in addition to Bitcoin Lightning payments. It works in conjunction with an LNbits instance and the TPoS extension.

  4. Overview of LNURL support in LNbits

    LNbits provides built-in support for LNURL, a protocol enabling Lightning Network interactions via HTTP. It supports several Lightning URL Definitions (LUDs) to facilitate different types of transactions and interactions:
    LUDNameDescription
    LUD-01Base encodingLNURL bech32 encoding
    LUD-03withdrawRequestLNURL-withdraw (vouchers, faucets)
    LUD-06payRequestLNURL-pay (static QR codes)
    LUD-09successActionPost-payment actions (URLs, messages)
    LUD-12CommentsPayment comments
    LUD-16Lightning Addressuser@domain.com payments
    LUD-17AuthLNURL-auth (passwordless login)

  5. Overview of LNbits core background tasks

    LNbits maintains several internal async tasks for core functionality:
    TaskIntervalPurpose
    Invoice listenerContinuousWatches for paid invoices from the funding source
    Payment checker30 minutesRe-checks pending payments for status updates
    Exchange ratesPeriodicFetches fiat exchange rates
    Audit queueContinuousProcesses audit log entries
    Notification queueContinuousSends email/push notifications
    Webhook processorOn eventCalls webhook URLs for paid invoices

  6. Overview of LNbits Inventory extension

    The Inventory extension provides a centralized system for managing products and stock levels within LNbits. It acts as a single source of truth for item data (names, descriptions, tags, and quantities), allowing this information to be shared and reused across multiple other LNbits extensions, such as point-of-sale or checkout tools.

  7. Overview of the LNbits WooCommerce Plugin

    The LNbits WooCommerce plugin allows WordPress/WooCommerce stores to accept Bitcoin on-chain and Lightning payments. It is an eCommerce plugin that runs within WordPress and connects to an LNbits server via its API, specifically utilizing the Satspay Server extension.

  8. Overview of LNbits Invoices extension

    The Invoices extension allows users to create professional invoices containing one or more line items denominated in a configurable fiat currency. Each invoice generates a public link that can be shared with customers, allowing them to make partial or full payments over the Lightning Network.

  9. Overview of the Magic 8ball extension

    The Magic 8ball extension for LNbits allows users to create "pay-to-reveal" experiences. You define a custom list of responses (quotes, fortunes, jokes, or prompts), and the extension generates a payment QR code. Once a user pays the requested amount in satoshis, they receive one random response from the configured list.

  10. Overview of LNbits Notification Channels

    LNbits supports multiple notification channels to alert admins about server events or users about payments. Channels can be enabled independently and configured via the Admin Dashboard (Server > Notifications) or environment variables.

    • Email (SMTP): Best for formal alerts and audit trails.
    • Telegram: Ideal for quick mobile alerts via a bot.
    • Nostr DM: Privacy-focused, decentralized encrypted messages.
    • Web Push (PWA): Browser-based notifications for end-user payment alerts.

  11. Overview of LNbits Fiat Payments

    LNbits provides a built-in fiat provider system that allows the acceptance of credit/debit cards (via Stripe) and PayPal payments alongside Lightning. The system follows an 'admins configure, extensions consume' model: the Super User configures API keys and providers at the server level, and extensions call the core fiat provider service to offer these options to users without handling sensitive API keys or payment logic themselves.

  12. Overview of LNbits node platform support

    LNbits offers one-click installation on several Bitcoin node platforms. These installations are pre-configured to connect to the platform's Lightning backend, typically removing the need for manual funding source configuration.
    PlatformInstall methodLightning backendCost
    UmbrelApp StoreLND (auto)Free
    Start9MarketplaceCLN or LNDFree
    RaspiBlitzServices menuLND or CLNFree
    CitadelApp StoreLND (auto)Free
    myNodeDashboardLND (auto)Premium