Akahu icon

Akahu

Interact with the Akahu API

Payment → Get Many

AI-generated

Summary

Lists Akahu payments using a GET request, optionally filtered by a date range. Returns payment records with selected fields renamed for readability and internal user and connection fields removed.

Inputs

  • Start — Optional ISO 8601 datetime for the exclusive start of the query range; sent as the start query parameter when provided.
  • End — Optional ISO 8601 datetime for the inclusive end of the query range; sent as the end query parameter when provided.
  • Return All — When enabled, follows Akahu's pagination cursor to collect all available results. Defaults to false.
  • Limit — Maximum number of payments to return when Return All is disabled. Defaults to 50.
  • Request Options — Optional HTTP settings for batching, accepting invalid SSL certificates, proxy, and timeout.

Output shape

A list of payment items, one per payment from the response's items array.

Pagination follows the response's next cursor and, when Return All is disabled, truncates the collected items to the configured limit. Fields such as _id, from, to, amount, status, and timestamps are renamed to display labels; _user and _connection are removed.

Links

Discussion