# 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 Pay by Link API
  version: 1.0.0
extends: openapi/token-io-pay-by-link-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: 4
- target: $.paths['/v2/payment-links'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment links with filters
      effect: read
      questions:
      - Which of my payment links are still active?
      - Can I find payment links created in a date range or expiring soon?
      - Do I have to pass a filter when listing payment links?
      instructions:
      - text: List payment links with statuses {statuses}.
        slots:
          statuses: query.statuses
      - text: Show payment links created between {created_after} and {created_before}.
        slots:
          created_after: query.createdAfter
          created_before: query.createdBefore
      - text: Find payment links for PSU reference {psu_ref}.
        slots:
          psu_ref: query.externalPsuReference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/payment-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shareable payment link
      effect: write
      questions:
      - Can I create a payment URL to send to a customer instead of building a checkout?
      - Is a payment link reusable, or single-use only?
      instructions:
      - text: Create a payment link from template {template}.
        slots:
          template: requestBody.paymentTemplate
      - text: Create a payment link from template {template} with link settings {config}.
        slots:
          template: requestBody.paymentTemplate
          config: requestBody.linkConfig
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/payment-links/{paymentLinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment link and its usage
      effect: read
      questions:
      - How many times has a particular payment link been used?
      - Can I see the details of one payment link by id?
      instructions:
      - text: Get payment link {payment_link_id}.
        slots:
          payment_link_id: path.paymentLinkId
      - text: Show usage statistics for payment link {payment_link_id}.
        slots:
          payment_link_id: path.paymentLinkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/payment-links/{paymentLinkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a payment link
      effect: destructive
      questions:
      - Can I stop a payment link from being used any more?
      - Which payment links are eligible to be deactivated?
      instructions:
      - text: Deactivate payment link {payment_link_id}.
        slots:
          payment_link_id: path.paymentLinkId
      - text: Stop payment link {payment_link_id} from accepting payments.
        slots:
          payment_link_id: path.paymentLinkId
      method: generated
      generated: '2026-09-26'