Integration · Payments

Connect Claude & ChatGPT to BTCPay Server

Ask your AI about the invoices, payments and payouts on your own BTCPay Server. It can find an invoice by order ID, show what was paid per payment method, and create new invoices and payment requests. It can also read your on-chain wallet balance and transactions, see sales from your point-of-sale apps, and create refunds with your approval.

Connect BTCPay Server free

Free plan, no credit card. Takes about a minute.

Try asking

“Has the invoice for order 1087 been paid?”
The AI searches invoices by order ID, reads the status and shows the payments received per method.
“Create an invoice for 250 EUR for [email protected], order 1102.”
It creates the invoice with amount, currency and the order ID and buyer email in the metadata.
“Make a payment request for the March consulting retainer.”
It creates a payment request page with title, amount, currency and an optional expiry date.

What your AI can do

Invoices and payment requests

Search, create and read invoices, see payments per method, update metadata, and create or update payment requests.

Refunds and payouts

Create refunds for paid invoices, and list payouts and pull payments with their amount, destination and state.

Stores, wallet and apps

Read store settings, payment methods, exchange rates, on-chain wallet balance and transactions, and sales from your apps.

“Which invoices expired last week?”
It searches invoices with status Expired within the date range and lists them.
“What is the on-chain wallet balance and what came in recently?”
It finds the payment method, reads the wallet balance and lists recent wallet transactions.
“Refund invoice 7Hk2 at the rate the customer paid.”
It creates a refund with the RateThen option. The customer claims it from a link, and money leaves your wallet.

197 tools for BTCPay Server

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

