BTCPay Server Miscelleneous API

openapi: 3.2.0
info:
  title: BTCPay Greenfield Miscelleneous 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: Miscelleneous
  description: Miscelleneous operations
paths:
  /misc/rate-sources:
    get:
      tags:
      - Miscelleneous
      summary: Get available rate sources
      description: View available rate providers that you can use in stores
      operationId: GetRateSources
      responses:
        '200':
          description: rate providers array
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    id:
                      type: string
                      description: The id of the rate provider
                    name:
                      type: string
                      description: The name of the rate provider
        '403':
          description: If you are authenticated but forbidden to get the data
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security: []
  /misc/permissions:
    get:
      tags:
      - Miscelleneous
      summary: Permissions metadata
      description: The metadata of available permissions
      operationId: permissionsMetadata
      responses:
        '200':
          description: The metadata of available permissions
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The permission id
                    included:
                      type: array
                      description: Permissions included in this array are also granted by this permission
                      items:
                        type: string
        '403':
          description: If you are authenticated but forbidden to get the data
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security: []
  /misc/lang:
    get:
      tags:
      - Miscelleneous
      summary: Language codes
      description: The supported language codes
      operationId: langCodes
      responses:
        '200':
          description: The supported language codes
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    code:
                      type: string
                      description: The language code
                    currentLanguage:
                      type: string
                      description: The language name
        '403':
          description: If you are authenticated but forbidden to get the data
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security: []
  /i/{invoiceId}:
    parameters:
    - $ref: '#/components/parameters/InvoiceId'
    - name: lang
      in: query
      required: false
      description: The preferred language of the checkout page. You can use "auto" to use the language of the customer's browser or see the list of language codes with [this operation](#operation/langCodes).
      schema:
        type: string
    get:
      tags:
      - Miscelleneous
      operationId: Invoice_Checkout
      summary: Invoice checkout
      description: View the checkout page of an invoice
      responses:
        '200':
          description: The checkout page
          content:
            text/html:
              example: The HTML checkout page of the invoice
        '404':
          description: The invoice could not be found
      security: []
components:
  schemas:
    InvoiceId:
      type: string
      description: The invoice ID
      example: HMprBnL9BTXWuPvpoKBS6e
    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
  parameters:
    InvoiceId:
      name: invoiceId
      in: path
      required: true
      description: The invoice ID
      schema:
        $ref: '#/components/schemas/InvoiceId'
  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/