BTCPay Server Crowdfund API

openapi: 3.2.0
info:
  title: BTCPay Greenfield Crowdfund 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: Crowdfund
  description: Crowdfund operations
paths:
  /api/v1/apps/crowdfund/{appId}:
    parameters:
    - $ref: '#/components/parameters/AppId'
    put:
      operationId: Apps_PutCrowdfundApp
      summary: Update a Crowdfund app
      description: Full update. GET the app first, modify the data, then PUT the complete payload.
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrowdfundAppRequest'
        required: true
        x-position: 1
      responses:
        '200':
          description: App details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrowdfundAppData'
        '404':
          description: Crowdfund app with specified ID was not found
        '422':
          description: Unable to validate the request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
      tags:
      - Crowdfund
      security:
      - API_Key:
        - btcpay.store.canmodifystoresettings
        Basic: []
    get:
      tags:
      - Crowdfund
      operationId: Apps_GetCrowdfundApp
      summary: Get crowdfund app data
      description: Returns crowdfund app data
      responses:
        '200':
          description: Crowdfund app data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrowdfundAppData'
        '404':
          description: Crowdfund app with specified ID was not found
  /api/v1/stores/{storeId}/apps/crowdfund:
    parameters:
    - $ref: '#/components/parameters/StoreId'
    post:
      operationId: Apps_CreateCrowdfundApp
      summary: Create a new Crowdfund app
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrowdfundAppRequest'
        required: true
        x-position: 1
      responses:
        '200':
          description: Created app details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrowdfundAppData'
        '422':
          description: Unable to validate the request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
      tags:
      - Crowdfund
      security:
      - API_Key:
        - btcpay.store.canmodifystoresettings
        Basic: []
