API Evangelist conversational phrasing for Mx Technologies Transactions API

# 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 Transactions API
  version: 1.0.0
extends: openapi/mx-technologies-transactions-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: 25
- target: $.paths['/transactions/enhance'].post
  update:
    x-apievangelist-phrasing:
      intent: Categorize and cleanse raw transactions
      effect: read
      questions:
      - Can I get messy bank transaction descriptions cleaned up and categorized without storing them?
      - Is there a way to classify a batch of raw transactions I already have into spending categories?
      - Does MX keep the transactions I send for enhancement on its platform?
      instructions:
      - text: 'Enhance these raw transactions with categories and clean descriptions: {transactions}.'
        slots:
          transactions: requestBody.transactions
      - text: Run {transactions} through transaction enhancement and return the cleansed merchant names without persisting anything.
        slots:
          transactions: requestBody.transactions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/accounts/{account_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions for one account by GUID
      effect: read
      questions:
      - What transactions have posted to one specific account, looked up by its MX account GUID?
      - Can I pull a single account's transactions between two dates and filter by top-level category?
      instructions:
      - text: List transactions on account GUID {account} for user GUID {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      - text: Show account {account} transactions for user {user} from {from_date} to {to_date}.
        slots:
          account: path.account_guid
          user: path.user_guid
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/accounts/{account_guid}/transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a transaction to a manual account
      effect: write
      questions:
      - How do I record a cash purchase against an account the user created by hand?
      - Can I add transactions to an aggregated bank account, or only to manual accounts?
      instructions:
      - text: Add manual transaction {transaction} to manual account {account} for user {user}.
        slots:
          transaction: requestBody.transaction
          account: path.account_guid
          user: path.user_guid
      - text: Record a hand-entered transaction on manual account {account} of user {user}.
        slots:
          account: path.account_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a transaction under its member account by GUID
      effect: write
      questions:
      - How do I edit a transaction when I address it through its member and account GUIDs?
      - Can I change a transaction nested under a specific member's account on the GUID-based path?
      instructions:
      - text: Update transaction {transaction} on account {account} of member {member} for user GUID {user} with {changes}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
          changes: requestBody.transaction
      - text: Edit the member-scoped transaction {transaction} under account GUID {account}, member {member}, user {user}.
        slots:
          transaction: path.transaction_guid
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/extend_history'].post
  update:
    x-apievangelist-phrasing:
      intent: Request 24 months of history for a member by GUID
      effect: write
      questions:
      - How do I pull up to two years of transaction history for a bank connection using its MX GUIDs?
      - Could requesting extended history on the GUID path trigger multi-factor authentication?
      instructions:
      - text: Extend transaction history for member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Start an extended 24-month history fetch on member {member} for MX user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's transactions by GUID
      effect: read
      questions:
      - What transactions came in across every account of one bank connection, using MX GUIDs?
      - Can I narrow a member's transactions on the GUID endpoint to those updated since a certain date?
      instructions:
      - text: List all transactions for member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show transactions updated after {from_updated_at} across member {member} for MX user {user}.
        slots:
          from_updated_at: query.from_updated_at
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/tags/{tag_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions carrying a tag by user GUID
      effect: read
      questions:
      - Which transactions has a user labelled with a given tag, looked up by MX user GUID?
      - Can I see tagged transactions for one category only on the GUID-based tag endpoint?
      instructions:
      - text: List transactions tagged {tag} for user GUID {user}.
        slots:
          tag: path.tag_guid
          user: path.user_guid
      - text: Show MX user {user}'s transactions with tag {tag} in category {category}.
        slots:
          user: path.user_guid
          tag: path.tag_guid
          category: query.category_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transaction_rules/{transaction_rule_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transaction rule
      effect: destructive
      questions:
      - How do I permanently remove an auto-categorization rule a user no longer wants?
      - Is deleting a transaction rule reversible?
      instructions:
      - text: Delete transaction rule {rule} for user {user}.
        slots:
          rule: path.transaction_rule_guid
          user: path.user_guid
      - text: Permanently remove rule {rule} from user {user}'s transaction rules.
        slots:
          rule: path.transaction_rule_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all of a user's transactions by GUID
      effect: read
      questions:
      - Can I get every transaction for a user across all their banks and accounts using the MX user GUID?
      - What date and category filters work when listing all of a user's transactions on the GUID path?
      instructions:
      - text: List every transaction for MX user GUID {user}.
        slots:
          user: path.user_guid
      - text: Show all of user GUID {user}'s transactions between {from_date} and {to_date} in top-level category {top_category}.
        slots:
          user: path.user_guid
          from_date: query.from_date
          to_date: query.to_date
          top_category: query.top_level_category_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transactions/{transaction_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one transaction for a user
      effect: read
      questions:
      - How can I look up the details of a single transaction straight from the user, without its account?
      - Can I read a manual transaction by passing its MAN- prefixed GUID?
      instructions:
      - text: Get transaction {transaction} for user {user}.
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
      - text: Read user {user}'s transaction {transaction} including {includes}.
        slots:
          user: path.user_guid
          transaction: path.transaction_guid
          includes: query.includes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transactions/{transaction_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a transaction directly under a user
      effect: write
      questions:
      - How do I change a transaction's details when I only know the user and transaction GUID?
      - Can I recategorize a transaction without going through its member and account?
      instructions:
      - text: Update user {user}'s transaction {transaction} with {changes}.
        slots:
          user: path.user_guid
          transaction: path.transaction_guid
          changes: requestBody.transaction
      - text: Edit transaction {transaction} belonging to user {user} using the user-level path.
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transactions/{transaction_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a manual transaction
      effect: destructive
      questions:
      - How do I remove a transaction the user entered by hand?
      - What GUID format do I use to delete a manually created transaction?
      instructions:
      - text: Delete manual transaction {transaction} for user {user}.
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
      - text: Remove hand-entered transaction {transaction} from user {user}'s records.
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/repeating_transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's recurring transactions
      effect: read
      questions:
      - Which subscriptions and recurring bills does a user have?
      - Can I detect the repeating charges in someone's transaction history?
      instructions:
      - text: List repeating transactions for user {user}.
        slots:
          user: path.user_guid
      - text: Show every recurring charge detected for user {user}.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/repeating_transactions/{repeating_transaction_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one recurring transaction
      effect: read
      questions:
      - How do I look up the details of one specific recurring payment pattern?
      - What does MX know about a single repeating transaction, like its frequency?
      instructions:
      - text: Get repeating transaction {repeating} for user {user}.
        slots:
          repeating: path.repeating_transaction_guid
          user: path.user_guid
      - text: Show details of recurring charge {repeating} on user {user}'s profile.
        slots:
          repeating: path.repeating_transaction_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transactions/{transaction_guid}/split'].post
  update:
    x-apievangelist-phrasing:
      intent: Split a transaction into categorized parts
      effect: write
      questions:
      - Can I break one grocery store charge into separate categories like food and household?
      - Do the split pieces have to add up to the original transaction amount?
      - Can a transaction that was already split be split again?
      instructions:
      - text: Split user {user}'s transaction {transaction} into {splits}.
        slots:
          user: path.user_guid
          transaction: path.transaction_guid
          splits: requestBody.transactions
      - text: 'Divide transaction {transaction} for user {user} into child transactions with their own categories and amounts: {splits}.'
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
          splits: requestBody.transactions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/transactions/{transaction_guid}/split'].delete
  update:
    x-apievangelist-phrasing:
      intent: Undo a split on a user's transaction
      effect: destructive
      questions:
      - How do I remove the child pieces of a split transaction and keep the original?
      - What happens to the parent transaction when its splits are deleted at the user level?
      instructions:
      - text: Delete all splits on transaction {transaction} for user {user}.
        slots:
          transaction: path.transaction_guid
          user: path.user_guid
      - text: Unsplit user {user}'s transaction {transaction} so only the parent remains.
        slots:
          user: path.user_guid
          transaction: path.transaction_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's transactions under its member
      effect: read
      questions:
      - How do I get one account's transactions when I address it through its member on the versioned API?
      - Can I filter an account's transactions by created date when going through the member path?
      instructions:
      - text: List transactions on account {account} of member {member} for user {user}, API version {api_version}.
        slots:
          account: path.account_guid
          member: path.member_guid
          user: path.user_guid
          api_version: header.Accept-Version
      - text: Show member {member}'s account {account} transactions created after {from_created_at} for user {user}.
        slots:
          member: path.member_guid
          account: path.account_guid
          from_created_at: query.from_created_at
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/extend_history'].post
  update:
    x-apievangelist-phrasing:
      intent: Request extended history on the versioned API
      effect: write
      questions:
      - How do I request up to 24 months of transactions for a member identified by my own ID?
      - Which institutions support extended history on the versioned extend endpoint?
      instructions:
      - text: Extend history for member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Fetch two years of transactions for my user ID {user}'s connection {member}.
        slots:
          user: path.user_identifier
          member: path.member_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's transactions on the versioned API
      effect: read
      questions:
      - Which transactions belong to a bank connection when I look it up by the IDs I defined?
      - Can I filter a member's transactions by timestamp range on the versioned endpoint?
      instructions:
      - text: List transactions for member {member} of user {user}, API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show member {member}'s transactions for my user ID {user} between {from_timestamp} and {to_timestamp}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          from_timestamp: query.from_timestamp
          to_timestamp: query.to_timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/tags/{tag_guid}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List tagged transactions on the versioned API
      effect: read
      questions:
      - Which transactions carry a given tag for a user I identify with my own user ID?
      - Can I page through a tag's transactions on the versioned endpoint?
      instructions:
      - text: List transactions tagged {tag} for user {user}, API version {api_version}.
        slots:
          tag: path.tag_guid
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show my user ID {user}'s transactions with tag {tag}, {per_page} per page.
        slots:
          user: path.user_identifier
          tag: path.tag_guid
          per_page: query.records_per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's transactions on the versioned API
      effect: read
      questions:
      - How do I pull every transaction for a user referenced by the ID my own system assigned?
      - Can I restrict a user's full transaction list to a money-movement or PFM use case on the versioned API?
      instructions:
      - text: List all transactions for user {user} on API version {api_version}.
        slots:
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show my user ID {user}'s transactions for the {use_case} use case from {from_date}.
        slots:
          user: path.user_identifier
          use_case: query.use_case
          from_date: query.from_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a transaction under its member account
      effect: read
      questions:
      - How do I read one transaction by walking user, member, account and transaction identifiers?
      - Can I fetch enhanced data for a single transaction inside a specific account?
      instructions:
      - text: Read transaction {transaction} on account {account} of member {member} for user {user}, API version {api_version}.
        slots:
          transaction: path.transaction_identifier
          account: path.account_identifier
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Get account {account}'s transaction {transaction} under member {member} for user {user}, including {includes}.
        slots:
          account: path.account_identifier
          transaction: path.transaction_identifier
          member: path.member_identifier
          user: path.user_identifier
          includes: query.includes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a transaction's description on the versioned API
      effect: write
      questions:
      - How do I rename a transaction's description inside a specific account using my own identifiers?
      - Is the description the only thing I can change on the versioned account transaction update?
      instructions:
      - text: Set the description of transaction {transaction} on account {account}, member {member}, user {user} to {changes}.
        slots:
          transaction: path.transaction_identifier
          account: path.account_identifier
          member: path.member_identifier
          user: path.user_identifier
          changes: requestBody.transaction
      - text: Rename account {account}'s transaction {transaction} for member {member} and user {user} on API version {api_version}.
        slots:
          account: path.account_identifier
          transaction: path.transaction_identifier
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split'].post
  update:
    x-apievangelist-phrasing:
      intent: Split a transaction within a member account
      effect: write
      questions:
      - Can I split a charge into parts when I address it by user, member and account identifiers?
      - How do I split a transaction on the versioned account-scoped endpoint?
      instructions:
      - text: Split transaction {transaction} on account {account} of member {member} for user {user} into {splits}.
        slots:
          transaction: path.transaction_identifier
          account: path.account_identifier
          member: path.member_identifier
          user: path.user_identifier
          splits: requestBody.transactions
      - text: Break account {account}'s transaction {transaction} into child transactions {splits} for member {member}, user {user}, API version {api_version}.
        slots:
          account: path.account_identifier
          transaction: path.transaction_identifier
          splits: requestBody.transactions
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove splits from a transaction in a member account
      effect: destructive
      questions:
      - How do I undo a split for a transaction addressed through its member and account on the versioned API?
      - Does deleting splits within an account leave the parent transaction active?
      instructions:
      - text: Delete splits on transaction {transaction} in account {account} of member {member} for user {user}.
        slots:
          transaction: path.transaction_identifier
          account: path.account_identifier
          member: path.member_identifier
          user: path.user_identifier
      - text: Unsplit account {account}'s transaction {transaction} for member {member}, user {user}, on API version {api_version}.
        slots:
          account: path.account_identifier
          transaction: path.transaction_identifier
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      method: generated
      generated: '2026-09-26'