Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Transactions API

8 actions 8 updates phrasing extends openapi/akahu-transactions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Akahu's API. It is a proposal applied on top of the contract, not a document Akahu publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/accounts/{id}/transactions'].get
$.paths['/accounts/{id}/transactions/pending'].get
$.paths['/transactions'].get
$.paths['/transactions/ids'].post
$.paths['/transactions/pending'].get
$.paths['/transactions/{id}'].get
$.paths['/transactions/{code}'].get

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 Akahu Transactions API
  version: 1.0.0
extends: openapi/akahu-transactions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-18'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/accounts/{id}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List settled transactions for an account
      effect: read
      questions:
      - How do I pull settled transactions for one connected bank account?
      - Can I filter an account's transactions by a date range?
      instructions:
      - text: List settled transactions for account {id}.
        slots:
          id: path.id
      - text: Show account {id} transactions between {start} and {end}.
        slots:
          id: path.id
          start: query.start
          end: query.end
      method: generated
      generated: '2026-11-18'
- target: $.paths['/accounts/{id}/transactions/pending'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending transactions for an account
      effect: read
      questions:
      - What's in progress on a user's bank account right now?
      - Are pending transactions for one account stable?
      instructions:
      - text: List pending transactions for account {id}.
        slots:
          id: path.id
      - text: Show unsettled transactions on {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List settled transactions across all accounts
      effect: read
      questions:
      - How do I get all settled transactions across every connected account?
      - Can I pull every user transaction in one call?
      instructions:
      - text: List all settled transactions for my app.
      - text: Show every connected account's transactions between {start} and {end}.
        slots:
          start: query.start
          end: query.end
      method: generated
      generated: '2026-11-18'
- target: $.paths['/transactions/ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch transactions by ID
      effect: read
      questions:
      - How do I get full transaction records from a list of transaction IDs?
      - Can I turn transaction webhook IDs back into complete transactions?
      instructions:
      - text: Fetch transactions {transaction_ids}.
        slots:
          transaction_ids: header.X-Akahu-Id
      - text: Retrieve the full records for transaction IDs {transaction_ids}.
        slots:
          transaction_ids: header.X-Akahu-Id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/transactions/pending'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending transactions across all accounts
      effect: read
      questions:
      - Which transactions are still pending across all the accounts a user has connected to my app?
      - Are pending transactions reliable, and how do I tell when one was last fetched?
      - Can I see what's pending on every connected account without querying each one?
      instructions:
      - text: List all pending transactions for the app {app_id} across every connected account.
        slots:
          app_id: header.X-Akahu-Id
      - text: Show unsettled transactions across all of a user's connected accounts using app ID {app_id}.
        slots:
          app_id: header.X-Akahu-Id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/transactions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single transaction
      effect: read
      questions:
      - How do I look up one transaction by its ID?
      - What does a single transaction record contain?
      instructions:
      - text: Get transaction {id}.
        slots:
          id: path.id
      - text: Show the details of transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/transactions/{code}'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions from a one-off authorization
      effect: read
      questions:
      - How do I get transactions after a user shares an account with my app through a one-off code?
      - Can I page through transactions from a one-off authorization code?
      instructions:
      - text: List transactions from one-off code {code}.
        slots:
          code: path.code
      - text: Get the first page of transactions for authorization {code}.
        slots:
          code: path.code
      method: generated
      generated: '2026-11-18'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/akahu-transactions-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.