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

BTCPay Server Store (Payment Methods) API

Store Payment Methods operations

BTCPay Server Store (Payment Methods) 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 Store (Payment Methods). 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 4 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version v1.

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

4 operations 2 paths 8 schemas 1 DELETE2 GET1 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
License
Resource Areas
1

Authentication & Security 2

BTCPay Server Store (Payment Methods) 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 4

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

Store (Payment Methods) 4

Store Payment Methods operations

GET
/api/v1/stores/{storeId}/payment-methods
Get store payment methods
StorePaymentMethods_GetStorePaymentMethods 3 params → 200401default
GET
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}
Get store payment method
StorePaymentMethods_GetStorePaymentMethod 3 params → 200401default
PUT
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}
Update store's payment method
StorePaymentMethods_UpdateStorePaymentMethod 2 params body → 200401default
DELETE
/api/v1/stores/{storeId}/payment-methods/{paymentMethodId}
Delete store's payment method
StorePaymentMethods_DeleteStorePaymentMethod 2 params → 200401default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are GenericPaymentMethodData (3 properties), LNURLPayPaymentMethodBaseData (3 properties), OnChainPaymentMethodBaseData (3 properties), UpdatePaymentMethodConfig (2 properties). Each schema is shown below with its type and property counts.

ProblemDetails
object
Description of an error happening during processing of the request
2 properties
OnChainPaymentMethodBaseData
object
3 properties
StoreId
string
Store ID of the item
LightningNetworkPaymentMethodBaseData
object
1 property
GenericPaymentMethodData
object
3 properties
PaymentMethodId
string
Payment method IDs. Available payment method IDs for Bitcoin are: - "BTC-CHAIN": Onchain -"BTC-LN": Lightning - "BTC-LNURL": LNURL
LNURLPayPaymentMethodBaseData
object
3 properties
UpdatePaymentMethodConfig
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

btcpay-store-payment-methods-api-openapi.yml Raw ↑

Other APIs BTCPay Server publishes across the network.

BTCPay Server API Keys API
BTCPay Server Apps API
BTCPay Server Authorization API
BTCPay Server Crowdfund API
BTCPay Server Files API
BTCPay Server Health API
BTCPay Server Invoices API
BTCPay Server Lightning address API
BTCPay Server Lightning (Internal Node) API
BTCPay Server Lightning (Store) API
BTCPay Server Miscelleneous API
BTCPay Server Notifications (Current User) API
Where this information came from

This is an independent, third-party profile of BTCPay Server Store (Payment Methods) 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.