approve_userVisible to othersApprove a user (id or email). Has effects visible outside this system. API summary: Toggle user approval.
archive_a_pull_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Archive a pull payment.
archive_invoiceDeletesArchive an invoice by `invoice_id` so it is hidden from the invoice list.
create_a_new_pull_paymentChanges dataCreate a new payment for a message. API summary: Create a new pull payment.
create_api_keyChanges dataCreate a new api key.
create_app_imageChanges dataCreate a new image for a app. API summary: Uploads an image for an app item.
create_broadcastVisible to othersCreate a new broadcast. Required: transaction. Has effects visible outside this system. API summary: Broadcast an on-chain transaction or finalized PSBT.
create_crowdfundChanges dataCreate a new crowdfund. API summary: Create a new Crowdfund app.
create_delivery_redeliverDeletesCreate a new redeliver for a delivery. Destructive action; may require approval. API summary: Redeliver the delivery.
create_documentChanges dataCreate a new document. API summary: Uploads a file.
create_generateChanges dataCreate a new generate. API summary: Generate store on-chain wallet.
create_invoiceChanges dataCreate an invoice for a customer to pay, with `amount` and `currency` (store default if empty). Put details such as orderId or buyerEmail in `metadata`. Leave `amount` empty for a top-up invoice.
create_lightning_addressChanges dataCreate a new address for a lightning. API summary: Get deposit address.
create_lightning_channelChanges dataCreate a new channel for a lightning. API summary: Open channel.
create_lightning_channel_store_lightning_node_api_open_channelChanges dataCreate a new channel for a lightning. API summary: Open channel.
create_lightning_connectChanges dataCreate a new connect for a lightning. API summary: Connect to lightning node.
create_lightning_connect_store_lightning_node_api_connect_to_nodChanges dataCreate a new connect for a lightning. API summary: Connect to lightning node.
create_lightning_invoiceChanges dataCreate a new invoice for a lightning. Search invoices first to avoid duplicates. API summary: Create lightning invoice.
create_lightning_invoice_store_lightning_node_api_create_invoiceChanges dataCreate a new invoice for a lightning. Search invoices first to avoid duplicates. API summary: Create lightning invoice.
create_messageChanges dataCreate a new message. API summary: Create a new store.
create_message_logoChanges dataCreate a new logo for a message. API summary: Uploads a logo for the store.
create_message_offeringChanges dataCreate a new offering for a message. Required: app name. API summary: Create an offering.
create_message_payoutMoves moneyCreate a new payout for a message. Financial or irreversible action; may require approval. API summary: Create Payout.
create_message_userChanges dataCreate a new user for a message. API summary: Add or invite a store user.
create_message_webhookDeletesCreate a new webhook for a message. Destructive action; may require approval.
create_objectChanges dataCreate a new object. API summary: Add/Update store on-chain wallet objects.
create_object_linkChanges dataCreate a new link for a object. API summary: Add/Update store on-chain wallet object link.
create_offering_planChanges dataCreate a new plan for a offering. API summary: Create an offering plan.
create_paymentChanges dataCreate a new payment. API summary: Create store on-chain wallet transaction.
create_payment_boltcardChanges dataCreate a new boltcard for a payment. Required: uid. API summary: Link a boltcard to a pull payment.
create_payment_payoutMoves moneyCreate a new payout for a payment. Financial or irreversible action; may require approval. API summary: Create Payout.
create_payment_requestChanges dataCreate a payment request page with `title`, `amount`, `currency`, optional `description`, `email`, `expiry_date` and `reference_id`.
create_payout_markMoves moneyCreate a new mark for a payout. Financial or irreversible action; may require approval. API summary: Mark Payout.
create_plan_checkoutChanges dataCreate a new plan checkout. API summary: Create a plan checkout session.
create_poChanges dataCreate a new po. API summary: Create a new Point of Sale app.
create_subscriber_portalChanges dataCreate a new subscriber portal. API summary: Create a subscriber portal session.
create_subscriber_suspendChanges dataCreate a new suspend for a subscriber. API summary: Suspend a subscriber.
create_subscriber_unsuspendChanges dataCreate a new unsuspend for a subscriber. API summary: Unsuspend a subscriber.
create_userChanges dataCreate a new user. API summary: Uploads a profile picture for the current user.
create_user_api_keyVisible to othersCreate a new api key for a user. Has effects visible outside this system.
create_user_invitationVisible to othersCreate a new invitation for a user. Has effects visible outside this system. API summary: Resend a store invitation.
create_user_users_create_userChanges dataCreate a new user. API summary: Create user.
delete_addressesMoves moneyPermanently delete a address by payment method id. Financial or irreversible action; may require approval. API summary: UnReserve last store on-chain wallet address.
delete_api_keyDeletesPermanently delete a api key by api key id. Destructive action; may require approval. API summary: Revoke an API Key.
delete_appDeletesPermanently delete a app by app id. Destructive action; may require approval. API summary: Delete app.
delete_app_imageDeletesPermanently delete a image by file id. Destructive action; may require approval. API summary: Deletes the app item image.
delete_currentsMoves moneyPermanently delete a current. Financial or irreversible action; may require approval. API summary: Revoke the current API Key.
delete_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete file.
delete_linkDeletesPermanently delete a link by link id. Destructive action; may require approval. API summary: Remove store on-chain wallet object links.
delete_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Remove Store.
delete_message_addressDeletesPermanently delete a address by username. Destructive action; may require approval. API summary: Remove configured lightning address.
delete_message_logosMoves moneyPermanently delete a logo by store id. Financial or irreversible action; may require approval. API summary: Deletes the store logo.
delete_message_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Delete store's payment method.
delete_message_payout_processorMoves moneyPermanently delete a payout processor by payment method id. Financial or irreversible action; may require approval. API summary: Remove store configured payout processor.
delete_message_userDeletesPermanently delete a user by id or email. Destructive action; may require approval. API summary: Remove Store User.
delete_notificationDeletesPermanently delete a notification by notification id. Destructive action; may require approval. API summary: Remove Notification.
delete_objectDeletesPermanently delete a object by object id. Destructive action; may require approval. API summary: Remove store on-chain wallet objects.
delete_offering_subscriberDeletesPermanently delete a subscriber by customer selector. Destructive action; may require approval.
delete_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Archive payment request.
delete_payoutMoves moneyPermanently delete a payout by payout id. Financial or irreversible action; may require approval. API summary: Cancel Payout.
delete_userDeletesPermanently delete a user by id or email. Destructive action; may require approval. API summary: Delete user.
delete_user_api_keyDeletesPermanently delete a api key by api key id. Destructive action; may require approval. API summary: Revoke an API Key of target user.
delete_user_invitationsMoves moneyPermanently delete a invitation by id or email. Financial or irreversible action; may require approval. API summary: Cancel a store invitation.
delete_usersMoves moneyPermanently delete a user. Financial or irreversible action; may require approval. API summary: Deletes user profile.
delete_users_users_delete_current_user_profile_pictureMoves moneyPermanently delete a user. Financial or irreversible action; may require approval. API summary: Deletes user profile picture.
delete_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval.
get_all_usersList users. API summary: Get all users.
get_appGet one app by `app_id`.
get_app_salesGet sales statistics for an app by `app_id` over the last `number_of_days`.
get_app_top_itemsGet the best-selling items of an app by `app_id`.
get_channelsList channels for a lightning. API summary: Get channels.
get_configurationGet one configuration by rate source. API summary: Get store rate settings for the specified rate source.
get_crowdfundGet one crowdfund by app id. API summary: Get crowdfund app data.
get_current_userGet the BTCPay Server user you are connected as.
get_deposit_addressChanges dataCreate a new address for a lightning. API summary: Get deposit address.
get_documentGet one document by document id. API summary: Get file.
get_exchange_ratesGet the store's current exchange rates, optionally for specific `currency_pair` values such as BTC_USD.
get_iGet one i by invoice id. API summary: Invoice checkout.
get_invoiceGet one invoice by `invoice_id`, with amount, currency, status and metadata.
get_invoice_paymentsGet the payment methods and payments received for an invoice by `invoice_id`, including amounts paid and due per method.
get_invoice_refundGet one refund for a invoice by payment method id. API summary: Get invoice refund trigger data.
get_invoicesList invoices for a lightning. Optional filters: pending only or offset index. API summary: Get invoices.
get_lightning_automated_payout_sender_factoryGet one lightning automated payout sender factory by payout method id. API summary: Get configured store Lightning automated payout processors.
get_lightning_invoiceGet one invoice for a lightning by invoice id. API summary: Get invoice.
get_lightning_invoice_store_lightning_node_api_get_invoiceGet one invoice for a lightning by invoice id. API summary: Get invoice.
get_lightning_paymentGet one payment for a lightning by payment hash. API summary: Get payment.
get_message_addressGet one address for a message by username. API summary: Get store configured lightning address.
get_message_offeringGet one offering for a message by offering id. API summary: Get an offering.
get_message_paymentGet one payment for a message by payment id. API summary: Get store payment method.
get_node_balanceList balances for a lightning. API summary: Get node balance.
get_node_balance_histogramList histograms for a lightning. API summary: Get node balance histogram.
get_node_informationList infos for a lightning. API summary: Get node information.
get_notificationGet one notification by notification id. API summary: Get notification.
get_objectGet one object by object id. API summary: Get store on-chain wallet object.
get_offering_planGet one plan for a offering by plan id. API summary: Get an offering plan.
get_offering_subscriberGet one subscriber for a offering by customer selector. API summary: Get a subscriber.
get_on_chain_automated_payout_sender_factoryGet one on chain automated payout sender factory by payment method id. API summary: Get configured store onchain automated payout processors.
get_paymentGet one payment for a lightning by payment hash. API summary: Get payment.
get_payment_payoutGet one payout for a payment by payout id. API summary: Get Payout.
get_payment_previewGet one payment by payment method id. Results are paginated. API summary: Preview store on-chain payment method addresses.
get_payment_requestGet one payment request by `payment_id`, with its amount, status and description.
get_paymentsList payments for a lightning. Optional filters: include pending or offset index. API summary: Get payments.
get_payoutGet one payout by `payout_id`, with amount, destination and state.
get_plan_checkoutGet one plan checkout by checkout id. API summary: Get a plan checkout.
get_poGet one po by app id. API summary: Get Point of Sale app data.
get_pull_paymentGet one payment by payment id. API summary: Get Pull Payment.
get_storeGet one store's settings by its store ID (`message_id`).
get_store_email_settingsVisible to othersEmail a message (store id). Has effects visible outside this system. API summary: Get store email settings.
get_store_on_chain_wallet_transactionGet one payment by payment id. API summary: Get store on-chain wallet transaction.
get_subscriber_creditGet one credit for a subscriber by currency. API summary: Get subscriber credit balance.
get_subscriber_portalGet one subscriber portal by portal session id. API summary: Get a subscriber portal session.
get_userGet one user by id or email. API summary: Get user by ID or Email.
get_wallet_overviewGet the on-chain wallet balance for a `payment_method_id` (see list_payment_methods).
get_webhookGet one webhook by webhook id. API summary: Get a webhook.
get_webhook_shipmentGet one shipment for a webhook by shipment id. API summary: Get a webhook delivery.
list_addressesList addresses. Optional filters: force generate. API summary: Get store on-chain wallet address.
list_appsList the store's apps, such as point-of-sale and crowdfund pages.
list_apps_2List apps. API summary: Get basic app data for all apps for all stores for a user.
list_currentsList currents. API summary: Get the current API Key information.
list_delivery_requestsList requests for a delivery. API summary: Get the delivery's request.
list_documentsList documents. API summary: Get all files.
list_feeratesList feerates. Optional filters: block target. API summary: Get store on-chain wallet fee rate.
list_histogramsList histograms. API summary: Get store on-chain wallet balance histogram.
list_infosList infos. API summary: Get server info.
list_invitationsList invitations. API summary: Get pending store invitations.
list_langsList langs. API summary: Language codes.
list_lightning_automated_payout_sender_factoriesList lightning automated payout sender factories. API summary: Get configured store Lightning automated payout processors.
list_lightning_balancesList balances for a lightning. API summary: Get node balance.
list_lightning_channelsList channels for a lightning. API summary: Get channels.
list_lightning_histogramsList histograms for a lightning. API summary: Get node balance histogram.
list_lightning_infosList infos for a lightning. API summary: Get node information.
list_lightning_invoicesList invoices for a lightning. Optional filters: pending only or offset index. API summary: Get invoices.
list_lightning_paymentsList payments for a lightning. Optional filters: include pending or offset index. API summary: Get payments.
list_message_addressesList addresses for a message. API summary: Get store configured lightning addresses.
list_message_offeringsList offerings for a message. API summary: List offerings for a store.
list_message_rolesList roles for a message. API summary: Get store's roles.
list_message_usersList users for a message. API summary: Get store users.
list_message_webhooksList webhooks for a message. API summary: Get webhooks of a store.
list_notification_settingsList notification settings. API summary: Get notification settings.
list_notificationsList your BTCPay notifications, optionally only unread ones with `seen` = false.
list_objectsList objects. Optional filters: ids, type or include neighbour data. API summary: Get store on-chain wallet objects.
list_on_chain_automated_transfer_sender_factoriesList on chain automated transfer sender factories. API summary: Get configured store onchain automated payout processors.
list_payment_lnurlsList lnurls for a payment. API summary: Get Pull Payment LNURL details.
list_payment_methodsList the payment methods enabled on the store (for example on-chain BTC or Lightning) and their IDs.
list_payment_payoutsList payouts for a payment. Optional filters: include cancelled. API summary: Get Payouts.
list_payment_requestsList the store's payment requests (long-lived payment pages).
list_payoutsList the store's payouts (including refunds waiting to be paid), optionally with `include_cancelled`.
list_permissionsList permissions. API summary: Permissions metadata.
list_pull_paymentsList the store's pull payments (refund and payout links), optionally with `include_archived`.
list_rate_sourcesList rate sources. API summary: Get available rate sources.
list_rolesList roles. API summary: Get store's roles.
list_storesList the stores you can access, with their IDs and default currency.
list_utxosList utxos. API summary: Get store on-chain wallet UTXOS.
list_wallet_transactionsList on-chain wallet transactions for a `payment_method_id`, filtered by `status_filter` or `label_filter`.
list_webhook_shipmentsList shipments for a webhook. Results are paginated. API summary: Get latest deliveries.
mark_invoice_statusChanges dataManually mark an invoice by `invoice_id` as settled or invalid with `status`. Use only when a payment was handled outside BTCPay.
patch_store_on_chain_wallet_transaction_infoChanges dataUpdate an existing payment identified by payment id. Only the fields you pass are changed. API summary: Patch store on-chain wallet transaction info.
pay_invoiceMoves moneyPay a invoice (crypto code). Financial or irreversible action; may require approval. API summary: Pay Lightning Invoice.
pay_invoice_payMoves moneyPay a invoice (crypto code). Financial or irreversible action; may require approval. API summary: Pay Lightning Invoice.
pay_message_processorsMoves moneyPayout a message (store id). Financial or irreversible action; may require approval. API summary: Get store configured payout processors.
pay_paymentMoves moneyPay a payment (payment request id). Financial or irreversible action; may require approval. API summary: Create a new invoice for the payment request.
pay_processorMoves moneyPayout a processor. Financial or irreversible action; may require approval. API summary: Get payout processors.
refund_invoiceMoves moneyCreate a refund for a paid invoice by `invoice_id`. `refund_variant` sets the amount: RateThen (crypto at the rate paid), CurrentRate, Fiat, OverpaidAmount or Custom (with `custom_amount` and `custom_currency`). The customer claims the refund from a link; this moves money.
restore_invoiceChanges dataUnarchive a invoice (invoice id). API summary: Unarchive invoice.
search_invoicesSearch the store's invoices by `text_search`, `status` (New, Processing, Settled, Expired, Invalid), `order_id` or date range (`start_date`/`end_date` as Unix timestamps). Use this to find an invoice ID.
send_an_email_for_a_storeVisible to othersSend a message (store id). Has effects visible outside this system. API summary: Send an email for a store.
send_messageVisible to othersEmail a message. Has effects visible outside this system. API summary: Get server email settings.
submit_configurationVisible to othersPreview a configuration (store id). Has effects visible outside this system. API summary: Preview rate configuration results.
submit_invoiceVisible to othersActivate a invoice (payment method id). Has effects visible outside this system. API summary: Activate Payment Method.
submit_paymentVisible to othersPreview a payment (payment method id). Has effects visible outside this system. API summary: Preview proposed store on-chain payment method addresses.
submit_payoutMoves moneyMark paid a payout (payout id). Financial or irreversible action; may require approval. API summary: Mark Payout as Paid.
submit_userVisible to othersLock a user (id or email). Has effects visible outside this system. API summary: Toggle user lock out.
update_configurationChanges dataUpdate an existing configuration identified by rate source. API summary: Get store rate settings for the specified rate source.
update_crowdfundChanges dataUpdate an existing crowdfund identified by app id. API summary: Update a Crowdfund app.
update_invoice_metadataChanges dataReplace the `metadata` of an invoice by `invoice_id`, e.g. order ID or buyer details.
update_lightning_automated_payout_sender_factoryMoves moneyUpdate an existing lightning automated payout sender factory identified by payout method id. Financial or irreversible action; may require approval. API summary: Update configured store Lightning automated payout processors.
update_messageChanges dataUpdate an existing message identified by message id. API summary: Update store.
update_message_addressChanges dataUpdate an existing address identified by username. API summary: Add or update store configured lightning address.
update_message_offeringChanges dataUpdate an existing offering identified by offering id. API summary: Update an offering.
update_message_paymentChanges dataUpdate an existing payment identified by payment id. API summary: Update store's payment method.
update_message_userVisible to othersUpdate an existing user identified by id or email. Has effects visible outside this system. API summary: Update a store user role.
update_message_usersVisible to othersUpdate an existing user identified by store id. Has effects visible outside this system. API summary: Update a store user role.
update_notificationChanges dataUpdate an existing notification identified by notification id. API summary: Update notification.
update_notification_settingsVisible to othersUpdate an existing notification setting. Has effects visible outside this system. API summary: Update notification settings.
update_offering_planChanges dataUpdate an existing plan identified by plan id. API summary: Update an offering plan.
update_on_chain_automated_payout_sender_factoryMoves moneyUpdate an existing on chain automated payout sender factory identified by payment method id. Financial or irreversible action; may require approval. API summary: Update configured store onchain automated payout processors.
update_on_chain_automated_transfer_sender_factoriesMoves moneyUpdate an existing on chain automated transfer sender factory identified by store id. Financial or irreversible action; may require approval. API summary: Update configured store onchain automated payout processors.
update_payment_requestChanges dataUpdate a payment request by `payment_id`, e.g. `title`, `amount`, `description` or `expiry_date`.
update_payoutMoves moneyUpdate an existing payout identified by payout id. Financial or irreversible action; may require approval. API summary: Approve Payout.
update_plan_checkoutChanges dataUpdate an existing plan checkout identified by checkout id. API summary: Proceed with a plan checkout.
update_poChanges dataUpdate an existing po identified by app id. API summary: Update a Point of Sale app.
update_server_email_settingsDeletesEmail a message. Destructive action; may require approval. API summary: Update server email settings.
update_store_email_settingsVisible to othersEmail a message (store id). Has effects visible outside this system. API summary: Update store email settings.
update_subscriber_creditChanges dataUpdate an existing credit identified by currency. API summary: Update subscriber credit balance.
update_subscriber_datesVisible to othersUpdate an existing date identified by customer selector. Has effects visible outside this system. API summary: Update subscriber dates.
update_usersVisible to othersUpdate an existing user. Has effects visible outside this system. API summary: Update current user information.
update_webhookDeletesUpdate an existing webhook identified by webhook id. Destructive action; may require approval. API summary: Update a webhook.

