Connect Claude & ChatGPT to BTCPay Server

27 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.

• archive_invoiceDeletesArchive an invoice by `invoice_id` so it is hidden from the invoice list.
• 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_payment_requestChanges dataCreate a payment request page with `title`, `amount`, `currency`, optional `description`, `email`, `expiry_date` and `reference_id`.
• 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_current_userGet the BTCPay Server user you are connected as.
• get_exchange_ratesGet the store's current exchange rates, optionally for specific `currency_pair` values such as BTC_USD.
• 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_payment_requestGet one payment request by `payment_id`, with its amount, status and description.
• get_payoutGet one payout by `payout_id`, with amount, destination and state.
• get_storeGet one store's settings by its store ID (`message_id`).
• get_wallet_overviewGet the on-chain wallet balance for a `payment_method_id` (see list_payment_methods).
• list_appsList the store's apps, such as point-of-sale and crowdfund pages.
• list_notificationsList your BTCPay notifications, optionally only unread ones with `seen` = false.
• list_payment_methodsList the payment methods enabled on the store (for example on-chain BTC or Lightning) and their IDs.
• 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_pull_paymentsList the store's pull payments (refund and payout links), optionally with `include_archived`.
• list_storesList the stores you can access, with their IDs and default currency.
• list_wallet_transactionsList on-chain wallet transactions for a `payment_method_id`, filtered by `status_filter` or `label_filter`.
• 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.
• 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.
• 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.
• update_invoice_metadataChanges dataReplace the `metadata` of an invoice by `invoice_id`, e.g. order ID or buyer details.
• update_payment_requestChanges dataUpdate a payment request by `payment_id`, e.g. `title`, `amount`, `description` or `expiry_date`.

Questions