Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Legal Entity Management Transfer Instruments API

5 actions 5 updates phrasing extends openapi/adyen-transferinstruments-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 5

$.info

$.paths['/transferInstruments'].post

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

$.paths['/transferInstruments/{id}'].delete

$.paths['/transferInstruments/{id}'].patch

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 Legal Entity Management Transfer Instruments API
  version: 1.0.0
extends: openapi/adyen-transferinstruments-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: 4
- target: $.paths['/transferInstruments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a bank account as a transfer instrument
      effect: write
      questions:
      - How do I register a legal entity's bank account for payouts?
      - Does a new transfer instrument go through verification checks?
      instructions:
      - text: Create a {type} transfer instrument for legal entity {le} with bank account {bank}.
        slots:
          type: requestBody.type
          le: requestBody.legalEntityId
          bank: requestBody.bankAccount
      - text: Register bank account {bank} for legal entity {le} as a {type} instrument.
        slots:
          type: requestBody.type
          le: requestBody.legalEntityId
          bank: requestBody.bankAccount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transferInstruments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transfer instrument
      effect: read
      questions:
      - What bank account details are on a transfer instrument?
      - Can I look up a transfer instrument by ID?
      instructions:
      - text: Get transfer instrument {id}.
        slots:
          id: path.id
      - text: Show the bank account behind transfer instrument {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transferInstruments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transfer instrument
      effect: destructive
      questions:
      - Can I remove a bank account that is no longer used for payouts?
      - Is deleting a transfer instrument permanent?
      instructions:
      - text: Delete transfer instrument {id}.
        slots:
          id: path.id
      - text: Remove the bank account registered as transfer instrument {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transferInstruments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a transfer instrument
      effect: write
      questions:
      - Can I change the bank account details on an existing transfer instrument?
      - Which fields must I resend when updating a transfer instrument?
      instructions:
      - text: Update transfer instrument {id} with bank account {bank} for legal entity {le}, type {type}.
        slots:
          id: path.id
          bank: requestBody.bankAccount
          le: requestBody.legalEntityId
          type: requestBody.type
      - text: Replace the bank details on instrument {id} with {bank} (legal entity {le}, type {type}).
        slots:
          id: path.id
          bank: requestBody.bankAccount
          le: requestBody.legalEntityId
          type: requestBody.type
      method: generated
      generated: '2026-09-26'