Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Balance API

4 actions 4 updates phrasing extends openapi/adyen-balance-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 4

$.info

$.paths['/balanceTransfer'].post

$.paths['/paymentMethods/balance'].post

$.paths['/balancePlatforms/{id}'].get

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 Balance API
  version: 1.0.0
extends: openapi/adyen-balance-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: 3
- target: $.paths['/balanceTransfer'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer balance between merchant accounts
      effect: write
      questions:
      - Can I move funds between two merchant accounts in the same company?
      - What conditions must be met before a balance transfer succeeds?
      instructions:
      - text: Transfer {amount} from merchant {from} to merchant {to} as a {type} transfer.
        slots:
          amount: requestBody.amount
          from: requestBody.fromMerchant
          to: requestBody.toMerchant
          type: requestBody.type
      - text: Move {amount} of {type} balance from {from} to {to} with reference {ref}.
        slots:
          amount: requestBody.amount
          from: requestBody.fromMerchant
          to: requestBody.toMerchant
          type: requestBody.type
          ref: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentMethods/balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a gift card balance
      effect: read
      questions:
      - How much is left on a shopper's gift card?
      - Can I check a gift card balance before the shopper pays?
      instructions:
      - text: Check the balance of gift card {card} for merchant {merchant}, amount {amount}.
        slots:
          card: requestBody.paymentMethod
          merchant: requestBody.merchantAccount
          amount: requestBody.amount
      - text: Find out whether gift card {card} covers {amount} on merchant account {merchant}.
        slots:
          card: requestBody.paymentMethod
          merchant: requestBody.merchantAccount
          amount: requestBody.amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balancePlatforms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a balance platform
      effect: read
      questions:
      - What details does my balance platform have?
      - Can I look up a balance platform by ID?
      instructions:
      - text: Get balance platform {id}.
        slots:
          id: path.id
      - text: Show the status of balance platform {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'