Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Transactions

Get transactions

Get a list of the user's transactions within the start and end time range.

This endpoint returns settled* transactions for all accounts that the user has connected to your application. See GET /transactions/pending to also query pending transactions.

Some important things to know about this endpoint:

  • The data returned may vary depending on your app's permissions.
  • All transactions timestamps are in UTC.
  • If start and end are not provided, all available transactions will be returned.
  • The start query parameter is exclusive.
  • The end query parameter is inclusive.
  • All timestamps use millisecond resolution (i.e. 2025-01-01T11:59:59.999Z is the instant before 2025-01-01T12:00:00.000Z).

Further reading:

  • 📚 Accessing transactional data guide
  • 📚 Pagination guide
  • 📖 Transaction model
  • 📖 Transaction webhooks

*Both inbound and outbound transactions relating to payments initiated via Akahu skip the /transactions/pending endpoint and are immediately available at this endpoint instead. This ensures that such transactions receive a stable _id field to assist with reconciliation. Their availability at this endpoint does not guarantee that the bank has undertaken final processing of the transaction.

get/transactions

Query parameters

startstring date-time

ISO 8601 formatted date

endstring date-time

ISO 8601 formatted date

cursorstring

Cursor from an earlier query

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "items": [
    {
      "_id": "oneoff_trans_1111111111111111111111111",
      "_account": "oneoff_acc_1111111111111111111111111",
      "_connection": "conn_1111111111111111111111111",
      "date": "2020-01-01T01:00:00.000Z",
      "amount": -5.5,
      "balance": 100,
      "enrichment": {
        "category": {
          "_id": "nzfcc_1111111111111111111111111",
          "name": "Cafes & Restaurants",
          "components": [
            {
              "name": "Fast food restaurants",
              "type": "nzfcc:base"
            },
            {
              "name": "Cafes & Restaurants",
              "type": "nzfcc:group"
            },
            {
              "name": "Lifestyle",
              "type": "nzfcc:pfm"
            }
          ],
          "groups": {
            "personal_finance": {
              "_id": "group_1111111111111111111111111",
              "name": "Lifestyle"
            }
          }
        },
        "merchant": {
          "_id": "merchant_cm6pib1l5000i08lhfah11sht",
          "name": "Bob's Pizza",
          "logo": "https://cdn.akahu.nz/logos/merchants/merchant_cm6pib1l5000i08lhfah11sht",
          "website": "https://pizza.bob.nz"
        }
      }
    }
  ]
}