How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BTCPay Server

BTCPay Server Store Wallet (On Chain) API

Store Wallet (On Chain) operations

Documentation Provider Profile APIs.io OpenAPI GitHub

BTCPay Server Store Wallet (On Chain) API is one of 31 APIs that BTCPay Server publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Store Wallet (On Chain). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, authentication docs, and rate-limit docs.

This API exposes 20 operations across 14 paths, and defines 29 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, https://{btcpay-host}.

20 operations 14 paths 29 schemas 3 DELETE10 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://{btcpay-host}/api/v1
Authentication
API Key, HTTP Basic
Contact
BTCPay Server
License
MIT
Resource Areas
1

Authentication & Security 2

BTCPay Server Store Wallet (On Chain) API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (API_Key). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • API_Key — BTCPay Server API key. Format: 'token {apiKey}'
  • Basic — HTTP Basic Authentication with email and password

Paths & Operations 20

Across 14 paths, the API surfaces 20 operations — 3 DELETE, 10 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Store Wallet (On Chain) 20

Store Wallet (On Chain) operations

GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet
Get store on-chain wallet overview
StoreOnChainWallets_ShowOnChainWalletOverview 2 params → 200403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/histogram
Get store on-chain wallet balance histogram
StoreOnChainWallets_ShowOnChainWalletHistogram 2 params → 200403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/feerate
Get store on-chain wallet fee rate
StoreOnChainWallets_GetOnChainFeeRate 3 params → 200403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/address
Get store on-chain wallet address
StoreOnChainWallets_GetOnChainWalletReceiveAddress 3 params → 200403404
DELETE
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/address
UnReserve last store on-chain wallet address
StoreOnChainWallets_UnReserveOnChainWalletReceiveAddress 2 params → 200403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions
Get store on-chain wallet transactions
StoreOnChainWallets_ShowOnChainWalletTransactions 6 params → 200403404503
POST
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions
Create store on-chain wallet transaction
StoreOnChainWallets_CreateOnChainTransaction 2 params body → 200403404
POST
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions/broadcast
Broadcast an on-chain transaction or finalized PSBT
StoreOnChainWallets_BroadcastOnChainTransaction 2 params body → 200403404422503
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions/{transactionId}
Get store on-chain wallet transaction
StoreOnChainWallets_GetOnChainWalletTransaction 3 params → 200403404
PATCH
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions/{transactionId}
Patch store on-chain wallet transaction info
StoreOnChainWallets_PatchOnChainWalletTransaction 4 params body → 200403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/utxos
Get store on-chain wallet UTXOS
StoreOnChainWallets_GetOnChainWalletUTXOs 2 params → 200403404
POST
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/generate
Generate store on-chain wallet
StoreOnChainPaymentMethods_GenerateOnChainWallet 2 params body → 200400403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/preview
Preview store on-chain payment method addresses
StoreOnChainPaymentMethods_GetOnChainPaymentMethodPreview 4 params → 200403404
POST
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/preview
Preview proposed store on-chain payment method addresses
StoreOnChainPaymentMethods_POSTOnChainPaymentMethodPreview 4 params body → 200403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects
Get store on-chain wallet objects
StoreOnChainWallets_GetOnChainWalletObjects 5 params → 200403404
POST
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects
Add/Update store on-chain wallet objects
StoreOnChainWallets_AddOrUpdateOnChainWalletObjects 2 params body → 200403404
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects/{objectType}/{objectId}
Get store on-chain wallet object
StoreOnChainWallets_GetOnChainWalletObject 5 params → 200403404
DELETE
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects/{objectType}/{objectId}
Remove store on-chain wallet objects
StoreOnChainWallets_RemoveOnChainWalletObject 4 params → 200403404
POST
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects/{objectType}/{objectId}/links
Add/Update store on-chain wallet object link
StoreOnChainWallets_AddOrUpdateOnChainWalletLink 4 params body → 200403404
DELETE
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects/{objectType}/{objectId}/links/{linkType}/{linkId}
Remove store on-chain wallet object links
StoreOnChainWallets_RemoveOnChainWalletLink 6 params → 200403404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are OnChainWalletUTXOData (9 properties), CreateOnChainTransactionRequest (9 properties), OnChainWalletTransactionData (9 properties), GenerateOnChainWalletRequest (8 properties). Each schema is shown below with its type and property counts.

OnChainWalletObjectData
object
2 properties
OnChainPaymentMethodBaseData
object
3 properties
OnChainWalletUTXOData
object
9 properties
GenericPaymentMethodData
object
3 properties
LNURLPayPaymentMethodBaseData
object
3 properties
AddOnChainWalletObjectLinkRequest
object
1 property
CreateOnChainTransactionResponse
object
1 property
BroadcastOnChainTransactionRequest
object
1 property 1 required
OnChainWalletFeeRateData
object
1 property
OnChainPaymentMethodPreviewResultData
object
1 property
OnChainWalletOverviewData
object
3 properties
LightningNetworkPaymentMethodBaseData
object
1 property
LabelData
object
2 properties
OnChainPaymentMethodPreviewResultAddressItem
object
2 properties
UnixTimestamp
number
A unix timestamp in seconds
GenerateOnChainWalletRequest
object
8 properties
PaymentMethodId
string
Payment method IDs. Available payment method IDs for Bitcoin are: - "BTC-CHAIN": Onchain -"BTC-LN": Lightning - "BTC-LNURL": LNURL
TransactionStatus
string
CreateOnChainTransactionRequest
object
9 properties
OnChainWalletAddressData
object
3 properties
OnChainWalletObjectId
object
2 properties
HistogramData
object
Histogram data for wallet balances over time
4 properties
OnChainWalletObjectLink
object
4 properties
CreateOnChainTransactionRequestDestination
object
3 properties
Mnemonic
string
A BIP39 mnemonic
StoreId
string
Store ID of the item
PatchOnChainTransactionRequest
object
2 properties
OnChainWalletTransactionData
object
9 properties
ValidationProblemDetails
array
An array of validation errors of the request

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

btcpay-store-wallet-on-chain-api-openapi.yml Raw ↑

Other APIs BTCPay Server publishes across the network.

BTCPay Server API Keys API
AE Profile APIs.io
BTCPay Server Apps API
AE Profile APIs.io
BTCPay Server Authorization API
AE Profile APIs.io
BTCPay Server Crowdfund API
AE Profile APIs.io
BTCPay Server Files API
AE Profile APIs.io
BTCPay Server Health API
AE Profile APIs.io
BTCPay Server Invoices API
AE Profile APIs.io
BTCPay Server Lightning address API
AE Profile APIs.io
BTCPay Server Lightning (Internal Node) API
AE Profile APIs.io
BTCPay Server Lightning (Store) API
AE Profile APIs.io
BTCPay Server Miscelleneous API
AE Profile APIs.io
BTCPay Server Notifications (Current User) API
AE Profile APIs.io
#Store Wallet (On Chain)
← Back to B APIs
API Details
ID
btcpay:btcpay-store-wallet-on-chain-api
Base URL
https://{btcpay-host}/api/v1
Docs
https://docs.btcpayserver.org/API/Greenfield/v1/
Provider
BTCPay Server
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=btcpay-store-wallet-on-chain-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/btcpay-store-wallet-on-chain-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of BTCPay Server Store Wallet (On Chain) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.