API Evangelist conversational phrasing for Token Io 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 Accounts API
  version: 1.0.0
extends: openapi/token-io-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: 25
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List all bank accounts shared under a consent
      effect: read
      questions:
      - Which bank accounts has a user shared with me through their account-information consent?
      - Can I see every account a customer linked in one call once they have granted access?
      instructions:
      - text: List every bank account covered by access token {token_id}.
        slots:
          token_id: header.on-behalf-of
      - text: Show all linked accounts for consent {token_id}, passing the customer's IP {ip}.
        slots:
          token_id: header.on-behalf-of
          ip: header.token-customer-ip-address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details for one consented bank account
      effect: read
      questions:
      - What details can I pull for a single bank account a user shared with me?
      - Is it possible to look up just one linked account instead of the whole list?
      instructions:
      - text: Get the details of account {account_id} under access token {token_id}.
        slots:
          account_id: path.accountId
          token_id: header.on-behalf-of
      - text: Fetch account information for {account_id} using consent {token_id}.
        slots:
          account_id: path.accountId
          token_id: header.on-behalf-of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get balances for several consented accounts
      effect: read
      questions:
      - Can I fetch balances for multiple linked bank accounts in a single request?
      - What's the quickest way to see balances across all accounts a user shared with me?
      instructions:
      - text: Get balances for accounts {account_ids} under access token {token_id}.
        slots:
          account_ids: query.accountId
          token_id: header.on-behalf-of
      - text: Show the balances of every account covered by consent {token_id}.
        slots:
          token_id: header.on-behalf-of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the balance of one consented account
      effect: read
      questions:
      - How much money is in a specific account a customer linked through open banking?
      - Can I check the current and available balance for one shared account?
      instructions:
      - text: Get the balance of account {account_id} under access token {token_id}.
        slots:
          account_id: path.accountId
          token_id: header.on-behalf-of
      - text: Check how much is in linked account {account_id} with consent {token_id}.
        slots:
          account_id: path.accountId
          token_id: header.on-behalf-of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/standing-orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List standing orders on a consented account
      effect: read
      questions:
      - Which standing orders are set up on a bank account a user shared with me?
      - Can I page through a customer's recurring standing orders once they consent?
      instructions:
      - text: List the first {limit} standing orders on account {account_id} under access token {token_id}.
        slots:
          limit: query.page.limit
          account_id: path.accountId
          token_id: header.on-behalf-of
      - text: Show standing orders for account {account_id}, {limit} per page, starting at offset {offset}, with consent {token_id}.
        slots:
          account_id: path.accountId
          limit: query.page.limit
          offset: query.page.offset
          token_id: header.on-behalf-of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/standing-orders/{standingOrderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one standing order on a consented account
      effect: read
      questions:
      - What are the details of one particular standing order in a user's account?
      - Can I look up a single standing order by its id?
      instructions:
      - text: Get standing order {standing_order_id} on account {account_id} under access token {token_id}.
        slots:
          standing_order_id: path.standingOrderId
          account_id: path.accountId
          token_id: header.on-behalf-of
      - text: Show the payee and schedule of standing order {standing_order_id} using consent {token_id}.
        slots:
          standing_order_id: path.standingOrderId
          token_id: header.on-behalf-of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions on a consented account
      effect: read
      questions:
      - What transactions went through a bank account a customer shared with me?
      - Can I limit a user's transaction history to a date range?
      instructions:
      - text: List the last {limit} transactions on account {account_id} under access token {token_id}.
        slots:
          limit: query.page.limit
          account_id: path.accountId
          token_id: header.on-behalf-of
      - text: Show transactions on account {account_id} between {start_date} and {end_date}, {limit} per page, with consent {token_id}.
        slots:
          account_id: path.accountId
          start_date: query.startDate
          end_date: query.endDate
          limit: query.page.limit
          token_id: header.on-behalf-of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/transaction/{transactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one transaction on a consented account
      effect: read
      questions:
      - Can I pull the details of a single transaction from a user's linked account?
      - What information is returned for one specific bank transaction?
      instructions:
      - text: Get transaction {transaction_id} on account {account_id} under access token {token_id}.
        slots:
          transaction_id: path.transactionId
          account_id: path.accountId
          token_id: header.on-behalf-of
      - text: Look up transaction {transaction_id} with consent {token_id}.
        slots:
          transaction_id: path.transactionId
          token_id: header.on-behalf-of
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{bankAccountId}/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Return an account balance as the bank integration
      effect: read
      questions:
      - As a bank integrating with Token.io, what do I return when asked for an account balance?
      - Which consent and TPP headers accompany a bank-side balance request?
      instructions:
      - text: Return the bank-side balance for bank account {bank_account_id} under consent {consent_id}.
        slots:
          bank_account_id: path.bankAccountId
          consent_id: header.token-consent-id
      - text: Serve the current balance of bank account {bank_account_id} to TPP {tpp_id}.
        slots:
          bank_account_id: path.bankAccountId
          tpp_id: header.token-tpp-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{bankAccountId}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Return account transactions as the bank integration
      effect: read
      questions:
      - On the bank side, how are transactions for an account paged by limit and offset?
      - Can the bank integration filter returned transactions by start and end date?
      instructions:
      - text: Return bank-side transactions for bank account {bank_account_id} from {start_date} to {end_date}.
        slots:
          bank_account_id: path.bankAccountId
          start_date: query.startDate
          end_date: query.endDate
      - text: Serve {limit} transactions for bank account {bank_account_id} under consent {consent_id}.
        slots:
          limit: query.limit
          bank_account_id: path.bankAccountId
          consent_id: header.token-consent-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{bankAccountId}/transactions/{transactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Return one transaction as the bank integration
      effect: read
      questions:
      - As the bank, how do I answer a request for one transaction by its id?
      - Which ids does the bank-side single-transaction lookup need?
      instructions:
      - text: Return bank-side transaction {transaction_id} for bank account {bank_account_id}.
        slots:
          transaction_id: path.transactionId
          bank_account_id: path.bankAccountId
      - text: Serve transaction {transaction_id} of bank account {bank_account_id} to account holder {holder_id}.
        slots:
          transaction_id: path.transactionId
          bank_account_id: path.bankAccountId
          holder_id: header.token-account-holder-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{bankAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Return a bank account as the bank integration
      effect: read
      questions:
      - What does the bank integration return when a TPP retrieves one bank account?
      - Can the bank-side account lookup be scoped to a specific consent id?
      instructions:
      - text: Return bank-side details for bank account {bank_account_id}.
        slots:
          bank_account_id: path.bankAccountId
      - text: Serve bank account {bank_account_id} under consent {consent_id}.
        slots:
          bank_account_id: path.bankAccountId
          consent_id: header.token-consent-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{bankAccountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a bank account when the user disconnects
      effect: destructive
      questions:
      - What happens on the bank side when a user unlinks their account at a TPP?
      - Can a customer's account link be removed after they disconnect it from an app?
      instructions:
      - text: Unlink bank account {bank_account_id} because the user disconnected it.
        slots:
          bank_account_id: path.bankAccountId
      - text: Delete the account link for bank account {bank_account_id}.
        slots:
          bank_account_id: path.bankAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts through the v2 data access API
      effect: read
      questions:
      - Is there a v2 endpoint that lists every account I can access?
      - Where do I get the account list in the newer v2 data access API?
      instructions:
      - text: List all accounts using the v2 data access API.
      - text: Show every account available to me in data access v2.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one account through the v2 data access API
      effect: read
      questions:
      - How can I get a single account's details from the v2 data access API?
      - Does the v2 data access API let me fetch one account by id?
      instructions:
      - text: Get account {account_id} from the v2 data access API.
        slots:
          account_id: query.accountId
      - text: Fetch v2 account details for {account_id}.
        slots:
          account_id: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{accountId}/balances'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account balances through the v2 data access API
      effect: read
      questions:
      - Which v2 endpoint returns the balances of one account?
      - Can I read an account's balances from the v2 data access API?
      instructions:
      - text: Get the balances of account {account_id} from the v2 data access API.
        slots:
          account_id: query.accountId
      - text: Show v2 balances for account {account_id}.
        slots:
          account_id: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{accountId}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List account transactions through the v2 data access API
      effect: read
      questions:
      - Can I filter v2 account transactions by start and end date?
      - What does the v2 data access API return for an account's transaction history?
      instructions:
      - text: List v2 transactions for account {account_id} from {start_date} to {end_date}.
        slots:
          account_id: query.accountId
          start_date: query.startDate
          end_date: query.endDate
      - text: Get {limit} v2 transactions for account {account_id} starting at offset {offset}.
        slots:
          limit: query.limit
          account_id: query.accountId
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/direct-debits'].get
  update:
    x-apievangelist-phrasing:
      intent: List direct debits on a consented account
      effect: read
      questions:
      - Which direct debits are active on a bank account a user shared with me?
      - Can I page through all of a customer's direct debit mandates?
      instructions:
      - text: List direct debits on account {account_id}.
        slots:
          account_id: path.accountId
      - text: Show {limit} direct debits on account {account_id} starting at offset {offset}.
        slots:
          limit: query.page.limit
          account_id: path.accountId
          offset: query.page.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/direct-debits/{directDebitId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one direct debit on a consented account
      effect: read
      questions:
      - What are the details of a specific direct debit on a customer's account?
      - Can I look up a single direct debit mandate by its id?
      instructions:
      - text: Get direct debit {direct_debit_id} on account {account_id}.
        slots:
          direct_debit_id: path.directDebitId
          account_id: path.accountId
      - text: Show who collects direct debit {direct_debit_id} from account {account_id}.
        slots:
          direct_debit_id: path.directDebitId
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/funds-confirmation'].put
  update:
    x-apievangelist-phrasing:
      intent: Check an account has enough funds for an amount
      effect: read
      questions:
      - Can I check whether a user's account has enough money before I charge them?
      - Is there a funds confirmation check for a specific amount on a linked account?
      instructions:
      - text: Confirm account {account_id} has {amount} available.
        slots:
          account_id: path.accountId
          amount: requestBody.amount
      - text: Check whether account {account_id} can cover a payment of {amount}.
        slots:
          account_id: path.accountId
          amount: requestBody.amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/scheduled-payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled payments on a consented account
      effect: read
      questions:
      - What future-dated payments are scheduled on a customer's bank account?
      - Can I see scheduled payments within a date window?
      instructions:
      - text: List scheduled payments on account {account_id}.
        slots:
          account_id: path.accountId
      - text: Show scheduled payments on account {account_id} between {start_date} and {end_date}.
        slots:
          account_id: path.accountId
          start_date: query.startDate
          end_date: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/scheduled-payments/{scheduledPaymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scheduled payment on a consented account
      effect: read
      questions:
      - Can I look up one scheduled payment to see when and how much it will pay?
      - What details come back for a single scheduled payment?
      instructions:
      - text: Get scheduled payment {scheduled_payment_id} on account {account_id}.
        slots:
          scheduled_payment_id: path.scheduledPaymentId
          account_id: path.accountId
      - text: Show the date and amount of scheduled payment {scheduled_payment_id} on account {account_id}.
        slots:
          scheduled_payment_id: path.scheduledPaymentId
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountId}/transfer-destinations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details to pay into a consented account
      effect: read
      questions:
      - What account details do I need to send money into a user's linked account?
      - Can I resolve a shared account into payment destination details like sort code or IBAN?
      instructions:
      - text: Get transfer destination details for account {account_id}.
        slots:
          account_id: path.accountId
      - text: Resolve account {account_id} into details I can pay into.
        slots:
          account_id: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trusted-beneficiaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's trusted beneficiaries
      effect: read
      questions:
      - Who has a customer marked as trusted beneficiaries at their bank?
      - Can I page through all trusted payees a user has consented to share?
      instructions:
      - text: List my customer's trusted beneficiaries.
      - text: Show {limit} trusted beneficiaries starting at offset {offset}.
        slots:
          limit: query.page.limit
          offset: query.page.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trusted-beneficiaries/{beneficiaryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one trusted beneficiary
      effect: read
      questions:
      - What details are stored for a single trusted beneficiary?
      - Can I look up one trusted payee by its beneficiary id?
      instructions:
      - text: Get trusted beneficiary {beneficiary_id}.
        slots:
          beneficiary_id: path.beneficiaryId
      - text: Show the account details of trusted beneficiary {beneficiary_id}.
        slots:
          beneficiary_id: path.beneficiaryId
      method: generated
      generated: '2026-09-26'