components:
  schemas:
    StoreId:
      type: string
      description: Store ID of the item
      example: 9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776
    CrowdfundBaseData:
      allOf:
      - $ref: '#/components/schemas/AppBaseData'
      - type: object
        properties:
          title:
            type:
            - string
            - 'null'
            description: Display title of the app
            example: My crowdfund app
          description:
            type:
            - string
            - 'null'
            description: App description
            example: My crowdfund description
          enabled:
            type:
            - boolean
            - 'null'
            description: Whether the app is enabled to be viewed by everyone
            example: true
          enforceTargetAmount:
            type:
            - boolean
            - 'null'
            description: Whether contributions over the set target amount are allowed
            example: false
          startDate:
            type:
            - number
            - 'null'
            description: UNIX timestamp for crowdfund start time (https://www.unixtimestamp.com/)
            allOf:
            - $ref: '#/components/schemas/UnixTimestamp'
            example: 768658369
          endDate:
            type:
            - number
            - 'null'
            description: UNIX timestamp for crowdfund end time (https://www.unixtimestamp.com/)
            allOf:
            - $ref: '#/components/schemas/UnixTimestamp'
            example: 771336769
          targetCurrency:
            type:
            - string
            - 'null'
            description: Target currency for the crowdfund
            example: BTC
          targetAmount:
            type:
            - number
            - 'null'
            description: Target amount for the crowdfund
            example: 420.69
          mainImageUrl:
            type:
            - string
            - 'null'
            description: URL for image used as a cover image for the app
          notificationUrl:
            type:
            - string
            - 'null'
            description: Deprecated. Use webhooks instead. Callback notification URL to POST to once when an invoice is paid and once when there are enough blockchain confirmations.
            deprecated: true
          tagline:
            type:
            - string
            - 'null'
            description: Tagline for the app displayed to user
            example: I can't believe it's not butter
          soundsEnabled:
            type:
            - boolean
            - 'null'
            description: Whether sounds on new contributions are enabled
            example: false
          animationsEnabled:
            type:
            - boolean
            - 'null'
            description: Whether background animations on new contributions are enabled
            example: true
          resetEveryAmount:
            type:
            - number
            - 'null'
            description: Contribution goal reset frequency amount
            example: 1
          resetEvery:
            type:
            - string
            - 'null'
            description: Contribution goal reset frequency
            example: Day
          displayPerksValue:
            type:
            - boolean
            - 'null'
            description: Whether perk values are displayed
            example: false
          displayPerksRanking:
            type:
            - boolean
            - 'null'
            description: Whether perk ranking is displayed
            example: false
          sortPerksByPopularity:
            type:
            - boolean
            - 'null'
            description: Whether perks are sorted by popularity
            default: true
          sounds:
            type:
            - array
            - 'null'
            description: Array of custom sounds which can be used on new contributions
            items:
              type: string
            example:
            - https://github.com/ClaudiuHKS/AdvancedQuakeSounds/raw/master/sound/AQS/doublekill.wav
          animationColors:
            type:
            - array
            - 'null'
            description: Array of custom HEX colors which can be used for background animations on new contributions
            items:
              type: string
            example:
            - '#FF0000'
            - '#00FF00'
            - '#0000FF'
          htmlLang:
            type:
            - string
            - 'null'
            description: Used for SEO, the [HTML Lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) of the page
            example: en
          htmlMetaTags:
            type:
            - string
            - 'null'
            description: Used for SEO, the [Meta tags](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta) of the page
            example: <meta name="description" content="Your description">
          formId:
            type:
            - string
            - 'null'
            description: Form ID to request customer data
    CrowdfundAppRequest:
      allOf:
      - $ref: '#/components/schemas/CrowdfundBaseData'
      - type: object
        properties:
          perksTemplate:
            type: string
            description: JSON of perks available in the app
    UnixTimestamp:
      type: number
      format: int32
      example: 1592312018
      description: A unix timestamp in seconds
    ValidationProblemDetails:
      type: array
      description: An array of validation errors of the request
      items:
        type: object
        description: A specific validation error on a json property
        properties:
          path:
            type: string
            description: The json path of the property which failed validation
          message:
            type: string
            description: User friendly error message about the validation
    AppBaseData:
      type: object
      properties:
        id:
          type: string
          description: Id of the app
          example: 3ki4jsAkN4u9rv1PUzj1odX4Nx7s
        appName:
          type: string
          description: Name given to the app when it was created
          example: my test app
        storeId:
          description: Id of the store to which the app belongs
          allOf:
          - $ref: '#/components/schemas/StoreId'
        created:
          type: integer
          example: 1651554744
          description: UNIX timestamp for when the app was created
        appType:
          type: string
          example: PointOfSale
          description: Type of the app which was created
        archived:
          type:
          - boolean
          - 'null'
          description: If true, the app does not appear in the apps list by default.
          default: false
    CrowdfundAppData:
      allOf:
      - $ref: '#/components/schemas/CrowdfundBaseData'
      - type: object
        properties:
          perks:
            type: object
            description: JSON of perks available in the app
            example:
            - description: null
              id: test perk
              image: null
              price:
                type: 2
                formatted: $100.00
                value: 100.0
              title: test perk
              buyButtonText: null
              inventory: null
              paymentMethods: null
              disabled: false
            - description: this is an amazing perk
              id: test test
              image: https://mainnet.demo.btcpayserver.org/img/errorpages/404_nicolas.jpg
              price:
                type: 1
                formatted: $69.42
                value: 69.42
              title: test test
              buyButtonText: null
              inventory: 5
              paymentMethods: null
              disabled: false
            - description: null
              id: f$t45hj764325
              image: null
              price:
                type: 0
                formatted: null
                value: null
              title: amazing perk
              buyButtonText: button text
              inventory: null
              paymentMethods: null
              disabled: true
  parameters:
    AppId:
      name: appId
      in: path
      required: true
      description: App ID
      schema:
        type: string
    StoreId:
      name: storeId
      in: path
      required: true
      description: The store ID
      schema:
        $ref: '#/components/schemas/StoreId'
  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)