Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Checkout Cancels API

4 actions 4 updates phrasing extends openapi/adyen-cancels-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['/cancels'].post

$.paths['/orders/cancel'].post

$.paths['/payments/{paymentPspReference}/cancels'].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 Cancels API
  version: 1.0.0
extends: openapi/adyen-cancels-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['/cancels'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an authorisation by merchant reference
      effect: destructive
      questions:
      - Can I cancel an uncaptured payment without its PSP reference?
      - Which webhook tells me a cancellation by my own reference went through?
      instructions:
      - text: Cancel the authorised payment with my reference {paymentRef} on merchant {merchant}.
        slots:
          paymentRef: requestBody.paymentReference
          merchant: requestBody.merchantAccount
      - text: Void the uncaptured payment I referenced as {paymentRef} for merchant account {merchant}.
        slots:
          paymentRef: requestBody.paymentReference
          merchant: requestBody.merchantAccount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order and roll back its payments
      effect: destructive
      questions:
      - What happens to the partial payments when I cancel an order?
      - Can I cancel an order paid with multiple payment methods?
      instructions:
      - text: Cancel order {order} on merchant account {merchant}.
        slots:
          order: requestBody.order
          merchant: requestBody.merchantAccount
      - text: Roll back every payment in order {order} for merchant {merchant}.
        slots:
          order: requestBody.order
          merchant: requestBody.merchantAccount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payments/{paymentPspReference}/cancels'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an authorisation by PSP reference
      effect: destructive
      questions:
      - How do I cancel an authorised payment that hasn't been captured yet?
      - Which webhook confirms a cancellation made with the PSP reference?
      instructions:
      - text: Cancel the authorisation on payment {psp} for merchant {merchant}.
        slots:
          psp: path.paymentPspReference
          merchant: requestBody.merchantAccount
      - text: Release the uncaptured hold on PSP reference {psp} under merchant {merchant}.
        slots:
          psp: path.paymentPspReference
          merchant: requestBody.merchantAccount
      method: generated
      generated: '2026-09-26'