BTCPay Server

Best way to accept Bitcoin. No fees, no intermediary. Free, open source & self-hosted Bitcoin payment processor for self-sovereign individuals and businesses.

Go to site
Explore
/
Apps
/
BTCPay Server

BTCPay Server API Integrations

Build and run workflows using the BTCPay Server API. Use 1000s of source-available triggers and actions across 2,100+ apps. Or write custom code to integrate any app or API in seconds.

Overview

The BTCPay Server API provides a robust interface for automating payment processing, managing invoices, and overseeing stores within a BTCPay Server instance. Leveraging Pipedream, you can build powerful serverless workflows that react to events in BTCPay Server, such as new payments or invoice statuses, and integrate with countless other services through Pipedream's platform.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    btcpay_server: {
      type: "app",
      app: "btcpay_server",
    }
  },
  async run({steps, $}) {
    return await axios($, {
      url: `https://${this.btcpay_server.$auth.base_url}/api/v1/users/me`,
      headers: {
        "Authorization": `token ${this.btcpay_server.$auth.api_key}`,
      },
    })
  },
})

Choose an API to Connect with BTCPay Server API

1
-
24
of
2,100+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

Example Use Cases

  • Invoice Status Change Notifications: When an invoice status changes in BTCPay Server, you can set up a workflow in Pipedream to send a notification to a Slack channel, inform your team, or update a record in a Google Sheet, keeping all stakeholders in the loop about payment statuses in real-time.

  • Automate Refund Processing: If a payment is made over the expected amount, create a Pipedream workflow that triggers a refund process. This could connect to BTCPay Server to calculate the excess and then issue a refund via the original payment method or notify an admin to handle the refund manually.

  • Sync Payments to Accounting Software: After receiving a payment, a Pipedream workflow can automatically log this transaction in your accounting software, such as QuickBooks or Xero. This automation ensures that your financial records are always up-to-date without manual data entry.

Get Store On-Chain Wallet Balance with BTCPay Server API on New Requests from HTTP / Webhook API
HTTP / Webhook + BTCPay Server
 
Try it
Get Store On-Chain Wallet Balance with BTCPay Server API on New Item in Feed from RSS API
RSS + BTCPay Server
 
Try it
Get Store On-Chain Wallet Balance with BTCPay Server API on New Message (Instant) from Discord API
Discord + BTCPay Server
 
Try it
Get Store On-Chain Wallet Balance with BTCPay Server API on New Message In Channels (Instant) from Slack API
Slack + BTCPay Server
 
Try it
Get Store On-Chain Wallet Balance with BTCPay Server API on New Message in Channel from Discord Bot API
Discord Bot + BTCPay Server
 
Try it
Create Payment Request with the BTCPay Server API

Generates a new payment request for a user. See the documentation

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

Fetches the balance of your on-chain store wallet. See the documentation

 
Try it

Authentication

BTCPay Server uses API keys for authentication. When you connect your BTCPay Server account, Pipedream securely stores the keys so you can easily authenticate to BTCPay Server APIs in both code and no-code steps.