HubSpot Commerce Payments API — Single Payment Operations

naftiko: 1.0.0-alpha2
info:
  label: HubSpot Commerce Payments API — Single Payment Operations
  description: 'HubSpot Commerce Payments API — Single Payment Operations. 5 operations. Lead operation: Hubspot List Commerce
    Payments. Self-contained Naftiko capability covering one Hubspot business surface.'
  tags:
  - Hubspot
  - Single Payment Operations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUBSPOT_API_KEY: HUBSPOT_API_KEY
capability:
  consumes:
  - type: http
    namespace: commerce-payments-single-payment-operations
    baseUri: https://api.hubapi.com
    description: HubSpot Commerce Payments API — Single Payment Operations business capability. Self-contained, no shared
      references.
    resources:
    - name: crm-v3-objects-commerce_payments
      path: /crm/v3/objects/commerce_payments
      operations:
      - name: listcommercepayments
        method: GET
        description: Hubspot List Commerce Payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcommercepayment
        method: POST
        description: Hubspot Create a Commerce Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-v3-objects-commerce_payments-commercePaymentId
      path: /crm/v3/objects/commerce_payments/{commercePaymentId}
      operations:
      - name: getcommercepaymentbyid
        method: GET
        description: Hubspot Retrieve a Commerce Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecommercepaymentbyid
        method: PATCH
        description: Hubspot Update a Commerce Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: archivecommercepaymentbyid
        method: DELETE
        description: Hubspot Archive a Commerce Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.HUBSPOT_API_KEY}}'
  exposes:
  - type: rest
    namespace: commerce-payments-single-payment-operations-rest
    port: 8080
    description: REST adapter for HubSpot Commerce Payments API — Single Payment Operations. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/crm/v3/objects/commerce-payments
      name: crm-v3-objects-commerce-payments
      description: REST surface for crm-v3-objects-commerce_payments.
      operations:
      - method: GET
        name: listcommercepayments
        description: Hubspot List Commerce Payments
        call: commerce-payments-single-payment-operations.listcommercepayments
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcommercepayment
        description: Hubspot Create a Commerce Payment
        call: commerce-payments-single-payment-operations.createcommercepayment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/commerce-payments/{commercepaymentid}
      name: crm-v3-objects-commerce-payments-commercepaymentid
      description: REST surface for crm-v3-objects-commerce_payments-commercePaymentId.
      operations:
      - method: GET
        name: getcommercepaymentbyid
        description: Hubspot Retrieve a Commerce Payment
        call: commerce-payments-single-payment-operations.getcommercepaymentbyid
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatecommercepaymentbyid
        description: Hubspot Update a Commerce Payment
        call: commerce-payments-single-payment-operations.updatecommercepaymentbyid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: archivecommercepaymentbyid
        description: Hubspot Archive a Commerce Payment
        call: commerce-payments-single-payment-operations.archivecommercepaymentbyid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-payments-single-payment-operations-mcp
    port: 9090
    transport: http
    description: MCP adapter for HubSpot Commerce Payments API — Single Payment Operations. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: hubspot-list-commerce-payments
      description: Hubspot List Commerce Payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-payments-single-payment-operations.listcommercepayments
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-create-commerce-payment
      description: Hubspot Create a Commerce Payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-payments-single-payment-operations.createcommercepayment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-retrieve-commerce-payment
      description: Hubspot Retrieve a Commerce Payment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-payments-single-payment-operations.getcommercepaymentbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-update-commerce-payment
      description: Hubspot Update a Commerce Payment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-payments-single-payment-operations.updatecommercepaymentbyid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-archive-commerce-payment
      description: Hubspot Archive a Commerce Payment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-payments-single-payment-operations.archivecommercepaymentbyid
      outputParameters:
      - type: object
        mapping: $.