naftiko: 1.0.0-alpha2
info:
  label: Kushki Merchants API — Branches
  description: 'Kushki Merchants — Branches. 4 operations. Lead operation: Kushki Create Branch. Self-contained Naftiko capability covering branch / sucursal management for marketplaces, franchises, and aggregators.'
  tags:
    - Kushki
    - Merchants
    - Branches
    - Administration
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      KUSHKI_PRIVATE_MERCHANT_ID: KUSHKI_PRIVATE_MERCHANT_ID
capability:
  consumes:
    - type: http
      namespace: merchants-branches
      baseUri: https://api.kushkipagos.com
      description: Branch management endpoints.
      resources:
        - name: merchant-v1-branches
          path: /merchant/v1/branches
          operations:
            - name: listbranches
              method: GET
              description: Kushki List Branches
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
            - name: createbranch
              method: POST
              description: Kushki Create Branch
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  required: true
        - name: merchant-v1-branches-id
          path: /merchant/v1/branches/{branchId}
          operations:
            - name: getbranch
              method: GET
              description: Kushki Get Branch
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: branchId
                  in: path
                  type: string
                  required: true
            - name: updatebranch
              method: PUT
              description: Kushki Update Branch
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: branchId
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
      authentication:
        type: apikey
        key: Private-Merchant-Id
        value: '{{env.KUSHKI_PRIVATE_MERCHANT_ID}}'
        placement: header
  exposes:
    - type: rest
      namespace: merchants-branches-rest
      port: 8080
      resources:
        - path: /v1/branches
          name: merchant-v1-branches
          operations:
            - method: GET
              name: listbranches
              description: Kushki List Branches
              call: merchants-branches.listbranches
              outputParameters:
                - type: object
                  mapping: $.
            - method: POST
              name: createbranch
              description: Kushki Create Branch
              call: merchants-branches.createbranch
              with:
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/branches/{branch-id}
          name: merchant-v1-branches-id
          operations:
            - method: GET
              name: getbranch
              description: Kushki Get Branch
              call: merchants-branches.getbranch
              with:
                branchId: rest.path.branch-id
              outputParameters:
                - type: object
                  mapping: $.
            - method: PUT
              name: updatebranch
              description: Kushki Update Branch
              call: merchants-branches.updatebranch
              with:
                branchId: rest.path.branch-id
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: merchants-branches-mcp
      port: 9090
      transport: http
      tools:
        - name: kushki-list-branches
          description: Kushki List Branches
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: merchants-branches.listbranches
          outputParameters:
            - type: object
              mapping: $.
        - name: kushki-create-branch
          description: Kushki Create Branch
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: merchants-branches.createbranch
          with:
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: kushki-get-branch
          description: Kushki Get Branch
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: merchants-branches.getbranch
          with:
            branchId: tools.branchId
          outputParameters:
            - type: object
              mapping: $.
        - name: kushki-update-branch
          description: Kushki Update Branch
          hints:
            readOnly: false
            destructive: false
            idempotent: true
          call: merchants-branches.updatebranch
          with:
            branchId: tools.branchId
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.