Connect BTCPay Server to Your AI Agent

Choose a store and a review range, or provide approved order details for a new invoice. AI can organize payment records and return a checkout link when you request creation.

7 tools API key

Connect BTCPay Server Install OOMOL

Try a BTCPay Server Task

Copy a prompt into your agent with the oo Skill installed. Add your page links and source notes before running it.

oo Skill BTCPay Server

Review Store Invoice Status

Read filtered invoices and selected details to organize payment exceptions for review.

/oo BTCPay Server: List BTCPay Server invoices in store [store ID] for [date range], then read invoices [invoice IDs]. Summarize recorded status and exceptions without manually changing payment status.

Create an Approved Order Invoice

Create an invoice with your amount, currency, and order metadata and report its checkout information.

/oo BTCPay Server: Create a BTCPay Server invoice in store [store ID] for amount [amount] in [currency], using approved order metadata [metadata]. Return its invoice ID and checkout link.

Start Working with BTCPay Server

Install OOMOL

Set up oo CLI and the oo Skill in your agent.
Install OOMOL →
Connect BTCPay Server

Connect with your BTCPay Server URL and an API key.
Connect BTCPay Server →
Give Your Agent a Task

Use /oo with the pages to read, the changes to make, and where to save the result.
Connection Guide →

Choose Your Agent

Codex Claude Code Cursor Hermes

The URL of your BTCPay Server instance.
An API key with permissions for the target stores and requested invoice operations.

BTCPay Server Tools

BTCPay Server invoices associate store payment status with order metadata and checkout information. They support transaction-record reviews and precise invoice creation.

Read Stores and Invoices

List or retrieve stores and read invoices with order, status, search, and time filters.

Create Invoices and Update Metadata

Create invoices and update an existing invoice’s supplied metadata.

7 tools

List Stores

List BTCPay Server stores available to the API key.

btcpay_server.list_stores

Get Store

Get details for a single BTCPay Server store.

btcpay_server.get_store

List Invoices

List invoices for a BTCPay Server store with optional filters.

btcpay_server.list_invoices

Get Invoice

Get details for a single BTCPay Server invoice.

btcpay_server.get_invoice

Create Invoice

Create a BTCPay Server invoice and return its checkout link and invoice data.

btcpay_server.create_invoice

Update Invoice Metadata

Update metadata for an existing BTCPay Server invoice.

btcpay_server.update_invoice_metadata

Mark Invoice Status

Manually mark a BTCPay Server invoice as invalid or settled.

btcpay_server.mark_invoice_status

Frequently Asked Questions

Can I narrow an invoice review to an order or status?

Yes. Supply the store ID with order IDs, a status, search text, or a time range.

Can AI return a checkout link for a new invoice?

Yes. Provide the store, amount, currency, and approved metadata; invoice creation returns the invoice and checkout information.

Does a review mark an invoice as settled?

No. Reading status is separate from manually marking an invoice invalid or settled; manual changes require an explicit request and should not be treated as proof of payment.