BTCPay Server Notifications (Current User) API

openapi: 3.2.0
info:
  title: BTCPay Greenfield Notifications (Current User) 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: Notifications (Current User)
  description: Notifications operations
paths:
  /api/v1/users/me/notifications:
    get:
      tags:
      - Notifications (Current User)
      summary: Get notifications
      parameters:
      - name: storeId
        in: query
        required: false
        description: Array of store ids to fetch the notifications for
        schema:
          type: array
          items:
            type: string
        example: '&storeId=ABCDE&storeId=FGHIJ'
      - name: take
        in: query
        required: false
        description: Number of records returned in response
        schema:
          type:
          - number
          - 'null'
      - name: skip
        in: query
        required: false
        description: Number of records to skip
        schema:
          type:
          - number
          - 'null'
      - name: seen
        in: query
        required: false
        description: filter by seen notifications
        schema:
          type:
          - string
          - 'null'
      description: View current user's notifications
      operationId: Notifications_GetNotifications
      responses:
        '200':
          description: list of notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationData'
        '403':
          description: If you are authenticated but forbidden to get the data
      security:
      - API_Key:
        - btcpay.user.canmanagenotificationsforuser
        - btcpay.user.canviewnotificationsforuser
        Basic: []
  /api/v1/users/me/notifications/{id}:
    get:
      tags:
      - Notifications (Current User)
      summary: Get notification
      parameters:
      - name: id
        in: path
        required: true
        description: The notification to fetch
        schema:
          type: string
      description: View information about the specified notification
      operationId: Notifications_GetNotification
      responses:
        '200':
          description: specified notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationData'
        '403':
          description: If you are authenticated but forbidden to view the specified notification
        '404':
          description: The key is not found for this notification
      security:
      - API_Key:
        - btcpay.user.canmanagenotificationsforuser
        - btcpay.user.canviewnotificationsforuser
        Basic: []
    put:
      tags:
      - Notifications (Current User)
      summary: Update notification
      parameters:
      - name: id
        in: path
        required: true
        description: The notification to update
        schema:
          type: string
      description: Updates the notification
      operationId: Notifications_UpdateNotification
      responses:
        '200':
          description: updated notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationData'
        '403':
          description: If you are authenticated but forbidden to update the specified notification
        '404':
          description: The key is not found for this notification
      security:
      - API_Key:
        - btcpay.user.canmanagenotificationsforuser
        Basic: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotification'
    delete:
      tags:
      - Notifications (Current User)
      summary: Remove Notification
      description: Removes the specified notification.
      operationId: Notifications_DeleteNotification
      parameters:
      - name: id
        in: path
        required: true
        description: The notification to remove
        schema:
          type: string
      responses:
        '200':
          description: The notification has been deleted
        '403':
          description: If you are authenticated but forbidden to remove the specified notification
        '404':
          description: The key is not found for this notification
      security:
      - API_Key:
        - btcpay.user.canmanagenotificationsforuser
        Basic: []
  /api/v1/users/me/notification-settings:
    get:
      tags:
      - Notifications (Current User)
      summary: Get notification settings
      description: View information about your notification settings
      operationId: Notifications_GetNotificationSettings
      responses:
        '200':
          description: The current user's notification settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettingsData'
        '403':
          description: If you are authenticated but forbidden to view the notification settings
      security:
      - API_Key:
        - btcpay.user.canmanagenotificationsforuser
        Basic: []
    put:
      tags:
      - Notifications (Current User)
      summary: Update notification settings
      description: Updates the current user's notification settings
      operationId: Notifications_UpdateNotificationSettings
      responses:
        '200':
          description: The current user's notification settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettingsData'
        '403':
          description: If you are authenticated but forbidden to update the notification settings
      security:
      - API_Key:
        - btcpay.user.canmanagenotificationsforuser
        Basic: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotificationSettingsRequest'
components:
  schemas:
    StoreId:
      type: string
      description: Store ID of the item
      example: 9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776
    NotificationSettingsItemData:
      type: object
      additionalProperties: false
      properties:
        identifier:
          type: string
          description: The identifier of the notification type
        name:
          type: string
          description: The description of the notification type
        enabled:
          type: boolean
          description: If the notification type is enabled
      example:
        identifier: newversion
        name: New version
        enabled: false
    NotificationData:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: The id of the notification
        identifier:
          type: string
          description: The identifier of the notification
        type:
          type: string
          description: The type of the notification
        body:
          type: string
          format: html
          description: The html body of the notifications
        storeId:
          allOf:
          - $ref: '#/components/schemas/StoreId'
          type:
          - string
          - 'null'
          description: If related to a store, the store id of the notification
        link:
          type:
          - string
          - 'null'
          format: uri
          description: The link of the notification
        createdTime:
          allOf:
          - $ref: '#/components/schemas/UnixTimestamp'
          description: The creation time of the notification
        seen:
          type: boolean
          description: If the notification has been seen by the user
    NotificationSettingsData:
      type: object
      additionalProperties: false
      properties:
        notifications:
          type: array
          description: The notification types
          items:
            $ref: '#/components/schemas/NotificationSettingsItemData'
      example:
      - identifier: newversion
        name: New version
        enabled: false
      - identifier: pluginupdate
        name: Plugin update
        enabled: false
      - identifier: external-payout-transaction
        name: External payout approval
        enabled: true
      - identifier: inviteaccepted
        name: User accepted invitation
        enabled: true
      - identifier: invoicestate
        name: All invoice updates
        enabled: true
      - identifier: invoicestate_invoice_confirmed
        name: Invoice is settled
        enabled: true
      - identifier: invoicestate_invoice_expiredPaidPartial
        name: Invoice expired with partial payments
        enabled: true
      - identifier: invoicestate_invoice_failedToConfirm
        name: Invoice has payments that failed to confirm on time
        enabled: true
      - identifier: invoicestate_invoice_paidAfterExpiration
        name: Invoice was paid after expiration
        enabled: true
      - identifier: newuserrequiresapproval
        name: New user requires approval
        enabled: true
      - identifier: payout
        name: Payouts
        enabled: true
    UnixTimestamp:
      type: number
      format: int32
      example: 1592312018
      description: A unix timestamp in seconds
    UpdateNotification:
      type: object
      additionalProperties: false
      properties:
        seen:
          type:
          - boolean
          - 'null'
          description: Sets the notification as seen/unseen. If left null, sets it to the opposite value
    UpdateNotificationSettingsRequest:
      type: object
      additionalProperties: false
      properties:
        disabled:
          type: array
          items:
            type: string
          description: List of the notification type identifiers, which should be disabled. Can also be a single item 'all'.
          example:
          - newversion
          - pluginupdate
  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)