# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mx Technologies ach return API
  version: 1.0.0
extends: openapi/mx-technologies-ach-return-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: 3
- target: $.paths['/ach_returns/{ach_return_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an ACH return
      effect: read
      questions:
      - How do I check the details of a single ACH return I reported?
      - Can I look up an ACH return by either its GUID or my own ID?
      instructions:
      - text: Get ACH return {ach_return}.
        slots:
          ach_return: path.ach_return_guid
      - text: Show the return code and status of ACH return {ach_return}.
        slots:
          ach_return: path.ach_return_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ach_returns'].get
  update:
    x-apievangelist-phrasing:
      intent: List ACH returns
      effect: read
      questions:
      - Which ACH payments have bounced back, and with what return codes?
      - Can I filter ACH returns by institution, return code or status?
      instructions:
      - text: List all ACH returns.
      - text: Show ACH returns with return code {return_code} at institution {institution}.
        slots:
          return_code: query.return_code
          institution: query.institution_guid
      - text: List ACH returns whose status is {return_status}.
        slots:
          return_status: query.return_status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ach_returns'].post
  update:
    x-apievangelist-phrasing:
      intent: Report an ACH return
      effect: write
      questions:
      - How do I tell MX that an ACH debit was returned, for example for insufficient funds?
      - Is ACH return reporting a stable feature or still in beta?
      instructions:
      - text: Create ACH return {ach_return}.
        slots:
          ach_return: requestBody.ach_return
      - text: Report a returned ACH payment with details {ach_return}.
        slots:
          ach_return: requestBody.ach_return
      method: generated
      generated: '2026-09-26'