bunq API — Installation

naftiko: 1.0.0-alpha2
info:
  label: bunq API — Installation
  description: 'bunq API — Installation. 4 operations. Lead operation: Installation. Self-contained Naftiko capability covering
    one Bunq business surface.'
  tags:
  - Bunq
  - Installation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BUNQ_API_KEY: BUNQ_API_KEY
capability:
  consumes:
  - type: http
    namespace: bunq-installation
    baseUri: https://public-api.sandbox.bunq.com/{basePath}
    description: bunq API — Installation business capability. Self-contained, no shared references.
    resources:
    - name: installation
      path: /installation
      operations:
      - name: createinstallation
        method: POST
        description: This is the only API call that does not require you to use the "X-Bunq-Client-Authentication" and "X-Bunq-Client-Signature"
          headers.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listallinstallation
        method: GET
        description: You must have an active session to make this call. This call returns the Id of the the Installation you
          are using in your session.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: installation-installationID-server-public-key
      path: /installation/{installationID}/server-public-key
      operations:
      - name: listallserverpublickeyforinstallation
        method: GET
        description: Show the ServerPublicKey for this Installation.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: installationID
          in: path
          type: integer
          required: true
    - name: installation-itemId
      path: /installation/{itemId}
      operations:
      - name: readinstallation
        method: GET
        description: You must have an active session to make this call. This call is used to check whether the Id you provide
          is the Id of your current installation or not.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: itemId
          in: path
          type: integer
          required: true
  exposes:
  - type: rest
    namespace: bunq-installation-rest
    port: 8080
    description: REST adapter for bunq API — Installation. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/installation
      name: installation
      description: REST surface for installation.
      operations:
      - method: POST
        name: createinstallation
        description: This is the only API call that does not require you to use the "X-Bunq-Client-Authentication" and "X-Bunq-Client-Signature"
          headers.
        call: bunq-installation.createinstallation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listallinstallation
        description: You must have an active session to make this call. This call returns the Id of the the Installation you
          are using in your session.
        call: bunq-installation.listallinstallation
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/installation/{installationid}/server-public-key
      name: installation-installationid-server-public-key
      description: REST surface for installation-installationID-server-public-key.
      operations:
      - method: GET
        name: listallserverpublickeyforinstallation
        description: Show the ServerPublicKey for this Installation.
        call: bunq-installation.listallserverpublickeyforinstallation
        with:
          installationID: rest.installationID
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/installation/{itemid}
      name: installation-itemid
      description: REST surface for installation-itemId.
      operations:
      - method: GET
        name: readinstallation
        description: You must have an active session to make this call. This call is used to check whether the Id you provide
          is the Id of your current installation or not.
        call: bunq-installation.readinstallation
        with:
          itemId: rest.itemId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: bunq-installation-mcp
    port: 9090
    transport: http
    description: MCP adapter for bunq API — Installation. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: this-is-only-api-call
      description: This is the only API call that does not require you to use the "X-Bunq-Client-Authentication" and "X-Bunq-Client-Signature"
        headers.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: bunq-installation.createinstallation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: you-must-have-active-session
      description: You must have an active session to make this call. This call returns the Id of the the Installation you
        are using in your session.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bunq-installation.listallinstallation
      outputParameters:
      - type: object
        mapping: $.
    - name: show-serverpublickey-this-installation
      description: Show the ServerPublicKey for this Installation.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bunq-installation.listallserverpublickeyforinstallation
      with:
        installationID: tools.installationID
      outputParameters:
      - type: object
        mapping: $.
    - name: you-must-have-active-session-2
      description: You must have an active session to make this call. This call is used to check whether the Id you provide
        is the Id of your current installation or not.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bunq-installation.readinstallation
      with:
        itemId: tools.itemId
      outputParameters:
      - type: object
        mapping: $.