BTCPay Server MCP integration for AI agents.
Connect AI agents to BTCPay Server through 7 structured actions, including get invoice, create invoice, and get store. Review authentication, inputs, workflo…
- ACTION CONTRACTS
- 7
- AUTHENTICATION
- API key
- SOURCE STATUS
- Provider-backed
CATALOG SOURCE REVIEWED AUGUST 23, 2026 / ACTION NAMES AND SCHEMAS DERIVED FROM WORKING MACHINES PROVIDER SOURCE
CAPABILITY PROFILE
What the BTCPay Server integration exposes
The BTCPay Server Agent App exposes 7 provider-backed actions for finance work. Its current contract lets an authorized agent get details for a single btcpay server invoice, create a btcpay server invoice and return its checkout link and invoice data, and get details for a single btcpay server store. These operations are called through Working Machines as typed capabilities rather than through browser navigation or copied UI steps.
A connection uses API key. Before execution, the agent can inspect the selected action, its required fields, declared scopes, and expected output contract. Provider credentials remain inside the Working Machines runtime; the calling agent receives the capability and its structured result, not the underlying secret.
For reliable operation, start with the narrowest action that satisfies the task, resolve stable provider identifiers before changing state, and validate the returned object or status after execution. Availability still depends on the connected BTCPay Server account, granted provider permissions, workspace policy, region, plan, and upstream API behavior.
VERIFIED ACTION SAMPLE
Real BTCPay Server capabilities.
Showing 7 of 7 actions. Risk labels are conservative signals based on operation names, not substitutes for provider documentation or runtime policy.
get_invoiceREADGet details for a single BTCPay Server invoice.
INPUTS: storeId / invoiceId
create_invoiceWRITECreate a BTCPay Server invoice and return its checkout link and invoice data.
INPUTS: storeId / amount / currency / metadata / additionalSearchTerms
get_storeREADGet details for a single BTCPay Server store.
INPUTS: storeId
list_invoicesREADList invoices for a BTCPay Server store with optional filters.
INPUTS: storeId / orderIds / textSearch / status / startDate
list_storesREADList BTCPay Server stores available to the API key.
mark_invoice_statusREADManually mark a BTCPay Server invoice as invalid or settled.
INPUTS: storeId / invoiceId / status
update_invoice_metadataWRITEUpdate metadata for an existing BTCPay Server invoice.
INPUTS: storeId / invoiceId / metadata
INPUT CONTRACTS
Know what the action needs before it runs.
get_invoice
storeIdREQUIRED- The BTCPay Server store ID.
invoiceIdREQUIRED- The BTCPay Server invoice ID.
create_invoice
storeIdREQUIRED- The BTCPay Server store ID.
amountOPTIONAL- Invoice amount as a decimal string. Omit this for a top-up invoice.
currencyOPTIONAL- Invoice currency code. If omitted, BTCPay Server uses the store default currency.
metadataOPTIONAL- Additional invoice metadata accepted by BTCPay Server, such as orderId, buyerEmail, itemDesc, or custom JSON fields.
additionalSearchTermsOPTIONAL- Additional search terms used to find the invoice through text search.
get_store
storeIdREQUIRED- The BTCPay Server store ID.
list_invoices
storeIdREQUIRED- The BTCPay Server store ID.
orderIdsOPTIONAL- Order IDs to fetch invoices for. BTCPay Server receives each value as an orderId query parameter.
textSearchOPTIONAL- Search term that helps locate specific invoices.
statusOPTIONAL- The BTCPay Server invoice status.
startDateOPTIONAL- Unix timestamp in seconds.
PROVIDER-SPECIFIC WORKFLOWS
Jobs this Agent App can support
Inspect Get Invoice
Get details for a single BTCPay Server invoice. Use this as a bounded discovery step, retain the returned identifier, and avoid expanding the read beyond the task's stated scope.
get_invoiceControl Create Invoice
Create a BTCPay Server invoice and return its checkout link and invoice data. Resolve the target first, present material changes for confirmation, and make retries idempotent where the provider supports it.
create_invoiceVerify with Get Store
Get details for a single BTCPay Server store. Compare the returned provider state with the intended outcome and preserve stable IDs or canonical links in the run record.
get_storeSAFETY BOUNDARY
Operate BTCPay Server with explicit limits
- Authorize BTCPay Server with API key and grant only the provider access required by the selected actions.
- 2 actions are change-capable by name. Confirm the target identity and material parameters before allowing a write.
- Do not infer permission from catalog visibility. Workspace policy, connection identity, and upstream authorization still govern execution.
- No provider scope string is declared on the sampled actions. Verify the connected account's actual permissions in BTCPay Server rather than assuming unrestricted access.
- After a call, inspect the structured result and execution record before reporting that the BTCPay Server task completed successfully.
CONNECTION MODEL
API key
BTCPay Server API key sent with the Authorization header as token authentication. Create or manage API keys from your BTCPay Server user settings, or use the official Greenfield API documentation: https://docs.btcpayserver.org/API/Greenfield/v1/.
Working Machines stores provider credentials behind the execution boundary. An agent can use an authorized connection identity, but catalog discovery alone does not reveal OAuth tokens, API keys, or provider secrets.
- READ SIGNALS
- 5
- WRITE SIGNALS
- 2
- HIGH IMPACT
- 0
- REVIEW SIGNALS
- 0
EVIDENCE AND AVAILABILITY
Provider reference
Action names, input fields, authentication types, and counts on this page are generated from the Working Machines provider catalog. Provider behavior, quotas, object semantics, account eligibility, and regional availability remain governed by BTCPay Server.