Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Stored Value Check Balance API

2 actions 2 updates phrasing extends openapi/adyen-checkbalance-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['/checkBalance'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adyen Stored Value Check Balance API
  version: 1.0.0
extends: openapi/adyen-checkbalance-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['/checkBalance'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a stored value card balance
      effect: read
      questions:
      - How much value is left on a stored value or gift card?
      - Can I check a stored value balance at a specific store?
      instructions:
      - text: Check the balance on stored value card {card} for merchant {merchant}, reference {ref}.
        slots:
          card: requestBody.paymentMethod
          merchant: requestBody.merchantAccount
          ref: requestBody.reference
      - text: Look up the remaining value of card {card} at store {store} ({merchant}, ref {ref}).
        slots:
          card: requestBody.paymentMethod
          store: requestBody.store
          merchant: requestBody.merchantAccount
          ref: requestBody.reference
      method: generated
      generated: '2026-09-26'