commercetools HTTP API — Payments

naftiko: 1.0.0-alpha2
info:
  label: commercetools HTTP API — Payments
  description: 'commercetools HTTP API — Payments. 4 operations. Lead operation: List payments. Self-contained Naftiko capability
    covering one Commercetools business surface.'
  tags:
  - Commercetools
  - Payments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COMMERCETOOLS_API_KEY: COMMERCETOOLS_API_KEY
capability:
  consumes:
  - type: http
    namespace: http-payments
    baseUri: https://api.{region}.commercetools.com
    description: commercetools HTTP API — Payments business capability. Self-contained, no shared references.
    resources:
    - name: projectKey-payments
      path: /{projectKey}/payments
      operations:
      - name: listpayments
        method: GET
        description: List payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createpayment
        method: POST
        description: Create a payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projectKey-payments-id
      path: /{projectKey}/payments/{id}
      operations:
      - name: getpaymentbyid
        method: GET
        description: Get a payment by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatepaymentbyid
        method: POST
        description: Update a payment by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.COMMERCETOOLS_API_KEY}}'
  exposes:
  - type: rest
    namespace: http-payments-rest
    port: 8080
    description: REST adapter for commercetools HTTP API — Payments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/{projectkey}/payments
      name: projectkey-payments
      description: REST surface for projectKey-payments.
      operations:
      - method: GET
        name: listpayments
        description: List payments
        call: http-payments.listpayments
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpayment
        description: Create a payment
        call: http-payments.createpayment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{projectkey}/payments/{id}
      name: projectkey-payments-id
      description: REST surface for projectKey-payments-id.
      operations:
      - method: GET
        name: getpaymentbyid
        description: Get a payment by ID
        call: http-payments.getpaymentbyid
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updatepaymentbyid
        description: Update a payment by ID
        call: http-payments.updatepaymentbyid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: http-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for commercetools HTTP API — Payments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-payments
      description: List payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: http-payments.listpayments
      outputParameters:
      - type: object
        mapping: $.
    - name: create-payment
      description: Create a payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: http-payments.createpayment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-payment-id
      description: Get a payment by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: http-payments.getpaymentbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: update-payment-id
      description: Update a payment by ID
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: http-payments.updatepaymentbyid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.