Shift4 Payments API — Customers

naftiko: 1.0.0-alpha2
info:
  label: Shift4 Payments API — Customers
  description: 'Shift4 Payments API — Customers. 5 operations. Lead operation: Create a Customer. Self-contained Naftiko capability
    covering one Shift4 Payments business surface.'
  tags:
  - Shift4 Payments
  - Customers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIFT4_PAYMENTS_API_KEY: SHIFT4_PAYMENTS_API_KEY
capability:
  consumes:
  - type: http
    namespace: shift4-customers
    baseUri: https://api.shift4.com
    description: Shift4 Payments API — Customers business capability. Self-contained, no shared references.
    resources:
    - name: customers
      path: /customers
      operations:
      - name: createcustomer
        method: POST
        description: Create a Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listcustomers
        method: GET
        description: List Customers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: customers-customerId
      path: /customers/{customerId}
      operations:
      - name: getcustomer
        method: GET
        description: Retrieve a Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecustomer
        method: POST
        description: Update a Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecustomer
        method: DELETE
        description: Delete a Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.SHIFT4_PAYMENTS_USER}}'
      password: '{{env.SHIFT4_PAYMENTS_PASS}}'
  exposes:
  - type: rest
    namespace: shift4-customers-rest
    port: 8080
    description: REST adapter for Shift4 Payments API — Customers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/customers
      name: customers
      description: REST surface for customers.
      operations:
      - method: POST
        name: createcustomer
        description: Create a Customer
        call: shift4-customers.createcustomer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listcustomers
        description: List Customers
        call: shift4-customers.listcustomers
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customers/{customerid}
      name: customers-customerid
      description: REST surface for customers-customerId.
      operations:
      - method: GET
        name: getcustomer
        description: Retrieve a Customer
        call: shift4-customers.getcustomer
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updatecustomer
        description: Update a Customer
        call: shift4-customers.updatecustomer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomer
        description: Delete a Customer
        call: shift4-customers.deletecustomer
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shift4-customers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shift4 Payments API — Customers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-customer
      description: Create a Customer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shift4-customers.createcustomer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-customers
      description: List Customers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-customers.listcustomers
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-customer
      description: Retrieve a Customer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-customers.getcustomer
      outputParameters:
      - type: object
        mapping: $.
    - name: update-customer
      description: Update a Customer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shift4-customers.updatecustomer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-customer
      description: Delete a Customer
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: shift4-customers.deletecustomer
      outputParameters:
      - type: object
        mapping: $.