Airwallex · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Airwallex Open Beneficiaries API

4 actions 4 updates phrasing extends openapi/airwallex-beneficiaries-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Airwallex's API. It is a proposal applied on top of the contract, not a document Airwallex publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/v1/beneficiaries'].get

$.paths['/api/v1/beneficiaries/create'].post

$.paths['/api/v1/beneficiaries/{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 Airwallex Open Beneficiaries API
  version: 1.0.0
extends: openapi/airwallex-beneficiaries-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['/api/v1/beneficiaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved beneficiaries
      effect: read
      questions:
      - Which beneficiaries have I already saved in Airwallex?
      - Can I see everyone I have set up to receive payments?
      - How do I get a list of all my payment recipients?
      instructions:
      - text: List all my saved beneficiaries.
      - text: Show me every payment recipient on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/beneficiaries/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new beneficiary
      effect: write
      questions:
      - How do I add a new person or business I want to pay?
      - Can I save a new recipient's bank details as a beneficiary?
      instructions:
      - text: Add a new beneficiary to my account.
      - text: Create a beneficiary record for a supplier I need to start paying.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/beneficiaries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one beneficiary
      effect: read
      questions:
      - What details are stored for a specific beneficiary?
      - Can I pull up one recipient by its beneficiary ID?
      instructions:
      - text: Show me the details of beneficiary {id}.
        slots:
          id: path.id
      - text: Look up beneficiary {id} and tell me what bank details it holds.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'