openapi: 3.0.3
info:
  title: 'NoderPay Merchant API Documentation'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'http://www.cryptopay-panel.com'
tags:
  -
    name: Endpoints
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.'
security:
  -
    default: []
paths:
  /api/v1/stores:
    get:
      summary: "Display a listing of the authenticated merchant's stores."
      operationId: displayAListingOfTheAuthenticatedMerchantsStores
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Unauthenticated. Invalid API Key.'
                properties:
                  message:
                    type: string
                    example: 'Unauthenticated. Invalid API Key.'
      tags:
        - Endpoints
  '/api/v1/stores/{store_id}/invoices':
    post:
      summary: 'Create Invoice'
      operationId: createInvoice
      description: "Creates a new invoice for the specified store.\n\nThis endpoint creates a BTCPay invoice and stores it in the application database."
      parameters: []
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  data:
                    id: 1
                    invoice_number: INV-123456
                    amount: 100
                    currency: USD
                    status: new
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      invoice_number:
                        type: string
                        example: INV-123456
                      amount:
                        type: integer
                        example: 100
                      currency:
                        type: string
                        example: USD
                      status:
                        type: string
                        example: new
        403:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'You cannot create an invoice.'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'You cannot create an invoice.'
      tags:
        - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  description: 'Invoice amount.'
                  example: 0.001
                currency:
                  type: string
                  description: 'ISO currency code.'
                  example: BTC
                order_id:
                  type: string
                  description: 'Merchant order identifier.'
                  example: ORD-123
                  nullable: true
                buyer_email:
                  type: string
                  description: 'Must be a valid email address. Must not be greater than 191 characters.'
                  example: jdach@example.org
                  nullable: true
              required:
                - amount
                - currency
    parameters:
      -
        in: path
        name: store_id
        description: 'The ID of the store.'
        example: 16
        required: true
        schema:
          type: integer
  '/api/v1/invoices/{invoice_id}':
    get:
      summary: 'Show Invoice'
      operationId: showInvoice
      description: 'Retrieves details of a specific invoice.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  data:
                    id: 25
                    invoice_number: INV-123456
                    amount: 100
                    currency: USD
                    status: paid
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 25
                      invoice_number:
                        type: string
                        example: INV-123456
                      amount:
                        type: integer
                        example: 100
                      currency:
                        type: string
                        example: USD
                      status:
                        type: string
                        example: paid
        403:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'This action is unauthorized.'
                properties:
                  message:
                    type: string
                    example: 'This action is unauthorized.'
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: invoice_id
        description: 'The ID of the invoice.'
        example: 1
        required: true
        schema:
          type: integer
      -
        in: path
        name: invoice
        description: 'The invoice ID.'
        example: 25
        required: true
        schema:
          type: integer
  /api/v1/balance-or-summary:
    get:
      summary: 'Display a summary of merchant metrics.'
      operationId: displayASummaryOfMerchantMetrics
      description: ''
      parameters: []
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Unauthenticated. Invalid API Key.'
                properties:
                  message:
                    type: string
                    example: 'Unauthenticated. Invalid API Key.'
      tags:
        - Endpoints
  '/api/v1/stores/{store_id}/webhook-test':
    post:
      summary: ''
      operationId: postApiV1StoresStore_idWebhookTest
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: store_id
        description: 'The ID of the store.'
        example: 16
        required: true
        schema:
          type: integer