Airwallex · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Airwallex Open Payment Intents API

6 actions 6 updates phrasing extends openapi/airwallex-payment-intents-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 6

$.info
$.paths['/api/v1/payment_intents/create'].post
$.paths['/api/v1/payment_intents/{id}'].get
$.paths['/api/v1/payment_intents/{id}/confirm'].post
$.paths['/api/v1/payment_intents/{id}/capture'].post
$.paths['/api/v1/payment_intents/{id}/cancel'].post

OpenAPI Overlay

Raw ↑
# 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 Payment Intents API
  version: 1.0.0
extends: openapi/airwallex-payment-intents-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: 5
- target: $.paths['/api/v1/payment_intents/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new payment
      effect: write
      questions:
      - How do I start collecting a payment from a customer in Airwallex?
      - Can I create a payment intent before the shopper enters card details?
      - What is the first step to accept a new online payment?
      instructions:
      - text: Create a new payment intent for an order.
      - text: Start a new payment so the customer can check out.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/payment_intents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a payment's status
      effect: read
      questions:
      - Did a particular payment succeed or is it still pending?
      - Can I look up the current state of a payment intent?
      instructions:
      - text: Show me payment intent {id}.
        slots:
          id: path.id
      - text: Tell me the current status of payment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/payment_intents/{id}/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a payment
      effect: write
      questions:
      - How do I confirm a payment intent so the charge goes through?
      - Can I submit a pending payment for processing once the customer is ready?
      instructions:
      - text: Confirm payment intent {id}.
        slots:
          id: path.id
      - text: Submit payment {id} for processing now.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/payment_intents/{id}/capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture an authorized payment
      effect: write
      questions:
      - Can I collect funds on a payment that was only authorized?
      - When should I capture a payment after the order ships?
      instructions:
      - text: Capture the authorized funds on payment {id}.
        slots:
          id: path.id
      - text: Collect the money for payment intent {id} now that the order has shipped.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/payment_intents/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a payment
      effect: destructive
      questions:
      - Can I cancel a payment that has not been completed yet?
      - What happens if I cancel a payment intent the customer abandoned?
      instructions:
      - text: Cancel payment intent {id}.
        slots:
          id: path.id
      - text: Void payment {id} because the customer abandoned the order.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'