# 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 Instruments API
  version: 1.0.0
extends: openapi/adyen-instruments-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: 9
- target: $.paths['/paymentInstrumentGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group of payment instruments
      effect: write
      questions:
      - How do I group issued cards together so one transaction rule covers them all?
      - What balance platform and card variant does a payment instrument group need?
      instructions:
      - text: Create a payment instrument group on balance platform {balancePlatform} for variant {txVariant}.
        slots:
          balancePlatform: requestBody.balancePlatform
          txVariant: requestBody.txVariant
      - text: Create an instrument group {reference} on {balancePlatform} with tx variant {txVariant} and description {description}.
        slots:
          reference: requestBody.reference
          balancePlatform: requestBody.balancePlatform
          txVariant: requestBody.txVariant
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstrumentGroups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment instrument group
      effect: read
      questions:
      - What's in a particular payment instrument group?
      - Can I look up the balance platform a card group belongs to?
      instructions:
      - text: Get payment instrument group {id}.
        slots:
          id: path.id
      - text: Show the details of instrument group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstrumentGroups/{id}/transactionRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction rules on an instrument group
      effect: read
      questions:
      - Which spending rules apply to a whole group of cards?
      - What transaction rules are attached to a payment instrument group?
      instructions:
      - text: List transaction rules for payment instrument group {id}.
        slots:
          id: path.id
      - text: Show every rule that applies to instrument group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstruments'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a card or business account
      effect: write
      questions:
      - How do I issue a virtual or physical card to one of my users?
      - Can I create a business account instrument instead of a card?
      instructions:
      - text: Issue a {type} payment instrument on balance account {balanceAccountId} in country {issuingCountryCode}.
        slots:
          type: requestBody.type
          balanceAccountId: requestBody.balanceAccountId
          issuingCountryCode: requestBody.issuingCountryCode
      - text: Create a card instrument for balance account {balanceAccountId}, country {issuingCountryCode}, type {type}, with card details {card}.
        slots:
          balanceAccountId: requestBody.balanceAccountId
          issuingCountryCode: requestBody.issuingCountryCode
          type: requestBody.type
          card: requestBody.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstruments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment instrument
      effect: read
      questions:
      - What status is a particular issued card in?
      - Which balance account is a payment instrument linked to?
      instructions:
      - text: Get payment instrument {id}.
        slots:
          id: path.id
      - text: Show status and balance account of instrument {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstruments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Block, suspend or reactivate a card
      effect: write
      questions:
      - How do I suspend or block a card I've issued?
      - Which fields can I still change once a payment instrument is active?
      instructions:
      - text: Set payment instrument {id} status to {status} with reason {statusReason}.
        slots:
          id: path.id
          status: requestBody.status
          statusReason: requestBody.statusReason
      - text: Move instrument {id} to balance account {balanceAccountId}.
        slots:
          id: path.id
          balanceAccountId: requestBody.balanceAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstruments/{id}/networkTokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List network tokens for a card
      effect: read
      questions:
      - Which wallet or network tokens exist for one of my issued cards?
      - Can I see all tokens provisioned from a payment instrument?
      instructions:
      - text: List network tokens for payment instrument {id}.
        slots:
          id: path.id
      - text: Show tokens provisioned from card {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstruments/{id}/reveal'].get
  update:
    x-apievangelist-phrasing:
      intent: Reveal a card's full card number
      effect: read
      questions:
      - How can I retrieve the full PAN of a card I issued?
      - What role does my credential need to reveal a card number?
      instructions:
      - text: Reveal the PAN of payment instrument {id}.
        slots:
          id: path.id
      - text: Get the full card number for instrument {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentInstruments/{id}/transactionRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction rules on one card
      effect: read
      questions:
      - What spending rules are applied to one specific card?
      - Can I check which rules might decline transactions on a payment instrument?
      instructions:
      - text: Get the rules applied to the single card instrument {id}.
        slots:
          id: path.id
      - text: Show the rules attached to card {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'