btcpayserver-plugin: document non-custodial (Spark) accounts - #116
Merged
Conversation
The Blink BTCPay Server plugin (v1.1.0+) now supports the new non-custodial (Spark) accounts for receiving, using a Blink lightning address instead of an API key. Add a "Non-custodial (Spark) account — receive only" section covering the connection string (type=blink;ln-address=yourname@blink.sv;), the username alias, receive-only limitations, mainnet-only support, the USDB (currency=USD) pass-through, and the polling-based settlement detection. Also note the two account types in the intro.
openoms
approved these changes
Jul 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Blink BTCPay Server plugin now supports the new non-custodial (Spark) accounts for receiving (shipped in plugin v1.1.0, Kukks/BTCPayServerPlugins#136). The docs page currently only covers the custodial (API-key) setup.
This adds a "Non-custodial (Spark) account — receive only" section to
docs/examples/btcpayserver-plugin.md.What's covered
type=blink;ln-address=yourname@blink.sv;(no API key / wallet id).@blink.sv) and theusername=alias.currency=USDpass-through, documented as not yet available server-side.The custodial section is unchanged.
Verification
yarn build(Docusaurus 3.3): compiles successfully, no broken-anchor/MDX warnings; the intro anchor resolves to the new section.twentyone@blink.sv) on productionblink.svwith a live BTCPay Server v2.4.0 instance.The wording is adapted from the plugin's own README.