View as Markdown
BTCPay Server icon

BTCPay Server ACTION

Get Store On-Chain Wallet Balance

Fetches the balance of your on-chain store wallet. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BTCPay Server account once, then configure and run Get Store On-Chain Wallet Balance from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "btcpay_server-get-store-on-chain-wallet-balance",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    btcpay_server: { authProvisionId: "apn_xxxxxxx" },
    storeId: "Store ID",
    cryptoCode: "Crypto Code",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Store On-Chain Wallet Balance inputs
Property Type Description
storeId Store ID string
Identifier of a store
Required Dynamic
cryptoCode Crypto Code string
The crypto code of the payment method to fetch. Example: BTC
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
btcpay_server-get-store-on-chain-wallet-balance
Version
0.0.2
App
BTCPay Server
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes