BTCPay Server

BTCPay Server Store (Payment Methods) API

Store Payment Methods operations

GitHub OpenAPI

Operations 4

GET /api/v1/stores/{storeId}/payment-methods Get store payment methods #
GET /api/v1/stores/{storeId}/payment-methods/{paymentMethodId} Get store payment method #
PUT /api/v1/stores/{storeId}/payment-methods/{paymentMethodId} Update store's payment method #
DELETE /api/v1/stores/{storeId}/payment-methods/{paymentMethodId} Delete store's payment method #

Documentation

📖
Documentation
https://docs.btcpayserver.org/API/Greenfield/v1/
📖
Authentication
https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/rate-limits/rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/openapi/btcpay-store-payment-methods-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/btcpayserver/btcpayserver

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/json-ld/api.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/vocabulary/vocabulary.json
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/plans/plans.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/btcpay/refs/heads/main/finops/finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/btcpay-store-payment-methods-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

btcpay-store-payment-methods-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BTCPay Greenfield Store (Payment Methods) API
  version: v1
  description: '# Introduction


    The BTCPay Server Greenfield API is a REST API.'
  contact:
    name: BTCPay Server
    url: https://btcpayserver.org
  license:
    name: MIT
    url: https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE
servers:
- url: https://{btcpay-host}
  description: Your BTCPay Server instance
  variables:
    btcpay-host:
      default: mainnet.demo.btcpayserver.org
      description: The hostname of your BTCPay Server instance
security:
- API_Key: []
  Basic: []
tags:
- name: Store (Payment Methods)
  description: Store Payment Methods operations
paths:
  /api/v1/stores/{storeId}/payment-methods:
    get:
      tags:
      - Store (Payment Methods)
      summary: Get store payment methods
      description: View information about the stores' configured payment methods
      operationId: StorePaymentMethods_GetStorePaymentMethods
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - name: onlyEnabled
        in: query
        required: false
        description: Fetch payment methods that are enabled/disabled only
        schema:
          type: boolean
      - name: includeConfig
        in: query
        required: false
        description: Fetch the config of the payment methods, if `true`, the permission `btcpay.store.canmodifystoresettings` is required.
        schema:
          type: boolean
      responses:
        '200':
          description: List of payment methods
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GenericPaymentMethodData'
        '401':
          description: Missing authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
  /api/v1/stores/{storeId}/payment-methods/{paymentMethodId}:
    get:
      tags:
      - Store (Payment Methods)
      summary: Get store payment method
      description: View information about the stores' configured payment method
      operationId: StorePaymentMethods_GetStorePaymentMethod
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - name: includeConfig
        in: query
        required: false
        description: Fetch the config of the payment methods, if `true`, the permission `btcpay.store.canmodifystoresettings` is required.
        schema:
          type: boolean
      - $ref: '#/components/parameters/PaymentMethodId'
      responses:
        '200':
          description: The payment method config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericPaymentMethodData'
        '401':
          description: Missing authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
    put:
      tags:
      - Store (Payment Methods)
      summary: Update store's payment method
      description: Update information about the stores' configured payment method
      operationId: StorePaymentMethods_UpdateStorePaymentMethod
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/PaymentMethodId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentMethodConfig'
      responses:
        '200':
          description: The payment method config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericPaymentMethodData'
        '401':
          description: Missing authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - API_Key:
        - btcpay.store.canmodifystoresettings
        Basic: []
    delete:
      tags:
      - Store (Payment Methods)
      summary: Delete store's payment method
      description: Delete information about the stores' configured payment method
      operationId: StorePaymentMethods_DeleteStorePaymentMethod
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/PaymentMethodId'
      responses:
        '200':
          description: The configuration got deleted
        '401':
          description: Missing authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - API_Key:
        - btcpay.store.canmodifystoresettings
        Basic: []
