Btcpay Server

Learn how to use Btcpay Server with Composio

Overview

Enum

BTCPAY_SERVER

Description

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

Authentication Details

generic_api_key
string

Actions

Tool to create a new payment request for a store. use after confirming store id.

Action Parameters

amount
numberRequired
currency
stringRequired
customAmount
boolean
description
string
email
string
expiryDate
string
metadata
object
notificationUrl
string
redirectUrl
string
storeId
stringRequired
title
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to create a new store in btcpay server. use when you need to provision a new store before processing transactions.

Action Parameters

defaultCurrency
string
name
stringRequired
website
string

Action Response

data
object
error
string
successful
boolean
Tool to create a new btcpay server user. use when you need to register a new user programmatically as an administrator.

Action Parameters

email
stringRequired
isAdministrator
boolean
password
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to register a new webhook. use when you need to receive store event notifications.

Action Parameters

authorizedEvents
objectRequired
automaticRedelivery
booleanDefaults to True
enabled
booleanDefaults to True
secret
string
storeId
stringRequired
url
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to revoke a specific api key. use when you need to remove an api key to immediately prevent its use. call after identifying the key to revoke.

Action Parameters

apikey
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a specific payment request. use when you need to archive/remove an existing payment request for a store.

Action Parameters

paymentRequestId
stringRequired
storeId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a specific payout from a store. use when you need to cancel a payout no longer needed.

Action Parameters

payoutId
stringRequired
storeId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve the current api key. use after authentication to get api key details.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to list api keys. use when you need to retrieve all api keys associated with the authenticated user.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to list all payment requests for a specific store. use after confirming you have the store id.

Action Parameters

store_id
stringRequired

Action Response

data
array
error
string
successful
boolean
Tool to retrieve information about the btcpay server instance. use when needing server version, tor address, supported payment methods, and synchronization states.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to retrieve information about a specific store. use when you need full store configuration.

Action Parameters

store_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve information about a specific user. use when you need to fetch profile data for a given user id or email.

Action Parameters

id_or_email
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific webhook. use when you need to verify the configuration or status of a webhook for a given store after its creation.

Action Parameters

storeId
stringRequired
webhookId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to list all webhooks registered for a store. use when you need to retrieve the configured webhooks for management or auditing.

Action Parameters

storeId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to list all apps associated with a specific store. use when retrieving basic metadata of every app in that store.

Action Parameters

storeId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to update current user information. use when you need to modify your authenticated user profile on btcpay server.

Action Parameters

currentPassword
string
email
string
imageUrl
string
name
string
newPassword
string

Action Response

data
object
error
string
successful
boolean