Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Payment Capture API

2 actions 2 updates phrasing extends openapi/adyen-capture-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['/capture'].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 Payment Capture API
  version: 1.0.0
extends: openapi/adyen-capture-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['/capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture an authorisation by original reference
      effect: write
      questions:
      - Can I capture only part of an authorisation using the classic capture endpoint?
      - Which original reference does a classic capture need?
      instructions:
      - text: Capture {modificationAmount} of authorisation {originalReference} on merchant {merchantAccount}.
        slots:
          modificationAmount: requestBody.modificationAmount
          originalReference: requestBody.originalReference
          merchantAccount: requestBody.merchantAccount
      - text: Settle the held funds {modificationAmount} on {originalReference} for {merchantAccount} using the classic endpoint.
        slots:
          modificationAmount: requestBody.modificationAmount
          originalReference: requestBody.originalReference
          merchantAccount: requestBody.merchantAccount
      method: generated
      generated: '2026-09-26'