BTCPay Server

BTCPay Server integration (Finance). Imported from open-connector.

API key7 tools{base_url}

GET

btcpay_server_list_stores

List BTCPay Server stores available to the API key.

/stores

GET

btcpay_server_get_store

Get details for a single BTCPay Server store.

/stores/{storeId}

1 parameter

Param	Type	Required	Description
storeId	string	required	The BTCPay Server store ID.

GET

btcpay_server_list_invoices

List invoices for a BTCPay Server store with optional filters.

/stores/{storeId}/invoices

9 parameters

Param	Type	Required	Description
storeId	string	required	The BTCPay Server store ID.
orderIds	array	optional	Order IDs to fetch invoices for. BTCPay Server receives each value as an orderI…
textSearch	string	optional	Search term that helps locate specific invoices.
status	string	optional	The BTCPay Server invoice status.
startDate	number	optional	Unix timestamp in seconds.
endDate	number	optional	Unix timestamp in seconds.
includePaymentMethods	boolean	optional	Whether payment methods should be included in the invoice response.
take	integer	optional	Number of records returned in the response.
skip	integer	optional	Number of records to skip.

GET

btcpay_server_get_invoice

Get details for a single BTCPay Server invoice.

/stores/{storeId}/invoices/{invoiceId}

2 parameters

Param	Type	Required	Description
storeId	string	required	The BTCPay Server store ID.
invoiceId	string	required	The BTCPay Server invoice ID.

POST

btcpay_server_create_invoice

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

/stores/{storeId}/invoices

5 parameters

Param	Type	Required	Description
storeId	string	required	The BTCPay Server store ID.
amount	string	optional	Invoice amount as a decimal string. Omit this for a top-up invoice.
currency	string	optional	Invoice currency code. If omitted, BTCPay Server uses the store default currenc…
metadata	object	optional	Additional invoice metadata accepted by BTCPay Server, such as orderId, buyerEm…
additionalSearchTerms	array	optional	Additional search terms used to find the invoice through text search.

PUT

btcpay_server_update_invoice_metadata

Update metadata for an existing BTCPay Server invoice.

/stores/{storeId}/invoices/{invoiceId}

3 parameters

Param	Type	Required	Description
storeId	string	required	The BTCPay Server store ID.
invoiceId	string	required	The BTCPay Server invoice ID.
metadata	object	required	Additional invoice metadata accepted by BTCPay Server, such as orderId, buyerEm…

POST

btcpay_server_mark_invoice_status

Manually mark a BTCPay Server invoice as invalid or settled.

/stores/{storeId}/invoices/{invoiceId}/status

3 parameters

Param	Type	Required	Description
storeId	string	required	The BTCPay Server store ID.
invoiceId	string	required	The BTCPay Server invoice ID.
status	string	required	Status to manually assign to the invoice.