BTCPay Server for AI agents
Agents read BTCPay Server at once. Changes and sends are held for a person's approval by default.
About BTCPay Server
BTCPay Server is a free, open-source, self-hosted Bitcoin payment processor that enables merchants to accept Bitcoin payments without intermediaries.
What an agent can do in BTCPay Server
Every BTCPay Server action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in BTCPay Server without asking first. 8 actions.
- Get Current API KeyRetrieve 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 ch
- Get Payment RequestsTool to list all payment requests for a specific store. Use after confirming you have the store ID.
- Get BTCPay Server InfoTool to retrieve information about the BTCPay Server instance. Use when needing server version, tor address, supported payment methods, and synchronization states.
- Get StoreRetrieves 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
- Get BTCPay Server UserRetrieve 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
- Get Store WebhookRetrieves 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 WebhooksLists 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 AppsRetrieve 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 st
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 8 actions.
- Create Payment RequestCreates 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 c
- Create StoreTool to create a new store in BTCPay Server. Use when you need to provision a new store before processing transactions.
- Create BTCPay Server UserTool to create a new BTCPay Server user. Use when you need to register a new user programmatically as an administrator.
- 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). The webhook endpoint receives POST req
- Delete API KeyRevoke 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 compromise
- Delete Payment RequestDeletes (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 a
- Cancel Store PayoutCancels (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'
- Update BTCPay Server UserUpdate 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 - on
Changes wait in Needs you
Changes and sends in BTCPay Server are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
BTCPay Server questions
Can an agent change data in BTCPay Server on its own?
Not by default. Changes and sends in BTCPay Server are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in BTCPay Server?
This connector lists 8 read actions. Reads run at once, without waiting for approval.
How does BTCPay Server connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.