Square API — Payments

naftiko: 1.0.0-alpha2
info:
  label: Square API — Payments
  description: 'Square API — Payments. 3 operations. Lead operation: Block Square List Payments. Self-contained Naftiko capability
    covering one Block business surface.'
  tags:
  - Block
  - Payments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BLOCK_API_KEY: BLOCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: square-payments
    baseUri: https://connect.squareup.com/v2
    description: Square API — Payments business capability. Self-contained, no shared references.
    resources:
    - name: payments
      path: /payments
      operations:
      - name: listpayments
        method: GET
        description: Block Square List Payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: begin_time
          in: query
          type: string
          description: The start of the time range to retrieve payments for.
        - name: end_time
          in: query
          type: string
          description: The end of the time range to retrieve payments for.
        - name: cursor
          in: query
          type: string
          description: A pagination cursor returned by a previous call.
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to be returned.
        - name: location_id
          in: query
          type: string
          description: Limit results to the location supplied.
      - name: createpayment
        method: POST
        description: Block Square Create Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: payments-payment_id
      path: /payments/{payment_id}
      operations:
      - name: getpayment
        method: GET
        description: Block Square Get Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payment_id
          in: path
          type: string
          description: A unique ID for the desired payment.
          required: true
    authentication:
      type: bearer
      token: '{{env.BLOCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: square-payments-rest
    port: 8080
    description: REST adapter for Square API — Payments. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/payments
      name: payments
      description: REST surface for payments.
      operations:
      - method: GET
        name: listpayments
        description: Block Square List Payments
        call: square-payments.listpayments
        with:
          begin_time: rest.begin_time
          end_time: rest.end_time
          cursor: rest.cursor
          limit: rest.limit
          location_id: rest.location_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpayment
        description: Block Square Create Payment
        call: square-payments.createpayment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payments/{payment-id}
      name: payments-payment-id
      description: REST surface for payments-payment_id.
      operations:
      - method: GET
        name: getpayment
        description: Block Square Get Payment
        call: square-payments.getpayment
        with:
          payment_id: rest.payment_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: square-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Square API — Payments. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: block-square-list-payments
      description: Block Square List Payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: square-payments.listpayments
      with:
        begin_time: tools.begin_time
        end_time: tools.end_time
        cursor: tools.cursor
        limit: tools.limit
        location_id: tools.location_id
      outputParameters:
      - type: object
        mapping: $.
    - name: block-square-create-payment
      description: Block Square Create Payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: square-payments.createpayment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: block-square-get-payment
      description: Block Square Get Payment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: square-payments.getpayment
      with:
        payment_id: tools.payment_id
      outputParameters:
      - type: object
        mapping: $.