BTCPay Server website screenshot

BTCPay Server

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.

BTCPay Server publishes 31 APIs on the APIs.io network, including API Keys API, Apps API, Authorization API, and 28 more. Tagged areas include Bitcoin, Cryptocurrency, Payments, Lightning Network, and Open Source.

BTCPay Server’s developer surface includes authentication, documentation, engineering blog, YouTube channel, changelog, support, and 11 more developer resources.

🌐 Visit website 📡 Source on GitHub
36.6/100 thin ▬ flat Agent 41/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreeSelf serve⚡ Free to try
31 APIs
BitcoinCryptocurrencyPaymentsLightning NetworkOpen SourceSelf-Hosted

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 36.6/100 · thin
Contract Quality 14.0 / 25
Developer Ergonomics 5.2 / 20
Commercial Clarity 7.9 / 20
Operational Transparency 4.8 / 13
Governance 0.0 / 12
Discoverability 6.9 / 10
Agent readiness — 41/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/btcpay: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 31

Individual APIs this provider publishes, each with its own machine-readable definition.

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

Scroll for all 31

Pricing Plans 1

Published pricing tiers and plan structures.

Plans

2 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Rate Limits

0 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Finops

FINOPS

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Btcpay Authentication

apiKey/http · 2 schemes

SECURITY

Btcpay Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Btcpay Agentic Access

195 operations · 102 acting · 6 human-in-the-loop

195 operations · 102 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation
Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Build 2

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization
 GitHubRepository
GitHubRepository

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Learn 1

Tutorials, courses, talks, and written guidance

YouTube
YouTube

Operate 3

Status, limits, changes, and where to get help

ChangeLog
ChangeLog
 StatusPage
StatusPage
 Support
Support

Commercial 2

Pricing, plans, and the legal terms of use

License
License
 PrivacyPolicy
PrivacyPolicy

Company 3

The organization behind the API

Website
Website
 Blog
Blog
 Twitter
Twitter

Other 2

Properties that don't map to a standard resource type

Mattermost
Mattermost
 Contributing
Contributing

Source (apis.yml)

