Adyen · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adyen Checkout Payments API
7 actions
7 updates
phrasing
extends
openapi/adyen-payments-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.
What the actions change
x-apievangelist-phrasing
Targets 7
$.info
$.paths['/paymentSession'].post
$.paths['/payments'].post
$.paths['/payments/details'].post
$.paths['/payments/result'].post
$.paths['/payments/{paymentPspReference}/refunds'].post
$.paths['/payments/{paymentPspReference}/reversals'].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 Checkout Payments API
version: 1.0.0
extends: openapi/adyen-payments-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: 6
- target: $.paths['/paymentSession'].post
update:
x-apievangelist-phrasing:
intent: Create a legacy Checkout SDK payment session
effect: write
questions:
- Where do I get the payment session data the older Checkout SDK needs to start?
- Can I enable one-click or recurring when creating a payment session?
instructions:
- text: Create a payment session for {amount} in {countryCode} on merchant {merchantAccount}, reference {reference}, returning to {returnUrl}.
slots:
amount: requestBody.amount
countryCode: requestBody.countryCode
merchantAccount: requestBody.merchantAccount
reference: requestBody.reference
returnUrl: requestBody.returnUrl
- text: Start a Checkout SDK session for shopper {shopperReference} with recurring enabled {enableRecurring}.
slots:
shopperReference: requestBody.shopperReference
enableRecurring: requestBody.enableRecurring
method: generated
generated: '2026-09-26'
- target: $.paths['/payments'].post
update:
x-apievangelist-phrasing:
intent: Start a payment
effect: write
questions:
- How do I charge a shopper's card with Adyen Checkout?
- Can I pay in installments or split the funds when I start a payment?
- What happens if the payment needs a redirect or 3D Secure?
instructions:
- text: Charge {amount} with payment method {paymentMethod} on merchant {merchantAccount}, reference {reference}, return URL {returnUrl}.
slots:
amount: requestBody.amount
paymentMethod: requestBody.paymentMethod
merchantAccount: requestBody.merchantAccount
reference: requestBody.reference
returnUrl: requestBody.returnUrl
- text: Start a payment for shopper {shopperReference} and store the payment method {storePaymentMethod}.
slots:
shopperReference: requestBody.shopperReference
storePaymentMethod: requestBody.storePaymentMethod
method: generated
generated: '2026-09-26'
- target: $.paths['/payments/details'].post
update:
x-apievangelist-phrasing:
intent: Submit extra details to finish a payment
effect: write
questions:
- What call completes a payment after the shopper returns from a redirect?
- Where do I send the 3D Secure result to finalize a payment?
instructions:
- text: Submit payment details {details} to complete the pending payment.
slots:
details: requestBody.details
- text: Finish the redirect payment with details {details} and payment data {paymentData}.
slots:
details: requestBody.details
paymentData: requestBody.paymentData
method: generated
generated: '2026-09-26'
- target: $.paths['/payments/result'].post
update:
x-apievangelist-phrasing:
intent: Verify a payment result from the SDK
effect: read
questions:
- How do I confirm the final result of a payment the Checkout SDK returned?
- Can I verify an SDK payment payload server-side?
instructions:
- text: Verify the payment result payload {payload}.
slots:
payload: requestBody.payload
- text: Check the outcome of the SDK payment using {payload}.
slots:
payload: requestBody.payload
method: generated
generated: '2026-09-26'
- target: $.paths['/payments/{paymentPspReference}/refunds'].post
update:
x-apievangelist-phrasing:
intent: Refund a captured payment
effect: write
questions:
- How do I refund a payment that has already been captured?
- Can I refund only part of a captured payment?
instructions:
- text: Refund {amount} of payment {paymentPspReference} on merchant {merchantAccount}.
slots:
amount: requestBody.amount
paymentPspReference: path.paymentPspReference
merchantAccount: requestBody.merchantAccount
- text: Refund captured payment {paymentPspReference} for {amount} with reason {merchantRefundReason}, merchant {merchantAccount}.
slots:
paymentPspReference: path.paymentPspReference
amount: requestBody.amount
merchantRefundReason: requestBody.merchantRefundReason
merchantAccount: requestBody.merchantAccount
method: generated
generated: '2026-09-26'
- target: $.paths['/payments/{paymentPspReference}/reversals'].post
update:
x-apievangelist-phrasing:
intent: Reverse a payment whether captured or not
effect: destructive
questions:
- What if I don't know whether a payment was captured and just want the money back to the shopper?
- Does a reversal cancel an uncaptured payment instead of refunding it?
instructions:
- text: Reverse payment {paymentPspReference} on merchant {merchantAccount}.
slots:
paymentPspReference: path.paymentPspReference
merchantAccount: requestBody.merchantAccount
- text: Refund or cancel {paymentPspReference} in full for {merchantAccount} with reference {reference}.
slots:
paymentPspReference: path.paymentPspReference
merchantAccount: requestBody.merchantAccount
reference: requestBody.reference
method: generated
generated: '2026-09-26'