Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Checkout Links API

4 actions 4 updates phrasing extends openapi/adyen-links-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['/paymentLinks'].post
$.paths['/paymentLinks/{linkId}'].get
$.paths['/paymentLinks/{linkId}'].patch

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 Checkout Links API
  version: 1.0.0
extends: openapi/adyen-links-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['/paymentLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payment link
      effect: write
      questions:
      - How do I send a customer a link to Adyen's hosted payment page?
      - Can a payment link expire at a set time or be reused by many shoppers?
      instructions:
      - text: Create a payment link for {amount} on merchant {merchantAccount} with reference {reference}.
        slots:
          amount: requestBody.amount
          merchantAccount: requestBody.merchantAccount
          reference: requestBody.reference
      - text: Create a reusable {reusable} pay link that expires at {expiresAt}.
        slots:
          reusable: requestBody.reusable
          expiresAt: requestBody.expiresAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentLinks/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a payment link
      effect: read
      questions:
      - Has a customer paid the payment link I sent?
      - What amount and expiry does an existing payment link have?
      instructions:
      - text: Get payment link {linkId}.
        slots:
          linkId: path.linkId
      - text: Show the status of pay link {linkId}.
        slots:
          linkId: path.linkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/paymentLinks/{linkId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Expire a payment link early
      effect: destructive
      questions:
      - Can I force a payment link to expire before its expiry date?
      - How do I stop a customer from paying a link I sent by mistake?
      instructions:
      - text: Set payment link {linkId} status to {status}.
        slots:
          linkId: path.linkId
          status: requestBody.status
      - text: Expire pay link {linkId} now by setting status {status}.
        slots:
          linkId: path.linkId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'