# 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 Query API
  version: 1.0.0
extends: openapi/stax-query-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: 17
- target: $.paths['/query/statement/v3/ach-rejects'].get
  update:
    x-apievangelist-phrasing:
      intent: Report ACH rejections for a date range
      effect: read
      questions:
      - Which ACH payments were rejected or returned on my statement last month?
      - Can I see bank-payment rejects between two dates?
      instructions:
      - text: Show my ACH rejects from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Pull the ACH rejection statement section for {startDate} through {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/statement/v3/volumes/card-processing'].get
  update:
    x-apievangelist-phrasing:
      intent: Report card processing volume
      effect: read
      questions:
      - How much card processing volume did I run over a period?
      - What does my statement show for card processing volumes this quarter?
      instructions:
      - text: Show card processing volume from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Get the card-processing volumes statement for {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/payment-links'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment links
      effect: read
      questions:
      - Which payment links have I created for my merchant account?
      - Can I list only the payment links that are still active?
      instructions:
      - text: List all my payment links.
      - text: Show payment links where active is {active}, sorted by {sort}.
        slots:
          active: query.active
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/payment-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payment link
      effect: write
      questions:
      - Can I generate a shareable link that customers use to pay me?
      - Is it possible to create a payment link where the customer chooses the amount?
      instructions:
      - text: Create a payment link called {common_name} for {amount} at {url}.
        slots:
          common_name: requestBody.common_name
          amount: requestBody.amount
          url: requestBody.url
      - text: Make a variable-amount payment link named {common_name} pointing to {url}.
        slots:
          common_name: requestBody.common_name
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/statement/v3/daily-sales'].get
  update:
    x-apievangelist-phrasing:
      intent: Report daily sales, fees and surcharges
      effect: read
      questions:
      - What were my total sales for each day of last week?
      - Can I see fees and surcharges broken down per day on my statement?
      instructions:
      - text: Show my daily sales from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Break down sales, fees and surcharges by day between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/payment-links/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment link's details
      effect: read
      questions:
      - What amount, name and metadata does a specific payment link have?
      - Can I look up the full record for one payment link?
      instructions:
      - text: Get payment link {id}.
        slots:
          id: path.id
      - text: Show the full details and metadata of payment link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/payment-links/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or deactivate a payment link
      effect: write
      questions:
      - Can I turn off a payment link without deleting it?
      - Is it possible to reactivate a payment link I deactivated earlier?
      instructions:
      - text: Set payment link {id} ({common_name}, {url}) active to {active}.
        slots:
          id: path.id
          common_name: requestBody.common_name
          url: requestBody.url
          active: requestBody.active
      - text: Change payment link {id} to charge {amount}, keeping name {common_name} and URL {url}.
        slots:
          id: path.id
          amount: requestBody.amount
          common_name: requestBody.common_name
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/payment-links/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a payment link
      effect: destructive
      questions:
      - Can I permanently remove a payment link from my account?
      - What happens when a payment link is deleted rather than deactivated?
      instructions:
      - text: Delete payment link {id}.
        slots:
          id: path.id
      - text: Permanently remove payment link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/statement/v3/disputes'].get
  update:
    x-apievangelist-phrasing:
      intent: Report disputes on the statement
      effect: read
      questions:
      - Which chargebacks appear on my statement for a given period?
      - Can I get the disputes section of my monthly statement?
      instructions:
      - text: Show statement disputes from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Pull the chargeback statement report for {startDate} through {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/payment-links/{id}/is-active'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a payment link is active
      effect: read
      questions:
      - Is a particular payment link still accepting payments?
      - Can I check a payment link's active flag without loading all of its details?
      instructions:
      - text: Check whether payment link {id} is active.
        slots:
          id: path.id
      - text: Tell me if payment link {id} is live or inactive.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/depositDetail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the detail of a deposit batch
      effect: read
      questions:
      - Which transactions made up a particular deposit to my bank account?
      - Can I see granular detail for one deposit batch in my timezone?
      instructions:
      - text: Show the detail of deposit batch {batchId} between {startDate} and {endDate}.
        slots:
          batchId: query.batchId
          startDate: query.startDate
          endDate: query.endDate
      - text: Break down deposit details from {startDate} to {endDate} in timezone {timezone}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/deposit'].get
  update:
    x-apievangelist-phrasing:
      intent: List deposits
      effect: read
      questions:
      - What deposits did I receive in my bank account over the last month?
      - Can I list deposits by batch date for a date range?
      instructions:
      - text: List my deposits from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Show deposits batched between {startDate} and {endDate} using UTC offset {timeZoneOffset}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
          timeZoneOffset: query.timeZoneOffset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/statement/v3/adjustments'].get
  update:
    x-apievangelist-phrasing:
      intent: Report refunds and adjustments
      effect: read
      questions:
      - What refunds and adjustments hit my statement this month?
      - Can I pull statement adjustments for a custom date range?
      instructions:
      - text: Show refunds and adjustments from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Get the statement adjustments section for {startDate} through {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/statement/v3/surcharges'].get
  update:
    x-apievangelist-phrasing:
      intent: Report surcharges collected
      effect: read
      questions:
      - How much did I collect in credit card surcharges over a period?
      - Can I see the surcharging section of my statement?
      instructions:
      - text: Show surcharges collected from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Pull my statement surcharging report for {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/statistics/teamSummary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get summary stats for my team
      effect: read
      questions:
      - What are the headline statistics for my merchant team?
      - Is there a quick summary of my team's activity numbers?
      instructions:
      - text: Show my team summary stats.
      - text: Get the current team's statistics overview.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/payment-links/{id}/update-stats'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a payment link's sales stats
      effect: write
      questions:
      - Can I correct the total sales recorded against a payment link?
      - Is it possible to adjust a payment link's transaction statistics?
      instructions:
      - text: Set payment link {id}'s total sales to {total}.
        slots:
          id: path.id
          total: requestBody.total
      - text: Update the sales stats of payment link {id} with a total of {total}.
        slots:
          id: path.id
          total: requestBody.total
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/statement/v3/volumes/card-type'].get
  update:
    x-apievangelist-phrasing:
      intent: Report volume by card brand
      effect: read
      questions:
      - How is my processing volume split between Visa, Mastercard and other card brands?
      - Can I see volumes broken out by card type for a date range?
      instructions:
      - text: Show volume by card type from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Break down card brand volumes between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'