# BTCPay Server

**Canonical:** https://apis.io/providers/btcpay/  
**Website:** https://btcpayserver.org  
**APIs profiled:** 31

BTCPay Server is a self-hosted, open-source Bitcoin and cryptocurrency payment processor with a comprehensive REST API (Greenfield API v1) for managing stores, invoices, wallets, Lightning Network nodes, payment requests, pull payments, webhooks, users, and server configuration. It operates with zero fees, no third-party dependency, and is released under the MIT license.

## Kin Score — 33.4 / 100 (thin)

Scored 2026-08-20 under rubric 0.12.0. Trend: flat (-1.9 from 35.3).

| Facet | Score |
|---|---|
| Discoverability | 50.0 |
| Contract Quality | 56.8 |
| Governance | 0.0 |
| Contract Governance | 0.0 |
| Operational Transparency | 36.8 |
| Developer Ergonomics | 28.6 |
| Commercial Clarity | 28.9 |
| Access Clarity | 28.9 |

Regulatory layer — **Payments**: 18.8 (matched via tags).

## Agent readiness — 40.9 (agent-ready)

| Dimension | Value |
|---|---|
| Spec Presence | yes |
| Agentic Access | derived |
| Reversibility Documented | documented |
| MCP Server | no |
| Auth Clarity | yes |
| Idempotency | no |
| Error Semantics | verified |
| OpenAPI Examples | partial |
| Rate Limit Signal | documented |
| Event Surface Described | no |
| Agent Skills | no |
| Well Known Catalog | no |
| Consent Identity | no |
| Agent Card | no |
| Dry Run Mode | no |

## Access

Free · Self-serve signup — onboarding: self-serve, pricing: free, trial: no (confidence: high).

## APIs (31)

- **BTCPay Server API Keys API** — API Key operations
- **BTCPay Server Apps API** — App operations
- **BTCPay Server Authorization API** — Authorization operations
- **BTCPay Server Crowdfund API** — Crowdfund operations
- **BTCPay Server Files API** — File operations
- **BTCPay Server Health API** — Health operations
- **BTCPay Server Invoices API** — Invoice operations
- **BTCPay Server Lightning address API** — Lightning address configuration
- **BTCPay Server Lightning (Internal Node) API** — Lightning (Internal Node) operations
- **BTCPay Server Lightning (Store) API** — Lightning (Store) operations
- **BTCPay Server Miscelleneous API** — Miscelleneous operations
- **BTCPay Server Notifications (Current User) API** — Notifications operations
- **BTCPay Server Payment Requests API** — Payment Requests operations
- **BTCPay Server Payout Processors API** — Payout Processors operations
- **BTCPay Server Point of Sale API** — Point of Sale operations
- **BTCPay Server Pull payments (Management) API** — Pull payments (Management) operations
- **BTCPay Server Pull payments payout (Public) API** — Pull payments payout (Public) operations
- **BTCPay Server Pull payments (Public) API** — Pull payments (Public) operations
- **BTCPay Server ServerEmail API** — Server Email Settings operations
- **BTCPay Server ServerInfo API** — Server Info operations
- **BTCPay Server Store (Payment Methods) API** — Store Payment Methods operations
- **BTCPay Server Store Wallet (On Chain) API** — Store Wallet (On Chain) operations
- **BTCPay Server Stores API** — Store operations
- **BTCPay Server Stores (Email) API** — Store Emails operations
- **BTCPay Server Stores (Payout Processors) API** — Stores (Payout Processors) operations
- **BTCPay Server Stores (Payouts) API** — Store pull payment payout operations
- **BTCPay Server Stores (Rates) API** — Stores rate information and configuration
- **BTCPay Server Stores (Users) API** — Store Users operations
- **BTCPay Server Subscriptions API** — Subscription operations
- **BTCPay Server Users API** — User operations
- **BTCPay Server Webhooks API** — Webhook operations

## Agentic access (1)

- **Btcpay Agentic Access** — 195 operations · 102 acting · 6 human-in-the-loop

## Security (2)

- **Btcpay Authentication** — apiKey/http · 2 schemes
- **Btcpay Domain Security** — TLSv1.3 · HSTS · DMARC

## Plans (1)

- **Plans**

## Tags

Bitcoin, Cryptocurrency, Payments, Lightning Network, Open-Source, Self-Hosted

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/providers/btcpay/). Scores are computed from the provider's own public artifacts under a published rubric.