Akahu icon

Akahu

Interact with the Akahu API

Actions15

Payment → Make a Payment

AI-generated

Summary

Initiates a payment from a selected Akahu account to a New Zealand bank account. Sends the recipient, account number, and amount to Akahu, with optional statement metadata, then returns the payment record with selected fields renamed for readability.

Inputs

  • From Account Name or ID (required) — Akahu account to pay from; choose a listed account or provide its ID using an expression.
  • Recipient Name (required) — Name of the recipient.
  • Recipient Account Number (required) — New Zealand bank account number to pay.
  • Amount (required) — Amount to transfer, with a minimum of 0.01 and two decimal places.
  • Metadata — Optional source code and reference, and destination code, particulars, and reference for statement entries. Adding destination particulars disables arrival tracking for the payment.

Output shape

A single payment record.

The operation sends a POST request to Akahu's /payments endpoint and extracts the response's item property. Selected fields are renamed, such as _id to Payment Id and status to Status; _user and _connection are removed.

Links

Discussion