Akahu Payments API

The Payments API from Akahu — 6 operation(s) for payments.

GitHub OpenAPI
Business capability
Payment Initiation Management BC-1340.10

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /payments List payments made on behalf of the user · List payments #
Ask an LLM
“Which payments has my app initiated for the user in the last 30 days?”
“Can I list payments within a custom date range?”
Tell an agent
List payments made by my app on behalf of the user.
Show payments initiated between {start} and {end}.
POST /payments Pay another bank account from the user's account · Make a payment #
Ask an LLM
“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?”
Tell an agent
Pay {amount} from account {from} to {to}.
Send a payment of {amount} from {from} to {to} with reference {meta}.
POST /payments/ird Pay the Inland Revenue Department · Make a payment to IRD #
Ask an LLM
“How do I pay tax to Inland Revenue from the user's account?”
“Can I send an IRD payment with a reference?”
Tell an agent
Pay {amount} to Inland Revenue from account {from}.
Send tax payment {amount} from {from} with reference {meta}.
GET /payments/{id} Get a payment my app initiated · Get a payment #
Ask an LLM
“What's the status of a payment my app started for the user?”
“Can I look up one payment by its ID?”
Tell an agent
Get payment {id}.
Show the status of payment {id} my app initiated.
POST /v1/one-off-payments Pay a one-off amount from a user's bank account · Create one-off payment #
Ask an LLM
“How do I pay money from my user's New Zealand bank account?”
“Can I set an expiry time on a payment before authorisation?”
Tell an agent
Pay {amount} to {payee} from {payer} and redirect to {redirect_uri}.
Create a one-off payment of {amount} to {payee} that expires {expires_at}.
GET /v1/one-off-payments/{paymentId} Get a one-off payment · Get one-off payment #
Ask an LLM
“Has the user completed authorisation of a one-off payment?”
“What's the status of a one-off payment?”
Tell an agent
Get one-off payment {paymentId}.
Check whether one-off payment {paymentId} has been authorised.
PUT /v1/one-off-payments/{paymentId}/cancel Cancel a pending one-off payment · Cancel pending one-off payment #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Cancel one-off payment {paymentId}.
Cancel pending one-off payment {paymentId} so it is not processed.

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/akahu:akahu-payments-api"
All apis
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

akahu-payments-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Akahu Payments API
  version: 1.0.0
  description: 'Operations tagged Payments across 2 of this provider''s published API definitions: akahu-enduring-api-openapi.yml, akahu-one-off-payments-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.akahu.io/v1
- description: Akahu One-off Payments API
  url: https://api.payments.akahu.io
tags:


# --- truncated at 32 KB (47 KB total) ---
# Full source: https://artifacts.apis.io/akahu/openapi/akahu-payments-api-openapi.yml