Basiq API — Transactions

naftiko: 1.0.0-alpha2
info:
  label: Basiq API — Transactions
  description: 'Basiq API — Transactions. 2 operations. Lead operation: List Transactions. Self-contained Naftiko capability
    covering one Basiq business surface.'
  tags:
  - Basiq
  - Transactions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BASIQ_API_KEY: BASIQ_API_KEY
capability:
  consumes:
  - type: http
    namespace: basiq-transactions
    baseUri: https://au-api.basiq.io
    description: Basiq API — Transactions business capability. Self-contained, no shared references.
    resources:
    - name: users-userId-transactions
      path: /users/{userId}/transactions
      operations:
      - name: listtransactions
        method: GET
        description: List Transactions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Filter transactions by date range, account, or category
        - name: limit
          in: query
          type: integer
        - name: offset
          in: query
          type: integer
    - name: users-userId-transactions-transactionId
      path: /users/{userId}/transactions/{transactionId}
      operations:
      - name: gettransaction
        method: GET
        description: Get Transaction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: transactionId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.BASIQ_API_KEY}}'
  exposes:
  - type: rest
    namespace: basiq-transactions-rest
    port: 8080
    description: REST adapter for Basiq API — Transactions. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/users/{userid}/transactions
      name: users-userid-transactions
      description: REST surface for users-userId-transactions.
      operations:
      - method: GET
        name: listtransactions
        description: List Transactions
        call: basiq-transactions.listtransactions
        with:
          filter: rest.filter
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/transactions/{transactionid}
      name: users-userid-transactions-transactionid
      description: REST surface for users-userId-transactions-transactionId.
      operations:
      - method: GET
        name: gettransaction
        description: Get Transaction
        call: basiq-transactions.gettransaction
        with:
          transactionId: rest.transactionId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: basiq-transactions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Basiq API — Transactions. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-transactions
      description: List Transactions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: basiq-transactions.listtransactions
      with:
        filter: tools.filter
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: get-transaction
      description: Get Transaction
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: basiq-transactions.gettransaction
      with:
        transactionId: tools.transactionId
      outputParameters:
      - type: object
        mapping: $.