components:
  schemas:
    UpdatePaymentMethodConfig:
      type: object
      properties:
        enabled:
          type:
          - boolean
          - 'null'
          description: Whether the payment method is enabled, leave null or unspecified to not change current setting
          default: null
          example: true
        config:
          type:
          - object
          - 'null'
          description: The new payment method config, leave null or unspecified to not change current setting
          default: null
          oneOf:
          - $ref: '#/components/schemas/OnChainPaymentMethodBaseData'
          - $ref: '#/components/schemas/LightningNetworkPaymentMethodBaseData'
          - $ref: '#/components/schemas/LNURLPayPaymentMethodBaseData'
          - type: string
            title: Lightning connection string
            description: A lightning connection string or `Internal Node` (See [this documentation](https://github.com/btcpayserver/btcpayserver.lightning) for the format)
          - type: string
            title: Derivation scheme
            description: A derivation scheme in NBXplorer's format (See [this documentation](https://github.com/dgarage/NBXplorer/blob/master/docs/API.md#derivation-scheme) for the format)
          - type: string
            title: Output descriptor
            description: An output descriptor. Only a subset of them are supported. (See [this documentation](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md) for the format)
          - description: Any other unofficial payment method data
            type: object
            additionalProperties: true
    OnChainPaymentMethodBaseData:
      type: object
      additionalProperties: false
      properties:
        derivationScheme:
          type: string
          description: The derivation scheme
          example: xpub...
        label:
          type: string
          description: A label that will be shown in the UI
        accountKeyPath:
          type: string
          description: The wallet fingerprint followed by the keypath to derive the account key used for signing operation or creating PSBTs
          example: abcd82a1/84'/0'/0'
    PaymentMethodId:
      type: string
      description: "Payment method IDs. Available payment method IDs for Bitcoin are:  \n- `\"BTC-CHAIN\"`: Onchain   \n-`\"BTC-LN\"`: Lightning   \n- `\"BTC-LNURL\"`: LNURL"
      example: BTC-CHAIN
    LightningNetworkPaymentMethodBaseData:
      type: object
      additionalProperties: false
      properties:
        connectionString:
          type: string
          description: The lightning connection string. Set to 'Internal Node' to use the internal node. (See [this doc](https://github.com/btcpayserver/BTCPayServer.Lightning/blob/master/README.md#examples) for some example)
          example: type=clightning;server=...
    StoreId:
      type: string
      description: Store ID of the item
      example: 9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776
    ProblemDetails:
      type: object
      description: Description of an error happening during processing of the request
      properties:
        code:
          type: string
          description: An error code describing the error
        message:
          type: string
          description: User friendly error message about the error
    GenericPaymentMethodData:
      type: object
      additionalProperties: false
      properties:
        enabled:
          type: boolean
          description: Whether the payment method is enabled
        paymentMethodId:
          $ref: '#/components/schemas/PaymentMethodId'
        config:
          type: object
          additionalProperties: false
          description: Associated dynamic data based on payment method type.
          oneOf:
          - $ref: '#/components/schemas/OnChainPaymentMethodBaseData'
          - $ref: '#/components/schemas/LightningNetworkPaymentMethodBaseData'
          - $ref: '#/components/schemas/LNURLPayPaymentMethodBaseData'
          - description: Any other unofficial payment method data
            type: object
            additionalProperties: true
    LNURLPayPaymentMethodBaseData:
      type: object
      additionalProperties: false
      properties:
        useBech32Scheme:
          type: boolean
          description: 'Whether to use [LUD-01](https://github.com/fiatjaf/lnurl-rfc/blob/luds/01.md)''s bech32 format or to use [LUD-17](https://github.com/fiatjaf/lnurl-rfc/blob/luds/17.md) url formatting. '
        lud12Enabled:
          type: boolean
          description: Allow comments to be passed on via lnurl.
        lud21Enabled:
          type: boolean
          description: Whether to include a [LUD-21](https://github.com/lnurl/luds/blob/luds/21.md) verify URL in LNURL-pay callback responses, enabling external services to verify payment settlement without authentication.
  parameters:
    StoreId:
      name: storeId
      in: path
      required: true
      description: The store ID
      schema:
        $ref: '#/components/schemas/StoreId'
    PaymentMethodId:
      name: paymentMethodId
      in: path
      required: true
      description: The payment method id of the payment method to update
      schema:
        $ref: '#/components/schemas/PaymentMethodId'
      example: BTC-CHAIN
  securitySchemes:
    API_Key:
      type: apiKey
      in: header
      name: Authorization
      description: 'BTCPay Server API key. Format: ''token {apiKey}'''
    Basic:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with email and password
externalDocs:
  description: Check out our examples on how to use the API
  url: https://docs.btcpayserver.org/Development/GreenFieldExample/