Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Terminal Balanceinquiry API

2 actions 2 updates phrasing extends openapi/adyen-balanceinquiry-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adyen's API. It is a proposal applied on top of the contract, not a document Adyen publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/balanceinquiry'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adyen Terminal Balanceinquiry API
  version: 1.0.0
extends: openapi/adyen-balanceinquiry-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: 1
- target: $.paths['/balanceinquiry'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a card or loyalty balance on a terminal
      effect: read
      questions:
      - Can the terminal tell me the balance on a shopper's card?
      - Can I check a loyalty account balance at the point of sale?
      instructions:
      - text: Check the balance of payment account {account} on the terminal.
        slots:
          account: requestBody.PaymentAccountReq
      - text: Run a terminal balance inquiry for loyalty account {loyalty}.
        slots:
          loyalty: requestBody.LoyaltyAccountReq
      method: generated
      generated: '2026-09-26'