BTCPay Server

16 tools available

BTCPay Server is a free, open-source, self-hosted Bitcoin payment processor that enables merchants to accept Bitcoin payments without intermediaries.

payment processing ecommerce

Connect BTCPay Server Visit BTCPay Server ↗

Connect BTCPay Server to Definable to recover failed charges, triage refunds against policy, detect churn signals. Personas call BTCPay Server's 16 tools directly from chat or scheduled flows. Hook to a finance or growth persona — react to revenue events the moment they happen.

Common workflows with BTCPay Server

Failed charge recovery

Webhook on failed payment
Persona pulls customer context
Drafts a recovery message

Refund triage

Refund request arrives
Agent checks policy + history
Approves or routes for human review

Subscription churn detection

Pull cancellations
Identify common reasons
Trigger a save-flow

BTCPay Server actions 16

Every BTCPay Server action below is a callable tool any Definable persona can invoke.

Create Payment Request

Creates a new payment request in a BTCPay Server store. Payment requests are shareable pages where customers can create invoices to pay the requested amount. Unlike direct invoices, payment requests can be reused and allow customers to initiate payments themselves. Use this after obtaining a valid store ID from the create_store or get_store actions.

Create Store

Tool to create a new store in BTCPay Server. Use when you need to provision a new store before processing transactions.

Create BTCPay Server User

Tool to create a new BTCPay Server user. Use when you need to register a new user programmatically as an administrator.

Register a Webhook

Registers a new webhook for a BTCPay store to receive real-time notifications when store events occur (e.g., invoice created, payment received, invoice settled). The webhook endpoint receives POST requests with event payloads signed using an HMAC secret for verification.

Delete API Key

Revoke a specific API key to immediately prevent its use for authentication. Use this tool when you need to disable an API key, such as when rotating credentials or when a key may have been compromised. The revocation takes effect immediately. Note: This action requires authentication with an API key that has user management permissions.

Delete Payment Request

Deletes (archives) a specific payment request from a BTCPay Server store. Use this tool when you need to remove or archive an existing payment request. The payment request will be marked as archived and will no longer be active. This operation requires the 'btcpay.store.canmodifypaymentrequests' API permission. Note: This is a destructive operation - once deleted, the payment request cannot be restored.

Cancel Store Payout

Cancels (deletes) a specific payout from a BTCPay Server store. Use this tool when you need to cancel a pending payout that is no longer needed. Only payouts in 'AwaitingApproval' or 'AwaitingPayment' state can be canceled. Payouts that have already been processed or completed cannot be canceled. Requires the 'btcpay.store.canmanagepayouts' permission on the API key.

Get Current API Key

Retrieve information about the current API key. Returns details including the API key string, its label, and the permissions it has been granted. Use this to verify authentication is working and to check what permissions the current API key has. Note: BTCPay Server only provides access to the current API key, not all API keys associated with the user account. This tool is read-only; it cannot create, modify, or delete API keys.

Get Payment Requests

Tool to list all payment requests for a specific store. Use after confirming you have the store ID.

Get BTCPay Server Info

Tool to retrieve information about the BTCPay Server instance. Use when needing server version, tor address, supported payment methods, and synchronization states.

Get Store

Retrieves complete configuration and settings for a specific BTCPay Server store by its ID. Use this tool when you need to: - Get current store settings and configuration - Check store properties like payment methods, currency, invoice expiration, etc. - Verify store exists and is accessible - Retrieve branding/display settings (logo, colors, checkout page settings) Returns comprehensive store data including payment settings, checkout configuration, and branding. Results are scoped to the authenticated user's permissions; insufficient permissions may return restricted or empty data rather than an explicit error.

Get BTCPay Server User

Retrieve information about a BTCPay Server user by ID or email. Use 'me' as the id_or_email parameter to get the currently authenticated user's profile. Alternatively, provide a specific user ID (UUID) or email address to retrieve another user's information. Requires API key with 'btcpay.user.canviewprofile' permission scope. Note: Viewing other users' profiles requires server administrator privileges.

Get Store Webhook

Retrieves detailed configuration of a specific webhook registered for a BTCPay store, including its callback URL, subscribed events, enabled status, and automatic redelivery settings.

List Store Webhooks

Lists all webhooks registered for a BTCPay Server store. Use this to retrieve webhook configurations for management, auditing, or to find webhook IDs for update/delete operations.

List Apps

Retrieve all apps (Point of Sale, Crowdfund, etc.) associated with a specific BTCPay Server store. Returns basic metadata for each app including its ID, name, type, creation timestamp, and archived status. Use this tool when you need to enumerate or discover apps configured within a store.

Update BTCPay Server User

Update the profile of the currently authenticated BTCPay Server user. Use this tool to modify user profile settings like display name, email, profile picture, or password. All fields are optional - only provide fields you want to change. Requires API key with 'btcpay.user.canmodifyprofile' permission scope. Note: Password changes require both currentPassword and newPassword to be provided. Email changes may require re-verification depending on server configuration.

Frequently asked questions

What can I automate with BTCPay Server on Definable?

Anything BTCPay Server exposes through its API. Common payment processing workflows on Definable include recover failed charges, triage refunds against policy, detect churn signals. Personas can call any of the 16 BTCPay Server tools directly, then chain the result into another integration without you writing code.

How does BTCPay Server authentication work?

BTCPay Server uses API_KEY on Definable. You connect once from the integrations page, scoped to the permissions you choose, and from then on any persona that has the integration enabled can act on your behalf. Tokens are encrypted at rest and rotated automatically.

Is the BTCPay Server integration included in my Definable plan?

Yes — every Definable plan, including Starter, includes access to all 16 BTCPay Server tools. You only need a separate BTCPay Server subscription if BTCPay Server itself charges per seat or per API call.

Is using BTCPay Server through Definable secure?

Every call from a persona to BTCPay Server is logged with the user, persona, prompt, and response. Tokens never leave Definable's secrets vault, scopes are configurable per persona, and you can revoke access at any time from the integration page.

How do I get started with BTCPay Server on Definable?

Sign up for Definable, open the integrations page, find BTCPay Server, and connect via OAuth or API key. You can immediately attach BTCPay Server to any persona and start running workflows. The free Starter plan includes 5,000 credits/month.

What BTCPay Server actions does Definable expose?

Definable exposes all 16 BTCPay Server actions as callable tools — including `Create Payment Request`, `Create Store`, `Create BTCPay Server User`, plus 13 more. Each tool gets a typed parameter schema so personas know exactly how to call it.

Ready to automate with BTCPay Server?

Wire it up in minutes. No coding required.

Start for free Schedule a demo

← All integrations