16 available actions

What your AI agent can do in BTCPay Server

BTCPay Server is a free, open-source, self-hosted Bitcoin payment processor that enables merchants to accept Bitcoin payments without intermediaries. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.

Common starting points

Get Payment RequestsTool to list all payment requests for a specific store.
Get BTCPay Server InfoTool to retrieve information about the BTCPay Server instance.
Create Payment RequestCreates a new payment request in a BTCPay Server store.
Create StoreTool to create a new store in BTCPay Server.
Update BTCPay Server UserUpdate the profile of the currently authenticated BTCPay Server user.
Delete Payment RequestDeletes (archives) a specific payment request from a BTCPay Server store.

Browse all 16 actions by capability

Open a capability to see every supported action and its description.

Find & reviewLook up and review existing recordsView 8 actionsHide actions

Get Current API KeyRetrieve information about the current API key.
Get Payment RequestsTool to list all payment requests for a specific store.
Get BTCPay Server InfoTool to retrieve information about the BTCPay Server instance.
Get StoreRetrieves complete configuration and settings for a specific BTCPay Server store by its ID.
Get BTCPay Server UserRetrieve information about a BTCPay Server user by ID or email.
Get Store WebhookRetrieves detailed configuration of a specific webhook registered for a BTCPay store, including its callback URL, subscribed events, enabled status, and automatic…
List Store WebhooksLists all webhooks registered for a BTCPay Server store.
List AppsRetrieve all apps (Point of Sale, Crowdfund, etc.) associated with a specific BTCPay Server store.

Create & communicateCreate records or send supported messagesView 3 actionsHide actions

Create Payment RequestCreates a new payment request in a BTCPay Server store.
Create StoreTool to create a new store in BTCPay Server.
Create BTCPay Server UserTool to create a new BTCPay Server user.

Update & manageChange and manage existing recordsView 1 actionHide actions

Update BTCPay Server UserUpdate the profile of the currently authenticated BTCPay Server user.

Remove & cancelRemove records or cancel supported workView 3 actionsHide actions

Delete API KeyRevoke a specific API key to immediately prevent its use for authentication.
Delete Payment RequestDeletes (archives) a specific payment request from a BTCPay Server store.
Cancel Store PayoutCancels (deletes) a specific payout from a BTCPay Server store.

Other actionsSpecialist and administrative actions.View 1 actionHide actions

Register a WebhookRegisters a new webhook for a BTCPay store to receive real-time notifications when store events occur (e.g., invoice created, payment received, invoice settled).

Connection record

A connection you can control.

Sign-in: Customer-managed key
Setup: Use a key you create and control. It is stored securely and limited to the work agreed for the role.
Boundaries: Only the approved role and actions.
Off switch: Revoke the connection from your account.

FAQ

Before you connect BTCPay Server

How does the agent connect to BTCPay Server?

With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.

What can the agent actually do in BTCPay Server?

The page above lists the 16 actions currently available through the BTCPay Server connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.

Is BTCPay Server included in my plan?

Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.

How long until BTCPay Server is ready?

Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.

Bring the workflow together

Ready to put BTCPay Server to work?

Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.

Book a setup call Browse all connections

All product names, logos, and brands are property of their respective owners and are used for identification only. ZeroToClaw is not affiliated with or endorsed by BTCPay Server.