Shopify API — Balance

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Balance
  description: 'Shopify  API — Balance. 7 operations. Lead operation: Shopify Retrieves The Account''s Current Balance. Self-contained
    Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Balance
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-balance
    baseUri: ''
    description: Shopify  API — Balance business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-shopify_payments-balance.json
      path: /admin/api/2020-01/shopify_payments/balance.json
      operations:
      - name: deprecated202001getshopifypaymentsbalance
        method: GET
        description: Shopify Retrieves The Account's Current Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-2020-01-shopify_payments-balance-transactions.json
      path: /admin/api/2020-01/shopify_payments/balance/transactions.json
      operations:
      - name: deprecated202001getshopifypaymentsbalancetransactions
        method: GET
        description: Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: since_id
          in: query
          type: string
          description: Filter response to transactions exclusively after the specified ID.
        - name: last_id
          in: query
          type: string
          description: Filter response to transactions exclusively before the specified ID
        - name: test
          in: query
          type: string
          description: Filter response to transactions placed in test mode.
        - name: payout_id
          in: query
          type: string
          description: Filter response to transactions paid out in the specified payout.
        - name: payout_status
          in: query
          type: string
          description: Filter response to transactions with the specified payout status
    - name: admin-api-2020-04-shopify_payments-balance.json
      path: /admin/api/2020-04/shopify_payments/balance.json
      operations:
      - name: deprecated202004getshopifypaymentsbalance
        method: GET
        description: Shopify Retrieves The Account's Current Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-2020-07-shopify_payments-balance.json
      path: /admin/api/2020-07/shopify_payments/balance.json
      operations:
      - name: deprecated202007getshopifypaymentsbalance
        method: GET
        description: Shopify Retrieves The Account's Current Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-2020-10-shopify_payments-balance.json
      path: /admin/api/2020-10/shopify_payments/balance.json
      operations:
      - name: getshopifypaymentsbalance
        method: GET
        description: Shopify Retrieves The Account's Current Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-2021-01-shopify_payments-balance.json
      path: /admin/api/2021-01/shopify_payments/balance.json
      operations:
      - name: deprecated202101getshopifypaymentsbalance
        method: GET
        description: Shopify Retrieves The Account's Current Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-unstable-shopify_payments-balance.json
      path: /admin/api/unstable/shopify_payments/balance.json
      operations:
      - name: deprecatedunstablegetshopifypaymentsbalance
        method: GET
        description: Shopify Retrieves The Account's Current Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: shopify-balance-rest
    port: 8080
    description: REST adapter for Shopify  API — Balance. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/admin/api/2020-01/shopify-payments/balance-json
      name: admin-api-2020-01-shopify-payments-balance-json
      description: REST surface for admin-api-2020-01-shopify_payments-balance.json.
      operations:
      - method: GET
        name: deprecated202001getshopifypaymentsbalance
        description: Shopify Retrieves The Account's Current Balance
        call: shopify-balance.deprecated202001getshopifypaymentsbalance
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-01/shopify-payments/balance/transactions-json
      name: admin-api-2020-01-shopify-payments-balance-transactions-json
      description: REST surface for admin-api-2020-01-shopify_payments-balance-transactions.json.
      operations:
      - method: GET
        name: deprecated202001getshopifypaymentsbalancetransactions
        description: Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime
        call: shopify-balance.deprecated202001getshopifypaymentsbalancetransactions
        with:
          since_id: rest.since_id
          last_id: rest.last_id
          test: rest.test
          payout_id: rest.payout_id
          payout_status: rest.payout_status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-04/shopify-payments/balance-json
      name: admin-api-2020-04-shopify-payments-balance-json
      description: REST surface for admin-api-2020-04-shopify_payments-balance.json.
      operations:
      - method: GET
        name: deprecated202004getshopifypaymentsbalance
        description: Shopify Retrieves The Account's Current Balance
        call: shopify-balance.deprecated202004getshopifypaymentsbalance
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-07/shopify-payments/balance-json
      name: admin-api-2020-07-shopify-payments-balance-json
      description: REST surface for admin-api-2020-07-shopify_payments-balance.json.
      operations:
      - method: GET
        name: deprecated202007getshopifypaymentsbalance
        description: Shopify Retrieves The Account's Current Balance
        call: shopify-balance.deprecated202007getshopifypaymentsbalance
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-10/shopify-payments/balance-json
      name: admin-api-2020-10-shopify-payments-balance-json
      description: REST surface for admin-api-2020-10-shopify_payments-balance.json.
      operations:
      - method: GET
        name: getshopifypaymentsbalance
        description: Shopify Retrieves The Account's Current Balance
        call: shopify-balance.getshopifypaymentsbalance
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2021-01/shopify-payments/balance-json
      name: admin-api-2021-01-shopify-payments-balance-json
      description: REST surface for admin-api-2021-01-shopify_payments-balance.json.
      operations:
      - method: GET
        name: deprecated202101getshopifypaymentsbalance
        description: Shopify Retrieves The Account's Current Balance
        call: shopify-balance.deprecated202101getshopifypaymentsbalance
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/unstable/shopify-payments/balance-json
      name: admin-api-unstable-shopify-payments-balance-json
      description: REST surface for admin-api-unstable-shopify_payments-balance.json.
      operations:
      - method: GET
        name: deprecatedunstablegetshopifypaymentsbalance
        description: Shopify Retrieves The Account's Current Balance
        call: shopify-balance.deprecatedunstablegetshopifypaymentsbalance
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shopify-balance-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify  API — Balance. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: shopify-retrieves-account-s-current-balance
      description: Shopify Retrieves The Account's Current Balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-balance.deprecated202001getshopifypaymentsbalance
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-list-all-balance
      description: Shopify Retrieves A List Of All Balance Transactions Ordered By Processingtime
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-balance.deprecated202001getshopifypaymentsbalancetransactions
      with:
        since_id: tools.since_id
        last_id: tools.last_id
        test: tools.test
        payout_id: tools.payout_id
        payout_status: tools.payout_status
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-account-s-current-balance-2
      description: Shopify Retrieves The Account's Current Balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-balance.deprecated202004getshopifypaymentsbalance
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-account-s-current-balance-3
      description: Shopify Retrieves The Account's Current Balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-balance.deprecated202007getshopifypaymentsbalance
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-account-s-current-balance-4
      description: Shopify Retrieves The Account's Current Balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-balance.getshopifypaymentsbalance
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-account-s-current-balance-5
      description: Shopify Retrieves The Account's Current Balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-balance.deprecated202101getshopifypaymentsbalance
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-retrieves-account-s-current-balance-6
      description: Shopify Retrieves The Account's Current Balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopify-balance.deprecatedunstablegetshopifypaymentsbalance
      outputParameters:
      - type: object
        mapping: $.