Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Transfers Grants API

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

$.paths['/grants'].post

$.paths['/grants/{id}'].get

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 Transfers Grants API
  version: 1.0.0
extends: openapi/adyen-grants-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['/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List capital grants and outstanding balances
      effect: read
      questions:
      - What capital grants do my users have and how much is still owed?
      - Can I list grants for one specific account holder?
      instructions:
      - text: List all grants with their status and outstanding balance.
      - text: List grants for account holder {counterpartyAccountHolderId}.
        slots:
          counterpartyAccountHolderId: query.counterpartyAccountHolderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay out an accepted capital grant offer
      effect: write
      questions:
      - How do I request the payout of a capital grant offer?
      - Can I choose where the grant funds get paid out?
      instructions:
      - text: Request payout of grant offer {grantOfferId} into grant account {grantAccountId}.
        slots:
          grantOfferId: requestBody.grantOfferId
          grantAccountId: requestBody.grantAccountId
      - text: Pay out offer {grantOfferId} on account {grantAccountId} to counterparty {counterparty}.
        slots:
          grantOfferId: requestBody.grantOfferId
          grantAccountId: requestBody.grantAccountId
          counterparty: requestBody.counterparty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/grants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one grant's details
      effect: read
      questions:
      - What's the repayment status of a single capital grant?
      - Can I look up one grant by its reference?
      instructions:
      - text: Get grant {id}.
        slots:
          id: path.id
      - text: Show the balance and status of capital grant {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'