Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Recurring Notify Shopper API

2 actions 2 updates phrasing extends openapi/adyen-notifyshopper-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['/notifyShopper'].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 Recurring Notify Shopper API
  version: 1.0.0
extends: openapi/adyen-notifyshopper-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['/notifyShopper'].post
  update:
    x-apievangelist-phrasing:
      intent: Pre-notify a shopper of an upcoming recurring charge
      effect: write
      questions:
      - Is there a way to have the issuer warn Indian cardholders before a recurring charge?
      - Can I include a billing date in the shopper pre-debit notice?
      instructions:
      - text: Ask the issuer to notify shopper {shopperReference} of a {amount} charge, reference {reference}, merchant {merchantAccount}.
        slots:
          shopperReference: requestBody.shopperReference
          amount: requestBody.amount
          reference: requestBody.reference
          merchantAccount: requestBody.merchantAccount
      - text: Send a pre-debit notice for {amount} billed on {billingDate} to {shopperReference}, {merchantAccount}, ref {reference}.
        slots:
          amount: requestBody.amount
          billingDate: requestBody.billingDate
          shopperReference: requestBody.shopperReference
          merchantAccount: requestBody.merchantAccount
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'