# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adyen Configuration Accounts API
  version: 1.0.0
extends: openapi/adyen-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: 16
- target: $.paths['/accountHolders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account holder
      effect: write
      questions:
      - How do I create an account holder for a legal entity on my balance platform?
      - Can I attach my own reference and metadata to a new account holder?
      instructions:
      - text: Create an account holder for legal entity {legalEntity}.
        slots:
          legalEntity: requestBody.legalEntityId
      - text: Create an account holder for legal entity {legalEntity} with reference {ref}.
        slots:
          legalEntity: requestBody.legalEntityId
          ref: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountHolders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account holder
      effect: read
      questions:
      - What capabilities and status does an account holder have?
      - Can I look up an account holder by its ID?
      instructions:
      - text: Get account holder {id}.
        slots:
          id: path.id
      - text: Show the status and capabilities of account holder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountHolders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an account holder
      effect: write
      questions:
      - Can I change an account holder's primary balance account?
      - Are fields I leave out of an account holder update kept as they were?
      instructions:
      - text: Set the primary balance account of account holder {id} to {balanceAccount}.
        slots:
          id: path.id
          balanceAccount: requestBody.primaryBalanceAccount
      - text: Change the status of account holder {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountHolders/{id}/balanceAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account holder's balance accounts
      effect: read
      questions:
      - Which balance accounts belong to a given account holder?
      - Can I page through an account holder's balance accounts with offset and limit?
      instructions:
      - text: List the balance accounts of account holder {id}.
        slots:
          id: path.id
      - text: Show {limit} balance accounts of account holder {id}, skipping the first {offset}.
        slots:
          id: path.id
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountHolders/{id}/taxForms'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a US tax form for an account holder
      effect: read
      questions:
      - Can I get a US tax form like a 1099 for an account holder?
      - Which year and form type do I need to request an account holder's tax form?
      instructions:
      - text: Get the {formType} tax form for {year} for account holder {id}.
        slots:
          id: path.id
          formType: query.formType
          year: query.year
      - text: Generate account holder {id}'s {year} {formType} form.
        slots:
          id: path.id
          formType: query.formType
          year: query.year
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a balance account
      effect: write
      questions:
      - How do I open a balance account to hold an account holder's funds?
      - Can I set a default currency when creating a balance account?
      instructions:
      - text: Create a balance account for account holder {holder}.
        slots:
          holder: requestBody.accountHolderId
      - text: Open a {currency} balance account for account holder {holder}.
        slots:
          holder: requestBody.accountHolderId
          currency: requestBody.defaultCurrencyCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{balanceAccountId}/sweeps'].get
  update:
    x-apievangelist-phrasing:
      intent: List sweeps on a balance account
      effect: read
      questions:
      - Which automatic sweeps are configured on a balance account?
      - Can I page through a balance account's sweeps?
      instructions:
      - text: List the sweeps configured on balance account {ba}.
        slots:
          ba: path.balanceAccountId
      - text: Show {limit} sweeps for balance account {ba}.
        slots:
          ba: path.balanceAccountId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{balanceAccountId}/sweeps'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a sweep of funds
      effect: write
      questions:
      - Can I automatically move funds out of a balance account on a schedule?
      - Is it possible to trigger a sweep only when the balance passes a threshold?
      instructions:
      - text: Create a {currency} sweep on balance account {ba} to {counterparty} on schedule {schedule}.
        slots:
          ba: path.balanceAccountId
          currency: requestBody.currency
          counterparty: requestBody.counterparty
          schedule: requestBody.schedule
      - text: Set up a sweep on {ba} in {currency} to {counterparty} every {schedule} when the balance exceeds {trigger}.
        slots:
          ba: path.balanceAccountId
          currency: requestBody.currency
          counterparty: requestBody.counterparty
          schedule: requestBody.schedule
          trigger: requestBody.triggerAmount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sweep
      effect: read
      questions:
      - What schedule and counterparty does a specific sweep use?
      - Can I check whether one sweep is still active?
      instructions:
      - text: Get sweep {sweep} on balance account {ba}.
        slots:
          ba: path.balanceAccountId
          sweep: path.sweepId
      - text: Show the schedule of sweep {sweep} for balance account {ba}.
        slots:
          ba: path.balanceAccountId
          sweep: path.sweepId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sweep
      effect: destructive
      questions:
      - Can I stop an automatic sweep permanently?
      - What happens to scheduled fund movements when I delete a sweep?
      instructions:
      - text: Delete sweep {sweep} from balance account {ba}.
        slots:
          ba: path.balanceAccountId
          sweep: path.sweepId
      - text: Remove the automatic sweep {sweep} on {ba}.
        slots:
          ba: path.balanceAccountId
          sweep: path.sweepId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a sweep
      effect: write
      questions:
      - Can I change the schedule or amount of an existing sweep?
      - Can I pause a sweep without deleting it?
      instructions:
      - text: Change the schedule of sweep {sweep} on balance account {ba} to {schedule}.
        slots:
          ba: path.balanceAccountId
          sweep: path.sweepId
          schedule: requestBody.schedule
      - text: Set the status of sweep {sweep} on {ba} to {status}.
        slots:
          ba: path.balanceAccountId
          sweep: path.sweepId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a balance account and its balances
      effect: read
      questions:
      - What is the current balance on a balance account?
      - Does the balance account response include non-default currencies?
      instructions:
      - text: Get balance account {id} with its balances.
        slots:
          id: path.id
      - text: Show how much money is in balance account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a balance account
      effect: write
      questions:
      - Can I change the description or reference on a balance account?
      - Can I close or suspend a balance account by changing its status?
      instructions:
      - text: Update the description of balance account {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Change the status of balance account {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balanceAccounts/{id}/paymentInstruments'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment instruments on a balance account
      effect: read
      questions:
      - Which cards or payment instruments are linked to a balance account?
      - Can I list only active payment instruments for a balance account?
      instructions:
      - text: List the payment instruments linked to balance account {id}.
        slots:
          id: path.id
      - text: Show {status} payment instruments on balance account {id}.
        slots:
          id: path.id
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/grantAccounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a grant account
      effect: read
      questions:
      - What details does a grant account hold?
      - Can I look up a grant account by its ID?
      instructions:
      - text: Get grant account {id}.
        slots:
          id: path.id
      - text: Show the details of grant account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/validateBankAccountIdentification'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate bank account details
      effect: read
      questions:
      - Can I check that bank account details are valid before making a transfer?
      - Is there a way to validate an IBAN before creating a transfer instrument?
      instructions:
      - text: Validate the bank account identification {account}.
        slots:
          account: requestBody.accountIdentification
      - text: Check whether bank details {account} are valid before I send money.
        slots:
          account: requestBody.accountIdentification
      method: generated
      generated: '2026-09-26'