API Reference

Make a Payment

post
https://api.akahu.io/v1/payments

Initiate a payment from the user's connected bank account to another New Zealand bank account.

The payee bank account is not required to be connected to Akahu.

For more details about payments see:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The Akahu Account ID you want to pay from

to
object
required

Account details specifying who you'd like to pay to

number
required

The payment amount

meta
object

Metadata relating to the payment including references for both source (from) and destination (to).

For more details check out the 📚 Payment PCR Fields guide.

Headers
string
required

Your App ID Token.

string
Responses

Updated 13 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago