Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Transfers API

3 actions 3 updates phrasing extends openapi/adyen-transfers-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 3

$.info
$.paths['/transfers'].post
$.paths['/transfers/{transferId}/returns'].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 Transfers API
  version: 1.0.0
extends: openapi/adyen-transfers-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: 2
- target: $.paths['/transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer funds out of a balance account
      effect: write
      questions:
      - How do I send money from a balance account to a bank account or another balance account?
      - Can I choose the priority of a funds transfer?
      instructions:
      - text: Transfer {amount} in category {category} to counterparty {counterparty}.
        slots:
          amount: requestBody.amount
          category: requestBody.category
          counterparty: requestBody.counterparty
      - text: Send {amount} from balance account {balanceAccountId} to {counterparty} as {category} with priority {priority}.
        slots:
          amount: requestBody.amount
          balanceAccountId: requestBody.balanceAccountId
          counterparty: requestBody.counterparty
          category: requestBody.category
          priority: requestBody.priority
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transfers/{transferId}/returns'].post
  update:
    x-apievangelist-phrasing:
      intent: Return funds from a previous transfer
      effect: write
      questions:
      - Can I send back money from a transfer I already received?
      - Does returning a transfer create a new transfer ID?
      instructions:
      - text: Return {amount} of transfer {transferId}.
        slots:
          amount: requestBody.amount
          transferId: path.transferId
      - text: Send back {amount} from transfer {transferId} with reference {reference}.
        slots:
          amount: requestBody.amount
          transferId: path.transferId
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'