# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for stax-api Transaction API
  version: 1.0.0
extends: openapi/stax-transaction-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/transaction/{transactionid}/capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a pre-authorized transaction
      effect: write
      questions:
      - How do I finalize a card pre-authorization into a completed charge?
      - Can I capture less than the originally authorized amount?
      instructions:
      - text: Capture pre-auth transaction {transactionid}.
        slots:
          transactionid: path.transactionid
      - text: Capture {total} from pre-authorized transaction {transactionid}.
        slots:
          total: requestBody.total
          transactionid: path.transactionid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/receipt/email'].put
  update:
    x-apievangelist-phrasing:
      intent: Email a transaction receipt
      effect: write
      questions:
      - Can I email a customer the receipt for a payment they made?
      - Is it possible to CC extra addresses on a transaction receipt?
      instructions:
      - text: Email the receipt for transaction {id} to the customer.
        slots:
          id: path.id
      - text: Email transaction {id}'s receipt and CC {ccEmails}.
        slots:
          id: path.id
          ccEmails: requestBody.ccEmails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/related'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction's child transactions
      effect: read
      questions:
      - Which refunds or voids were made against an original payment?
      - Can I list the child transactions linked to a parent charge?
      instructions:
      - text: Get the related child transactions of {id}.
        slots:
          id: path.id
      - text: Show refunds and voids tied to parent transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/funding'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction's split-funding instructions
      effect: read
      questions:
      - How was a split-funded payment divided between accounts?
      - Can I see the funding instructions that were sent with a transaction?
      instructions:
      - text: Get the funding instructions for transaction {id}.
        slots:
          id: path.id
      - text: Show how transaction {id} was split-funded.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction's details
      effect: read
      questions:
      - What payment method and customer were used on a specific transaction?
      - Can I pull up one transaction by its ID?
      instructions:
      - text: Get transaction {id}.
        slots:
          id: path.id
      - text: Show the full details, customer and payment method of transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter transactions
      effect: read
      questions:
      - Which payments did I take last week?
      - Can I find failed transactions above a certain amount?
      - Can I export my transaction history for a customer?
      instructions:
      - text: List my transactions from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Show transactions for customer {customer_id}.
        slots:
          customer_id: query.customer_id
      - text: Find transactions between {minTotal} and {maxTotal} with success {success}.
        slots:
          minTotal: query.minTotal
          maxTotal: query.maxTotal
          success: query.success
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/refund'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a batched transaction
      effect: destructive
      questions:
      - How do I refund a card-not-present payment that has already settled?
      - Can I refund only part of a processed transaction?
      instructions:
      - text: Refund {total} of settled transaction {id}.
        slots:
          total: requestBody.total
          id: path.id
      - text: Return {total} to the customer for batched transaction {id}.
        slots:
          total: requestBody.total
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/receipt-sms'].put
  update:
    x-apievangelist-phrasing:
      intent: Text a transaction receipt
      effect: write
      questions:
      - Can I text a receipt for a payment to the customer's phone?
      - Is it possible to send an SMS receipt to additional numbers?
      instructions:
      - text: Text the receipt for transaction {id}.
        slots:
          id: path.id
      - text: SMS transaction {id}'s receipt and also send it to {ccSMS}.
        slots:
          id: path.id
          ccSMS: requestBody.ccSMS
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a manual transaction
      effect: write
      questions:
      - Can I attach a customer to a manually created transaction after the fact?
      - Is it possible to link a manual transaction to an invoice?
      instructions:
      - text: Assign manual transaction {id} to customer {customer_id}.
        slots:
          id: path.id
          customer_id: requestBody.customer_id
      - text: Link manual transaction {id} to invoice {invoice_id}.
        slots:
          id: path.id
          invoice_id: requestBody.invoice_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/void-or-refund'].post
  update:
    x-apievangelist-phrasing:
      intent: Void or refund a transaction by status
      effect: destructive
      questions:
      - Can I reverse an online payment without checking whether it has settled?
      - Which happens, a void or a refund, when I reverse a transaction automatically?
      instructions:
      - text: Void or refund transaction {id}, whichever its status allows.
        slots:
          id: path.id
      - text: Reverse {total} of transaction {id} by void or refund automatically.
        slots:
          total: query.total
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transaction/{id}/void'].post
  update:
    x-apievangelist-phrasing:
      intent: Void an unprocessed transaction
      effect: destructive
      questions:
      - Can I cancel an online payment before it is processed?
      - What does voiding a transaction do to the charge?
      instructions:
      - text: Void transaction {id}.
        slots:
          id: path.id
      - text: Cancel transaction {id} before it batches.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'