BTCPay Server

BTCPay Server Store Wallet (On Chain) API

Store Wallet (On Chain) operations

GitHub OpenAPI

Operations 20

GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet Get store on-chain wallet overview #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/histogram Get store on-chain wallet balance histogram #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/feerate Get store on-chain wallet fee rate #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/address Get store on-chain wallet address #
DELETE /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/address UnReserve last store on-chain wallet address #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions Get store on-chain wallet transactions #
POST /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions Create store on-chain wallet transaction #
POST /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions/broadcast Broadcast an on-chain transaction or finalized PSBT #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions/{transactionId} Get store on-chain wallet transaction #
PATCH /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/transactions/{transactionId} Patch store on-chain wallet transaction info #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/utxos Get store on-chain wallet UTXOS #
POST /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/generate Generate store on-chain wallet #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/preview Preview store on-chain payment method addresses #
POST /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/preview Preview proposed store on-chain payment method addresses #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects Get store on-chain wallet objects #
POST /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects Add/Update store on-chain wallet objects #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects/{objectType}/{objectId} Get store on-chain wallet object #
DELETE /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}/wallet/objects/{objectType}/{objectId} Remove store on-chain wallet objects #

Documentation

📖
Documentation
https://docs.btcpayserver.org/API/Greenfield/v1/
📖
Authentication
https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/openapi/btcpay-store-wallet-on-chain-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/btcpayserver/btcpayserver

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/btcpay-store-wallet-on-chain-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

btcpay-store-wallet-on-chain-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BTCPay Greenfield Store Wallet (On Chain) API
  version: v1
  description: '# Introduction


    The BTCPay Server Greenfield API is a REST API.'
  contact:
    name: BTCPay Server
    url: https://btcpayserver.org
  license:
    name: MIT
    url: https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE
servers:
- url: https://{btcpay-host}
  description: Your BTCPay Server instance
  variables:
    btcpay-host:
      default: mainnet.demo.btcpayserver.org
      description: The hostname of your BTCPay Server instance
security:
- API_Key: []
  Basic: []
tags:


# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/openapi/btcpay-store-wallet-on-chain-api-openapi.yml