BTCPay Server

BTCPay Server Stores (Payout Processors) API

Stores (Payout Processors) operations

GitHub OpenAPI

Operations 9

GET /api/v1/stores/{storeId}/payout-processors Get store configured payout processors #
DELETE /api/v1/stores/{storeId}/payout-processors/{processor}/{paymentMethodId} Remove store configured payout processor #
GET /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedPayoutSenderFactory/{paymentMethodId} Get configured store onchain automated payout processors #
PUT /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedPayoutSenderFactory/{paymentMethodId} Update configured store onchain automated payout processors #
GET /api/v1/stores/{storeId}/payout-processors/LightningAutomatedPayoutSenderFactory/{payoutMethodId} Get configured store Lightning automated payout processors #
PUT /api/v1/stores/{storeId}/payout-processors/LightningAutomatedPayoutSenderFactory/{payoutMethodId} Update configured store Lightning automated payout processors #
GET /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedTransferSenderFactory Get configured store onchain automated payout processors #
PUT /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedTransferSenderFactory Update configured store onchain automated payout processors #
GET /api/v1/stores/{storeId}/payout-processors/LightningAutomatedPayoutSenderFactory Get configured store Lightning automated payout processors #

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-stores-payout-processors-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-stores-payout-processors-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-stores-payout-processors-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BTCPay Greenfield Stores (Payout Processors) 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: Stores (Payout Processors)
  description: Stores (Payout Processors) operations
paths:
  /api/v1/stores/{storeId}/payout-processors:
    get:
      tags:
      - Stores (Payout Processors)
      summary: Get store configured payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      operationId: StorePayoutProcessors_GetStorePayoutProcessors
      responses:
        '200':
          description: configured payout processors
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PayoutProcessorData'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
  /api/v1/stores/{storeId}/payout-processors/{processor}/{paymentMethodId}:
    delete:
      tags:
      - Stores (Payout Processors)
      summary: Remove store configured payout processor
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - name: processor
        in: path
        required: true
        description: The processor
        schema:
          type: string
      - $ref: '#/components/parameters/PaymentMethodId'
      operationId: StorePayoutProcessors_RemoveStorePayoutProcessor
      responses:
        '200':
          description: removed
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canmodifystoresettings
        Basic: []
  /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedPayoutSenderFactory/{paymentMethodId}:
    get:
      tags:
      - Stores (Payout Processors)
      summary: Get configured store onchain automated payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/PaymentMethodId'
      operationId: GreenfieldStoreAutomatedOnChainPayoutProcessorsController_GetStoreOnChainAutomatedPayoutProcessorsForPaymentMethod
      responses:
        '200':
          description: configured processors
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OnChainAutomatedTransferSettings'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
    put:
      tags:
      - Stores (Payout Processors)
      summary: Update configured store onchain automated payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/PaymentMethodId'
      operationId: GreenfieldStoreAutomatedOnChainPayoutProcessorsController_UpdateStoreOnChainAutomatedPayoutProcessorForPaymentMethod
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOnChainAutomatedTransferSettings'
        required: true
        x-position: 1
      responses:
        '200':
          description: configured processor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnChainAutomatedTransferSettings'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
  /api/v1/stores/{storeId}/payout-processors/LightningAutomatedPayoutSenderFactory/{payoutMethodId}:
    get:
      tags:
      - Stores (Payout Processors)
      summary: Get configured store Lightning automated payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/PayoutMethodId'
      operationId: GreenfieldStoreAutomatedLightningPayoutProcessorsController_GetStoreLightningAutomatedPayoutProcessorsForPaymentMethod
      responses:
        '200':
          description: configured processors
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LightningAutomatedTransferSettings'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
    put:
      tags:
      - Stores (Payout Processors)
      summary: Update configured store Lightning automated payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      - $ref: '#/components/parameters/PayoutMethodId'
      operationId: GreenfieldStoreAutomatedLightningPayoutProcessorsController_UpdateStoreLightningAutomatedPayoutProcessor
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLightningAutomatedTransferSettings'
        required: true
        x-position: 1
      responses:
        '200':
          description: configured processor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LightningAutomatedTransferSettings'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
  /api/v1/stores/{storeId}/payout-processors/OnChainAutomatedTransferSenderFactory:
    get:
      tags:
      - Stores (Payout Processors)
      summary: Get configured store onchain automated payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      operationId: GreenfieldStoreAutomatedOnChainPayoutProcessorsController_GetStoreOnChainAutomatedTransferSenderFactory
      responses:
        '200':
          description: configured processors
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OnChainAutomatedTransferSettings'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
    put:
      tags:
      - Stores (Payout Processors)
      summary: Update configured store onchain automated payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      operationId: GreenfieldStoreAutomatedOnChainPayoutProcessorsController_UpdateStoreOnChainAutomatedTransferSenderFactory
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOnChainAutomatedTransferSettings'
        required: true
        x-position: 1
      responses:
        '200':
          description: configured processor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnChainAutomatedTransferSettings'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
  /api/v1/stores/{storeId}/payout-processors/LightningAutomatedPayoutSenderFactory:
    get:
      tags:
      - Stores (Payout Processors)
      summary: Get configured store Lightning automated payout processors
      parameters:
      - $ref: '#/components/parameters/StoreId'
      operationId: GreenfieldStoreAutomatedLightningPayoutProcessorsController_GetStoreLightningAutomatedPayoutSenderFactory
      responses:
        '200':
          description: configured processors
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LightningAutomatedTransferSettings'
        '403':
          description: If you are authenticated but forbidden to view the specified store
        '404':
          description: The key is not found for this store
      security:
      - API_Key:
        - btcpay.store.canviewstoresettings
        Basic: []
