BTCPay Server Stores (Payout Processors) API

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. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.


    # Authentication


    You can authenticate either via Basic Auth or an API key. It''s recommended to use an API key for better security. You can create an API key in the BTCPay Server UI under `Account` -> `Manage Account` -> `API keys`. You can restrict the API key for one or multiple stores and for specific permissions. For testing purposes, you can give it the ''Unrestricted access'' permission. On production you should limit the permissions to the actual endpoints you use, you can see the required permission on the API docs at the top of each endpoint under `AUTHORIZATIONS`.


    If you want to simplify the process of creating API keys for your users, you can use the Authorization endpoint to predefine permissions and redirect your users to the BTCPay Server Authorization UI. You can find more information about this on the API Authorization Flow docs page.


    # Usage examples


    Use **Basic Auth** to read store information with cURL:

    ```bash

    BTCPAY_INSTANCE="https://mainnet.demo.btcpayserver.org"

    USER="MyTestUser@gmail.com"

    PASSWORD="notverysecurepassword"

    PERMISSION="btcpay.store.canmodifystoresettings"

    BODY="$(echo "{}" | jq --arg "a" "$PERMISSION" ''. + {permissions:[$a]}'')"


    API_KEY="$(curl -s \

    -H "Content-Type: application/json" \

    --user "$USER:$PASSWORD" \

    -X POST \

    -d "$BODY" \

    "$BTCPAY_INSTANCE/api/v1/api-keys" | jq -r .apiKey)"

    ```


    Use an **API key** to read store information with cURL:

    ```bash

    STORE_ID="yourStoreId"


    curl -s \

    -H "Content-Type: application/json" \

    -H "Authorization: token $API_KEY" \

    -X GET \

    "$BTCPAY_INSTANCE/api/v1/stores/$STORE_ID"

    ```


    You can find more examples on our docs for different programming languages:

    - cURL

    - Javascript/Node.Js

    - PHP'
  contact:
    name: BTCPay Server
    url: https://btcpayserver.org
  license:
    name: MIT
    url: https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE
servers:
- url: /
  description: BTCPay Server Greenfield API
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/PaymentMethodId'
      - $ref: '#/components/parameters/StoreId'
      - name: processor
        in: path
        required: true
        description: The processor
        schema:
          type: string
      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/PaymentMethodId'
      - $ref: '#/components/parameters/StoreId'
      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/PaymentMethodId'
      - $ref: '#/components/parameters/StoreId'
      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/PayoutMethodId'
      - $ref: '#/components/parameters/StoreId'
      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/PayoutMethodId'
      - $ref: '#/components/parameters/StoreId'
      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:
    StoreId:
      type: string
      description: Store ID of the item
      example: 9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776
    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
    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
    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
    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
    TimeSpanSeconds:
      allOf:
      - $ref: '#/components/schemas/TimeSpan'
      format: seconds
      description: A span of times in seconds
    TimeSpan:
      type: number
      format: int32
      example: 90
    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
    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
    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
  parameters:
    StoreId:
      name: storeId
      in: path
      required: true
      description: The store ID
      schema:
        $ref: '#/components/schemas/StoreId'
    PayoutMethodId:
      name: payoutMethodId
      in: path
      required: true
      description: The payout method id
      schema:
        $ref: '#/components/schemas/PayoutMethodId'
      example: BTC-CHAIN
    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
      description: "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: `token {token}`. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `btcpay.impersonation.canimpersonate`: Can impersonate users\n* `btcpay.user.candeleteuser`: Delete user\n* `btcpay.user.canmanagenotificationsforuser`: Manage your notifications\n* `btcpay.user.canmodifyprofile`: Manage your profile\n* `btcpay.user.canviewnotificationsforuser`: View your notifications\n* `btcpay.user.canviewprofile`: View your profile\n* `unrestricted`: Unrestricted access\n\nThe following permissions are available if the user is an administrator:\n\n* `btcpay.server.cancreatelightninginvoiceinternalnode`: Create invoices with internal lightning node\n* `btcpay.server.cancreateuser`: Create new users\n* `btcpay.server.canmanageusers`: Manage users\n* `btcpay.server.canmodifyserversettings`: Manage your server\n* `btcpay.server.canuseinternallightningnode`: Use the internal lightning node\n* `btcpay.server.canviewlightninginvoiceinternalnode`: View invoices from internal lightning node\n* `btcpay.server.canviewusers`: View users\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n\n* `btcpay.store.canarchivepullpayments`: Archive your pull payments\n* `btcpay.store.canbroadcasttransactions`: Broadcast wallet transactions\n* `btcpay.store.cancanceltransactions`: Cancel wallet transactions\n* `btcpay.store.cancreateinvoice`: Create an invoice\n* `btcpay.store.cancreatelightninginvoice`: Create invoices from the lightning nodes associated with your stores\n* `btcpay.store.cancreatenonapprovedpullpayments`: Create non-approved pull payments\n* `btcpay.store.cancreatepullpayments`: Create pull payments\n* `btcpay.store.cancreatetransactions`: Create wallet transactions\n* `btcpay.store.cancreditsubscribers`: Credit your subscribers\n* `btcpay.store.canmanageinvoicestatus`: Manage invoice status\n* `btcpay.store.canmanagelegacyaccesstokens`: Manage legacy access tokens\n* `btcpay.store.canmanagepayouts`: Manage payouts\n* `btcpay.store.canmanagepullpayments`: Manage your pull payments\n* `btcpay.store.canmanagesubscribers`: Manage your subscribers\n* `btcpay.store.canmanagewallets`: Manage wallets\n* `btcpay.store.canmanagewalletsettings`: Manage wallet settings\n* `btcpay.store.canmanagewallettransactions`: Manage wallet transactions\n* `btcpay.store.canmodifyinvoices`: Modify invoices\n* `btcpay.store.canmodifyofferings`: Modify your offerings\n* `btcpay.store.canmodifypaymentrequests`: Modify your payment requests\n* `btcpay.store.canmodifystoresettings`: Modify your stores\n* `btcpay.store.cansendstoreemails`: Send store emails\n* `btcpay.store.cansigntransactions`: Sign wallet transactions\n* `btcpay.store.canuselightningnode`: Use the lightning nodes associated with your stores\n* `btcpay.store.canviewinvoices`: View invoices\n* `btcpay.store.canviewlightninginvoice`: View the lightning invoices associated with your stores\n* `btcpay.store.canviewofferings`: View your offerings\n* `btcpay.store.canviewpaymentrequests`: View your payment requests\n* `btcpay.store.canviewpayouts`: View payouts\n* `btcpay.store.canviewpullpayments`: View your pull payments\n* `btcpay.store.canviewreports`: View your reports\n* `btcpay.store.canviewstoresettings`: View your stores\n* `btcpay.store.canviewwallet`: View wallets\n* `btcpay.store.webhooks.canmodifywebhooks`: Modify stores webhooks\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\nSome permissions may include other permissions, see [this operation](#operation/permissionsMetadata).\n"
      name: Authorization
      in: header
    Basic:
      type: http
      description: BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme during the first five minutes after account creation or when the user explicitly enables it. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission
      scheme: Basic
externalDocs:
  description: BTCPay Greenfield Plugins API
  url: https://docs.btcpayserver.org/API/Greenfield/Plugins/
x-provenance:
  method: harvested
  publisher: BTCPay Server
  source: https://docs.btcpayserver.org/API/Greenfield/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)