API Reference — Payment Runs

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Payment Runs
  description: 'API Reference — Payment Runs. 7 operations. Lead operation: Create a payment run. Self-contained Naftiko capability
    covering one Zuora business surface.'
  tags:
  - Zuora
  - Payment Runs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-payment-runs
    baseUri: https://rest.zuora.com
    description: API Reference — Payment Runs business capability. Self-contained, no shared references.
    resources:
    - name: v1-payment-runs
      path: /v1/payment-runs
      operations:
      - name: postpaymentrun
        method: POST
        description: Create a payment run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
      - name: getpaymentruns
        method: GET
        description: List payment runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: createdById
          in: query
          type: string
          description: This parameter filters the response based on the `createdById` field.
        - name: createdDate
          in: query
          type: string
          description: This parameter filters the response based on the `createdDate` field.
        - name: status
          in: query
          type: string
          description: This parameter filters the response based on the `status` field.
        - name: targetDate
          in: query
          type: string
          description: This parameter filters the response based on the `targetDate` field.
        - name: updatedById
          in: query
          type: string
          description: This parameter filters the response based on the `updatedById` field.
        - name: updatedDate
          in: query
          type: string
          description: This parameter filters the response based on the `updatedDate` field.
        - name: sort
          in: query
          type: string
          description: This parameter restricts the order of the data returned in the response. You can use this parameter
            to supply a dimension you want to sort on.
    - name: v1-payment-runs-paymentRunKey
      path: /v1/payment-runs/{paymentRunKey}
      operations:
      - name: putpaymentrun
        method: PUT
        description: Update a payment run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: paymentRunKey
          in: path
          type: string
          description: The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
          required: true
        - name: body
          in: body
          type: string
          required: true
      - name: getpaymentrun
        method: GET
        description: Retrieve a payment run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: paymentRunKey
          in: path
          type: string
          description: The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
          required: true
      - name: deletepaymentrun
        method: DELETE
        description: Delete a payment run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: paymentRunKey
          in: path
          type: string
          description: The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
          required: true
    - name: v1-payment-runs-paymentRunKey-data
      path: /v1/payment-runs/{paymentRunKey}/data
      operations:
      - name: getpaymentrundata
        method: GET
        description: Retrieve payment run data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: paymentRunKey
          in: path
          type: string
          description: The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
          required: true
    - name: v1-payment-runs-paymentRunKey-summary
      path: /v1/payment-runs/{paymentRunKey}/summary
      operations:
      - name: getpaymentrunsummary
        method: GET
        description: Retrieve a payment run summary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: paymentRunKey
          in: path
          type: string
          description: The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.
          required: true
  exposes:
  - type: rest
    namespace: v1-payment-runs-rest
    port: 8080
    description: REST adapter for API Reference — Payment Runs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/payment-runs
      name: v1-payment-runs
      description: REST surface for v1-payment-runs.
      operations:
      - method: POST
        name: postpaymentrun
        description: Create a payment run
        call: v1-payment-runs.postpaymentrun
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getpaymentruns
        description: List payment runs
        call: v1-payment-runs.getpaymentruns
        with:
          createdById: rest.createdById
          createdDate: rest.createdDate
          status: rest.status
          targetDate: rest.targetDate
          updatedById: rest.updatedById
          updatedDate: rest.updatedDate
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/payment-runs/{paymentrunkey}
      name: v1-payment-runs-paymentrunkey
      description: REST surface for v1-payment-runs-paymentRunKey.
      operations:
      - method: PUT
        name: putpaymentrun
        description: Update a payment run
        call: v1-payment-runs.putpaymentrun
        with:
          paymentRunKey: rest.paymentRunKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getpaymentrun
        description: Retrieve a payment run
        call: v1-payment-runs.getpaymentrun
        with:
          paymentRunKey: rest.paymentRunKey
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepaymentrun
        description: Delete a payment run
        call: v1-payment-runs.deletepaymentrun
        with:
          paymentRunKey: rest.paymentRunKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/payment-runs/{paymentrunkey}/data
      name: v1-payment-runs-paymentrunkey-data
      description: REST surface for v1-payment-runs-paymentRunKey-data.
      operations:
      - method: GET
        name: getpaymentrundata
        description: Retrieve payment run data
        call: v1-payment-runs.getpaymentrundata
        with:
          paymentRunKey: rest.paymentRunKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/payment-runs/{paymentrunkey}/summary
      name: v1-payment-runs-paymentrunkey-summary
      description: REST surface for v1-payment-runs-paymentRunKey-summary.
      operations:
      - method: GET
        name: getpaymentrunsummary
        description: Retrieve a payment run summary
        call: v1-payment-runs.getpaymentrunsummary
        with:
          paymentRunKey: rest.paymentRunKey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-payment-runs-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Payment Runs. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-payment-run
      description: Create a payment run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-payment-runs.postpaymentrun
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-payment-runs
      description: List payment runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-payment-runs.getpaymentruns
      with:
        createdById: tools.createdById
        createdDate: tools.createdDate
        status: tools.status
        targetDate: tools.targetDate
        updatedById: tools.updatedById
        updatedDate: tools.updatedDate
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.
    - name: update-payment-run
      description: Update a payment run
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-payment-runs.putpaymentrun
      with:
        paymentRunKey: tools.paymentRunKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-payment-run
      description: Retrieve a payment run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-payment-runs.getpaymentrun
      with:
        paymentRunKey: tools.paymentRunKey
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-payment-run
      description: Delete a payment run
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-payment-runs.deletepaymentrun
      with:
        paymentRunKey: tools.paymentRunKey
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-payment-run-data
      description: Retrieve payment run data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-payment-runs.getpaymentrundata
      with:
        paymentRunKey: tools.paymentRunKey
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-payment-run-summary
      description: Retrieve a payment run summary
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-payment-runs.getpaymentrunsummary
      with:
        paymentRunKey: tools.paymentRunKey
      outputParameters:
      - type: object
        mapping: $.