Set up in three steps

1
Pick the app
Create a free HeyMyApps account and choose BTCPay Server from the app list.
2
Paste your key
Paste your BTCPay Server address (for example https://btcpay.example.com), an API key and your Store ID. In BTCPay Server, open Account > Manage account > API keys, click Generate key, tick only the permissions you need (for example view and create invoices, view stores) and copy the key.
3
Add the link to your AI
You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:
1. Click your name, then Settings › Connectors › Add custom connector.
2. Paste your link as the Remote MCP server URL.
3. Switch it on from the + menu in a chat.

Questions

What can the AI do in BTCPay Server?

It can search and read invoices and their payments, payment requests, payouts, pull payments, stores, payment methods, exchange rates, apps and their sales, notifications and on-chain wallet transactions. It can create invoices and payment requests, update invoice metadata and payment requests, mark or archive invoices, and create refunds.

Does the AI see my BTCPay Server API key?

No. You paste your BTCPay Server API key into HeyMyApps once. It is encrypted at rest, never shown to the AI and never shown again after you save it, not even to you. The AI only sees the results of the tools it calls.

Can I control what the AI is allowed to do?

Yes. You choose which tools are switched on, so you can start read-only. Creating a refund moves money, and marking an invoice as settled or invalid changes its status by hand. Both can require your approval before they run. Every tool call is logged.

Does it work with ChatGPT?

Yes. In ChatGPT, open Settings › Apps & Connectors › Advanced, turn on Developer mode and add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.

What does it cost?

HeyMyApps has a free plan, and you do not need a credit card to start. Paid plans are billed per completed task. You connect your own BTCPay Server account on your own server, and HeyMyApps connects to it with the API key you give it.

Does it work with my own BTCPay Server?

Yes. You enter the address of your own server together with the API key and Store ID, and HeyMyApps calls that server. The permissions you tick when you generate the key limit what the key can do, on top of the tools you switch on in HeyMyApps.