Workday Payroll Results API — Payment Results

naftiko: 1.0.0-alpha2
info:
  label: Workday Payroll Results API — Payment Results
  description: 'Workday Payroll Results API — Payment Results. 2 operations. Lead operation: Workday Payroll List Payments
    for a Pay Run. Self-contained Naftiko capability covering one Workday Payroll business surface.'
  tags:
  - Workday Payroll
  - Payment Results
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_PAYROLL_API_KEY: WORKDAY_PAYROLL_API_KEY
capability:
  consumes:
  - type: http
    namespace: payroll-results-payment-results
    baseUri: https://api.workday.com/payroll-results/v1
    description: Workday Payroll Results API — Payment Results business capability. Self-contained, no shared references.
    resources:
    - name: payRuns-payRunId-payments
      path: /payRuns/{payRunId}/payments
      operations:
      - name: listpayrunpayments
        method: GET
        description: Workday Payroll List Payments for a Pay Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payments-paymentId
      path: /payments/{paymentId}
      operations:
      - name: getpayment
        method: GET
        description: Workday Payroll Get a Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WORKDAY_PAYROLL_API_KEY}}'
  exposes:
  - type: rest
    namespace: payroll-results-payment-results-rest
    port: 8080
    description: REST adapter for Workday Payroll Results API — Payment Results. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/payruns/{payrunid}/payments
      name: payruns-payrunid-payments
      description: REST surface for payRuns-payRunId-payments.
      operations:
      - method: GET
        name: listpayrunpayments
        description: Workday Payroll List Payments for a Pay Run
        call: payroll-results-payment-results.listpayrunpayments
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payments/{paymentid}
      name: payments-paymentid
      description: REST surface for payments-paymentId.
      operations:
      - method: GET
        name: getpayment
        description: Workday Payroll Get a Payment
        call: payroll-results-payment-results.getpayment
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: payroll-results-payment-results-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Payroll Results API — Payment Results. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: workday-payroll-list-payments-pay
      description: Workday Payroll List Payments for a Pay Run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-results-payment-results.listpayrunpayments
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-payroll-get-payment
      description: Workday Payroll Get a Payment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-results-payment-results.getpayment
      outputParameters:
      - type: object
        mapping: $.