components:
  schemas:
    LightningAutomatedTransferSettings:
      type: object
      additionalProperties: false
      properties:
        payoutMethodId:
          $ref: '#/components/schemas/PayoutMethodId'
        intervalSeconds:
          description: How often should the processor run
          allOf:
          - $ref: '#/components/schemas/TimeSpanSeconds'
        cancelPayoutAfterFailures:
          description: How many failures should the processor tolerate before cancelling the payout
          type:
          - number
          - 'null'
        processNewPayoutsInstantly:
          description: Skip the interval when ane eligible payout has been approved (or created with pre-approval)
          type: boolean
          default: false
    UpdateLightningAutomatedTransferSettings:
      type: object
      additionalProperties: false
      properties:
        intervalSeconds:
          description: How often should the processor run
          allOf:
          - $ref: '#/components/schemas/TimeSpanSeconds'
        cancelPayoutAfterFailures:
          description: How many failures should the processor tolerate before cancelling the payout
          type:
          - number
          - 'null'
        processNewPayoutsInstantly:
          description: Skip the interval when ane eligible payout has been approved (or created with pre-approval)
          type: boolean
          default: false
    TimeSpanSeconds:
      allOf:
      - $ref: '#/components/schemas/TimeSpan'
      format: seconds
      description: A span of times in seconds
    PayoutMethodId:
      type: string
      description: "Payout method IDs. Available payment method IDs for Bitcoin are:  \n- `\"BTC-CHAIN\"`: Onchain   \n-`\"BTC-LN\"`: Lightning"
      example: BTC-LN
    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
    PayoutProcessorData:
      type: object
      additionalProperties: false
      properties:
        name:
          description: unique identifier of the payout processor
          type: string
        friendlyName:
          description: Human name of the payout processor
          type: string
        payoutMethods:
          description: Supported, payment methods by this processor
          type:
          - array
          - 'null'
          items:
            type: string
    OnChainAutomatedTransferSettings:
      type: object
      additionalProperties: false
      properties:
        payoutMethodId:
          $ref: '#/components/schemas/PayoutMethodId'
        feeTargetBlock:
          type: number
          description: How many blocks should the fee rate calculation target to confirm in.
        intervalSeconds:
          description: How often should the processor run
          allOf:
          - $ref: '#/components/schemas/TimeSpanSeconds'
        threshold:
          type: string
          format: decimal
          minimum: 0
          description: Only process payouts when this payout sum is reached.
          example: '0.1'
        processNewPayoutsInstantly:
          description: Skip the interval when ane eligible payout has been approved (or created with pre-approval)
          type: boolean
          default: false
    TimeSpan:
      type: number
      format: int32
      example: 90
    StoreId:
      type: string
      description: Store ID of the item
      example: 9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776
    UpdateOnChainAutomatedTransferSettings:
      type: object
      additionalProperties: false
      properties:
        feeTargetBlock:
          type:
          - number
          - 'null'
          description: How many blocks should the fee rate calculation target to confirm in. Set to 1 if not provided
        intervalSeconds:
          description: How often should the processor run
          allOf:
          - $ref: '#/components/schemas/TimeSpanSeconds'
        threshold:
          type: string
          format: decimal
          minimum: 0
          description: Only process payouts when this payout sum is reached.
          example: '0.1'
        processNewPayoutsInstantly:
          description: Skip the interval when ane eligible payout has been approved (or created with pre-approval)
          type: boolean
          default: false
  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
    PayoutMethodId:
      name: payoutMethodId
      in: path
      required: true
      description: The payout method id
      schema:
        $ref: '#/components/schemas/PayoutMethodId'
      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/