apis.yml Raw ↑ 
name: BTCPay Server
description: 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.
accessModel:
  pricing: free
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Free · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://btcpayserver.org/images/btcpay-logo.svg
tags:
- Bitcoin
- Cryptocurrency
- Payments
- Lightning Network
- Open Source
- Self-Hosted
created: '2026-06-13'
modified: '2026-06-13'
url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/apis.yml
specificationVersion: '0.19'
apis:
- aid: btcpay:btcpay-api-keys-api
  name: BTCPay Server API Keys API
  description: API Key operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - API Keys
  properties:
  - type: OpenAPI
    url: openapi/btcpay-api-keys-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-apps-api
  name: BTCPay Server Apps API
  description: App operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Apps
  properties:
  - type: OpenAPI
    url: openapi/btcpay-apps-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-authorization-api
  name: BTCPay Server Authorization API
  description: Authorization operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Authorization
  properties:
  - type: OpenAPI
    url: openapi/btcpay-authorization-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-crowdfund-api
  name: BTCPay Server Crowdfund API
  description: Crowdfund operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Crowdfund
  properties:
  - type: OpenAPI
    url: openapi/btcpay-crowdfund-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-files-api
  name: BTCPay Server Files API
  description: File operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Files
  properties:
  - type: OpenAPI
    url: openapi/btcpay-files-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-health-api
  name: BTCPay Server Health API
  description: Health operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Health
  properties:
  - type: OpenAPI
    url: openapi/btcpay-health-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-invoices-api
  name: BTCPay Server Invoices API
  description: Invoice operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Invoices
  properties:
  - type: OpenAPI
    url: openapi/btcpay-invoices-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-lightning-address-api
  name: BTCPay Server Lightning address API
  description: Lightning address configuration
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Lightning address
  properties:
  - type: OpenAPI
    url: openapi/btcpay-lightning-address-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-lightning-internal-node-api
  name: BTCPay Server Lightning (Internal Node) API
  description: Lightning (Internal Node) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Lightning (Internal Node)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-lightning-internal-node-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-lightning-store-api
  name: BTCPay Server Lightning (Store) API
  description: Lightning (Store) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Lightning (Store)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-lightning-store-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-miscelleneous-api
  name: BTCPay Server Miscelleneous API
  description: Miscelleneous operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Miscelleneous
  properties:
  - type: OpenAPI
    url: openapi/btcpay-miscelleneous-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-notifications-current-user-api
  name: BTCPay Server Notifications (Current User) API
  description: Notifications operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Notifications (Current User)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-notifications-current-user-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-payment-requests-api
  name: BTCPay Server Payment Requests API
  description: Payment Requests operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Payment Requests
  properties:
  - type: OpenAPI
    url: openapi/btcpay-payment-requests-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-payout-processors-api
  name: BTCPay Server Payout Processors API
  description: Payout Processors operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Payout Processors
  properties:
  - type: OpenAPI
    url: openapi/btcpay-payout-processors-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-point-of-sale-api
  name: BTCPay Server Point of Sale API
  description: Point of Sale operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Point of Sale
  properties:
  - type: OpenAPI
    url: openapi/btcpay-point-of-sale-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-pull-payments-management-api
  name: BTCPay Server Pull payments (Management) API
  description: Pull payments (Management) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Pull payments (Management)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-pull-payments-management-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-pull-payments-payout-public-api
  name: BTCPay Server Pull payments payout (Public) API
  description: Pull payments payout (Public) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Pull payments payout (Public)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-pull-payments-payout-public-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-pull-payments-public-api
  name: BTCPay Server Pull payments (Public) API
  description: Pull payments (Public) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Pull payments (Public)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-pull-payments-public-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-serveremail-api
  name: BTCPay Server ServerEmail API
  description: Server Email Settings operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - ServerEmail
  properties:
  - type: OpenAPI
    url: openapi/btcpay-serveremail-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-serverinfo-api
  name: BTCPay Server ServerInfo API
  description: Server Info operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - ServerInfo
  properties:
  - type: OpenAPI
    url: openapi/btcpay-serverinfo-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-store-payment-methods-api
  name: BTCPay Server Store (Payment Methods) API
  description: Store Payment Methods operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Store (Payment Methods)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-store-payment-methods-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-store-wallet-on-chain-api
  name: BTCPay Server Store Wallet (On Chain) API
  description: Store Wallet (On Chain) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Store Wallet (On Chain)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-store-wallet-on-chain-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-api
  name: BTCPay Server Stores API
  description: Store operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-email-api
  name: BTCPay Server Stores (Email) API
  description: Store Emails operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Email)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-email-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-payout-processors-api
  name: BTCPay Server Stores (Payout Processors) API
  description: Stores (Payout Processors) operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Payout Processors)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-payout-processors-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-payouts-api
  name: BTCPay Server Stores (Payouts) API
  description: Store pull payment payout operations
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Payouts)
  properties:
  - type: OpenAPI
    url: openapi/btcpay-stores-payouts-api-openapi.yml
  - type: Documentation
    url: https://docs.btcpayserver.org/API/Greenfield/v1/
  - type: JSONLD
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
  - type: Vocabulary
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
  - type: GitHubRepository
    url: https://github.com/btcpayserver/btcpayserver
  - type: Authentication
    url: https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml
- aid: btcpay:btcpay-stores-rates-api
  name: BTCPay Server Stores (Rates) API
  description: Stores rate information and configuration
  humanURL: https://docs.btcpayserver.org/API/Greenfield/v1/
  baseURL: https://{btcpay-host}/api/v1
  tags:
  - Stores (Rates)
  properties:
  - type: 

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/apis.yml