API Evangelist conversational phrasing for Token.io's Open Banking API for TPPs Settlement Accounts API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Token.io's Open Banking API for TPPs Settlement Accounts API
  version: 1.0.0
extends: openapi/token-io-settlement-accounts-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: 10
- target: $.paths['/virtual-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List settlement accounts
      effect: read
      questions:
      - Which settlement accounts do I hold, and in which currencies?
      - Can I filter settlement accounts by country or nickname?
      instructions:
      - text: List my settlement accounts in currency {currency}.
        slots:
          currency: query.currency
      - text: Show settlement accounts in {country} nicknamed {nickname}.
        slots:
          country: query.country
          nickname: query.nickname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a settlement account
      effect: write
      questions:
      - How do I open a new settlement account to collect payments?
      - Which currency and country must I pick for a settlement account?
      instructions:
      - text: Create a settlement account in {currency} for country {country}.
        slots:
          currency: requestBody.currency
          country: requestBody.country
      - text: Open a {currency} settlement account in {country} nicknamed {nickname}.
        slots:
          currency: requestBody.currency
          country: requestBody.country
          nickname: requestBody.accountNickName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a settlement account
      effect: read
      questions:
      - What are the details of one of my settlement accounts?
      - Can I look up a settlement account by its id?
      instructions:
      - text: Get settlement account {account_id}.
        slots:
          account_id: path.accountId
      - text: Show the details of settlement account {account_id}.
        slots:
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List settlement account transactions
      effect: read
      questions:
      - Which payments landed in my settlement account this week?
      - Can I filter settlement transactions by amount or reference?
      instructions:
      - text: List transactions in settlement account {account_id} from {start_date} to {end_date}.
        slots:
          account_id: path.accountId
          start_date: query.startDate
          end_date: query.endDate
      - text: Find settlement account {account_id} transactions with reference {ref_id}.
        slots:
          account_id: path.accountId
          ref_id: query.refId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}/transactions/{providerPaymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one settlement account transaction
      effect: read
      questions:
      - Can I pull a single transaction from my settlement account?
      - What details come back for one settlement transaction by provider payment id?
      instructions:
      - text: Get transaction {provider_payment_id} in settlement account {account_id}.
        slots:
          provider_payment_id: path.providerPaymentId
          account_id: path.accountId
      - text: Show settlement transaction {provider_payment_id} on account {account_id}.
        slots:
          provider_payment_id: path.providerPaymentId
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}/settlement-rule'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an automatic settlement rule
      effect: write
      questions:
      - Can I automatically sweep funds from a settlement account to my bank account on a schedule?
      - Can a settlement rule pay out a fixed amount or a percentage at intraday intervals?
      instructions:
      - text: Create a settlement rule on account {account_id} paying {amount_value} ({amount_type}) to {payee} every {interval}, every {hours} hours intraday.
        slots:
          account_id: path.accountId
          amount_value: requestBody.amountValue
          amount_type: requestBody.amountType
          payee: requestBody.payeeAccountDetails
          interval: requestBody.timeInterval
          hours: requestBody.intradayIntervalHours
      - text: Set up a sweep from settlement account {account_id} to {payee} starting {effective_from}.
        slots:
          account_id: path.accountId
          payee: requestBody.payeeAccountDetails
          effective_from: requestBody.effectiveFrom
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}/settlement-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List settlement rules on an account
      effect: read
      questions:
      - Which settlement rules are configured on my settlement account?
      - Can I list only active or only deleted settlement rules?
      instructions:
      - text: List settlement rules on account {account_id}.
        slots:
          account_id: path.accountId
      - text: Show settlement rules on account {account_id} with status {status}.
        slots:
          account_id: path.accountId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}/settlement-rules/{settlementRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one settlement rule
      effect: read
      questions:
      - What does a specific settlement rule do?
      - Can I look up one rule by its settlement rule id?
      instructions:
      - text: Get settlement rule {rule_id} on account {account_id}.
        slots:
          rule_id: path.settlementRuleId
          account_id: path.accountId
      - text: Show the schedule of settlement rule {rule_id} for account {account_id}.
        slots:
          rule_id: path.settlementRuleId
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}/settlement-rules/{settlementRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a settlement rule
      effect: destructive
      questions:
      - Can I stop an automatic sweep by deleting its settlement rule?
      - Which settlement rules can be deleted?
      instructions:
      - text: Delete settlement rule {rule_id} on account {account_id}.
        slots:
          rule_id: path.settlementRuleId
          account_id: path.accountId
      - text: Stop automatic settlement {rule_id} on account {account_id}.
        slots:
          rule_id: path.settlementRuleId
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/virtual-accounts/{accountId}/settlement-rule-payouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List payouts made by settlement rules
      effect: read
      questions:
      - Which payouts did my settlement rules create?
      - Can I see the payouts from one particular settlement rule?
      instructions:
      - text: List settlement rule payouts for account {account_id}.
        slots:
          account_id: path.accountId
      - text: Show payouts created by rule {rule_id} on account {account_id}.
        slots:
          rule_id: requestBody.settlementRuleId
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'