BTCPay Server · Authentication Profile

Btcpay Authentication

Authentication

BTCPay Server secures its APIs with apiKey and http across 2 declared security schemes, as derived from its OpenAPI definitions.

BitcoinCryptocurrencyPaymentsLightning NetworkOpen SourceSelf-Hosted
Methods: apiKey, http Schemes: 2 OAuth flows: API key in: header

Security Schemes

API_Key apiKey
· in: header (Authorization)
Basic http
scheme: basic

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-11'
method: derived
source: openapi/openapi.json
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - header
schemes:
- name: API_Key
  type: apiKey
  in: header
  parameter: Authorization
  description: 'BTCPay Server API key. Format: ''token {apiKey}'''
  sources:
  - openapi/openapi.json
- name: Basic
  type: http
  scheme: basic
  description: HTTP Basic Authentication with email and password
  sources:
  - openapi/openapi.json