How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BTCPay Server

BTCPay Server Invoices API

Invoice operations

Documentation Provider Profile APIs.io OpenAPI GitHub

BTCPay Server Invoices API is one of 31 APIs that BTCPay Server publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invoices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, authentication docs, and rate-limit docs.

This API exposes 11 operations across 8 paths, and defines 29 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, https://{btcpay-host}.

11 operations 8 paths 29 schemas 1 DELETE4 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://{btcpay-host}/api/v1
Authentication
API Key, HTTP Basic
Contact
BTCPay Server
License
MIT
Resource Areas
1

Authentication & Security 2

BTCPay Server Invoices API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (API_Key). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • API_Key — BTCPay Server API key. Format: 'token {apiKey}'
  • Basic — HTTP Basic Authentication with email and password

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Invoices 11

Invoice operations

GET
/api/v1/stores/{storeId}/invoices
Get invoices
Invoices_GetInvoices 9 params → 200401default
POST
/api/v1/stores/{storeId}/invoices
Create a new invoice
Invoices_CreateInvoice 1 param body → 200400403
GET
/api/v1/invoices/{invoiceId}
Get invoice
Invoices_GetInvoice 1 param → 200403404
DELETE
/api/v1/invoices/{invoiceId}
Archive invoice
Invoices_ArchiveInvoice 1 param → 200400403404
PUT
/api/v1/invoices/{invoiceId}
Update invoice
Invoices_UpdateInvoice 1 param body → 200400403404
GET
/api/v1/invoices/{invoiceId}/payment-methods
Get invoice payment methods
Invoices_GetInvoicePaymentMethods 3 params → 200403404
POST
/api/v1/invoices/{invoiceId}/status
Mark invoice status
Invoices_MarkInvoiceStatus 1 param body → 200400403
POST
/api/v1/invoices/{invoiceId}/unarchive
Unarchive invoice
Invoices_UnarchiveInvoice 1 param → 200400403
POST
/api/v1/invoices/{invoiceId}/payment-methods/{paymentMethodId}/activate
Activate Payment Method
Invoices_ActivatePaymentMethod 2 params → 200400403
POST
/api/v1/invoices/{invoiceId}/refund
Refund invoice
Invoices_Refund 1 param body → 200400403
GET
/api/v1/invoices/{invoiceId}/refund/{paymentMethodId}
Get invoice refund trigger data
Invoices_GetInvoiceRefundTriggerData 2 params → 200403404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are InvoicePaymentMethodDataModel (13 properties), CheckoutOptions (10 properties), PullPaymentData (9 properties), InvoiceRefundTriggerData (8 properties). Each schema is shown below with its type and property counts.

CheckoutOptions
object
10 properties
PaymentStatus
string
The status of the payment
InvoiceStatusMark
string
Payment
object
6 properties
InvoiceStatus
string
The status of the invoice
InvoiceMetadata
object
Additional information around the invoice that can be supplied. The mentioned properties are all optional and you can introduce any json format you wish. See […
InvoiceId
string
The invoice ID
MarkInvoiceStatusRequest
object
1 property
PayoutMethodId
string
Payout method IDs. Available payment method IDs for Bitcoin are: - "BTC-CHAIN": Onchain -"BTC-LN": Lightning
TimeSpanMinutes
A span of times in minutes
UpdateInvoiceRequest
object
1 property
SpeedPolicy
string
This is a risk mitigation parameter for the merchant to configure how they want to fulfill orders depending on the number of block confirmations for the transa…
PullPaymentData
object
9 properties
ReceiptOptions
object
3 properties
UnixTimestamp
number
A unix timestamp in seconds
ProblemDetails
object
Description of an error happening during processing of the request
2 properties
TimeSpan
number
InvoiceType
string
The type of the invoice
CreateInvoiceRequest
InvoiceDataBase
object
3 properties
InvoiceDataList
array
PaymentMethodId
string
Payment method IDs. Available payment method IDs for Bitcoin are: - "BTC-CHAIN": Onchain -"BTC-LN": Lightning - "BTC-LNURL": LNURL
InvoiceData
InvoiceAdditionalStatus
string
An additional status that describes why an invoice is in its current status.
RefundInvoiceRequest
object
7 properties 1 required
InvoiceRefundTriggerData
object
8 properties
InvoicePaymentMethodDataModel
object
13 properties
StoreId
string
Store ID of the item
ValidationProblemDetails
array
An array of validation errors of the request

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

btcpay-invoices-api-openapi.yml Raw ↑

Other APIs BTCPay Server publishes across the network.

BTCPay Server API Keys API
AE Profile APIs.io
BTCPay Server Apps API
AE Profile APIs.io
BTCPay Server Authorization API
AE Profile APIs.io
BTCPay Server Crowdfund API
AE Profile APIs.io
BTCPay Server Files API
AE Profile APIs.io
BTCPay Server Health API
AE Profile APIs.io
BTCPay Server Lightning address API
AE Profile APIs.io
BTCPay Server Lightning (Internal Node) API
AE Profile APIs.io
BTCPay Server Lightning (Store) API
AE Profile APIs.io
BTCPay Server Miscelleneous API
AE Profile APIs.io
BTCPay Server Notifications (Current User) API
AE Profile APIs.io
BTCPay Server Payment Requests API
AE Profile APIs.io
#Invoices
← Back to B APIs
API Details
ID
btcpay:btcpay-invoices-api
Base URL
https://{btcpay-host}/api/v1
Docs
https://docs.btcpayserver.org/API/Greenfield/v1/
Provider
BTCPay Server
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=btcpay-invoices-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/btcpay-invoices-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of BTCPay Server Invoices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.