Akahu · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Akahu Payments API
8 actions
8 updates
phrasing
extends
openapi/akahu-payments-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.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/payments'].get
$.paths['/payments'].post
$.paths['/payments/ird'].post
$.paths['/payments/{id}'].get
$.paths['/v1/one-off-payments'].post
$.paths['/v1/one-off-payments/{paymentId}'].get
$.paths['/v1/one-off-payments/{paymentId}/cancel'].put
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 Akahu Payments API
version: 1.0.0
extends: openapi/akahu-payments-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['/payments'].get
update:
x-apievangelist-phrasing:
intent: List payments made on behalf of the user
effect: read
questions:
- Which payments has my app initiated for the user in the last 30 days?
- Can I list payments within a custom date range?
instructions:
- text: List payments made by my app on behalf of the user.
- text: Show payments initiated between {start} and {end}.
slots:
start: query.start
end: query.end
method: generated
generated: '2026-11-18'
- target: $.paths['/payments'].post
update:
x-apievangelist-phrasing:
intent: Pay another bank account from the user's account
effect: write
questions:
- How do I pay another New Zealand bank account from the user's connected account?
- Can I add a reference to a payment I send?
instructions:
- text: Pay {amount} from account {from} to {to}.
slots:
amount: requestBody.amount
from: requestBody.from
to: requestBody.to
- text: Send a payment of {amount} from {from} to {to} with reference {meta}.
slots:
amount: requestBody.amount
from: requestBody.from
to: requestBody.to
meta: requestBody.meta
method: generated
generated: '2026-11-18'
- target: $.paths['/payments/ird'].post
update:
x-apievangelist-phrasing:
intent: Pay the Inland Revenue Department
effect: write
questions:
- How do I pay tax to Inland Revenue from the user's account?
- Can I send an IRD payment with a reference?
instructions:
- text: Pay {amount} to Inland Revenue from account {from}.
slots:
amount: requestBody.amount
from: requestBody.from
- text: Send tax payment {amount} from {from} with reference {meta}.
slots:
amount: requestBody.amount
from: requestBody.from
meta: requestBody.meta
method: generated
generated: '2026-11-18'
- target: $.paths['/payments/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a payment my app initiated
effect: read
questions:
- What's the status of a payment my app started for the user?
- Can I look up one payment by its ID?
instructions:
- text: Get payment {id}.
slots:
id: path.id
- text: Show the status of payment {id} my app initiated.
slots:
id: path.id
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/one-off-payments'].post
update:
x-apievangelist-phrasing:
intent: Pay a one-off amount from a user's bank account
effect: write
questions:
- How do I pay money from my user's New Zealand bank account?
- Can I set an expiry time on a payment before authorisation?
- Where does the user go to authorise a payment?
instructions:
- text: Pay {amount} to {payee} from {payer} and redirect to {redirect_uri}.
slots:
amount: requestBody.amount
payee: requestBody.payee
payer: requestBody.payer
redirect_uri: requestBody.redirect_uri
- text: Create a one-off payment of {amount} to {payee} that expires {expires_at}.
slots:
amount: requestBody.amount
payee: requestBody.payee
expires_at: requestBody.expires_at
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/one-off-payments/{paymentId}'].get
update:
x-apievangelist-phrasing:
intent: Get a one-off payment
effect: read
questions:
- Has the user completed authorisation of a one-off payment?
- What's the status of a one-off payment?
instructions:
- text: Get one-off payment {paymentId}.
slots:
paymentId: path.paymentId
- text: Check whether one-off payment {paymentId} has been authorised.
slots:
paymentId: path.paymentId
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/one-off-payments/{paymentId}/cancel'].put
update:
x-apievangelist-phrasing:
intent: Cancel a pending one-off payment
effect: destructive
questions:
- Can I cancel a one-off payment before the user authorises it?
- What happens to a one-off payment if I cancel it while it's still pending?
instructions:
- text: Cancel one-off payment {paymentId}.
slots:
paymentId: path.paymentId
- text: Cancel pending one-off payment {paymentId} so it is not processed.
slots:
paymentId: path.paymentId
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/akahu-payments-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.