Get Store On-Chain Wallet Balance with BTCPay Server API

Pipedream makes it easy to connect APIs for BTCPay Server and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Store On-Chain Wallet Balance with the BTCPay Server API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Store On-Chain Wallet Balance with the BTCPay Server API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Store On-Chain Wallet Balance action
1. Connect your BTCPay Server account
2. Select a Store ID
3. Configure Crypto Code
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Store On-Chain Wallet Balance with BTCPay Server API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + BTCPay Server

Try it

Get Store On-Chain Wallet Balance with BTCPay Server API on New Submission from Typeform API

Typeform + BTCPay Server

Try it

Get Store On-Chain Wallet Balance with BTCPay Server API on Custom Events from Zoom API

Zoom + BTCPay Server

Try it

Get Store On-Chain Wallet Balance with BTCPay Server API on New Submission (Instant) from Jotform API

Jotform + BTCPay Server

Try it

Get Store On-Chain Wallet Balance with BTCPay Server API on New Scheduled Tasks from Pipedream API

Pipedream + BTCPay Server

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Store On-Chain Wallet Balance on BTCPay Server

Description:Fetches the balance of your on-chain store wallet. [See the documentation](https://docs.btcpayserver.org/API/Greenfield/v1/#operation/StoreOnChainWallets_ShowOnChainWalletOverview)

Version:0.0.1

Key:btcpay_server-get-store-on-chain-wallet-balance

View on GitHub

Code#

import btcPayServer from "../../btcpay_server.app.mjs";

export default {
  key: "btcpay_server-get-store-on-chain-wallet-balance",
  name: "Get Store On-Chain Wallet Balance",
  description: "Fetches the balance of your on-chain store wallet. [See the documentation](https://docs.btcpayserver.org/API/Greenfield/v1/#operation/StoreOnChainWallets_ShowOnChainWalletOverview)",
  version: "0.0.1",
  type: "action",
  props: {
    btcPayServer,
    storeId: {
      propDefinition: [
        btcPayServer,
        "storeId",
      ],
    },
    cryptoCode: {
      type: "string",
      label: "Crypto Code",
      description: "The crypto code of the payment method to fetch. Example: `BTC`",
    },
  },
  async run({ $ }) {
    const response = await this.btcPayServer.getStoreWalletBalance({
      $,
      storeId: this.storeId,
      cryptoCode: this.cryptoCode,
    });
    $.export("$summary", `Fetched balance for wallet ${this.storeId}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
BTCPay Server	`btcPayServer`	`app`	This component uses the BTCPay Server app.
Store ID	`storeId`	`string`	Select a value from the drop down menu.
Crypto Code	`cryptoCode`	`string`	The crypto code of the payment method to fetch. Example: `BTC`