AKakahu
Transactions

Get transactions

Changed on

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

Request

  • Base URL
    https://api.akahu.io/v1
  • URL
    https://api.akahu.io/v1/transactions
  • Auth
    HTTP bearer

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": "trans_1111111111111111111111111",
      "_account": "acc_1111111111111111111111111",
      "_connection": "conn_1111111111111111111111111",
      "_user": "user_1111111111111111111111111",
      "_migrated": "trans_1111111111111111111111110",
      "_migrated_account": "acc_1111111111111111111111110",
      "created_at": "2020-01-01T01:00:00.000Z",
      "updated_at": "2020-01-01T01:00:00.000Z",
      "date": "2020-01-01T01:00:00.000Z",
      "description": "{ RAW TRANSACTION DESCRIPTION }",
      "amount": -5.5,
      "balance": 100,
      "type": "EFTPOS",
      "merchant": {
        "_id": "merchant_cm6pib1l5000i08lhfah11sht",
        "name": "Bob's Pizza",
        "website": "https://pizza.bob.nz"
      },
      "category": {
        "_id": "nzfcc_1111111111111111111111111",
        "name": "Cafes & Restaurants",
        "groups": {
          "personal_finance": {
            "_id": "group_1111111111111111111111111",
            "name": "Lifestyle"
          }
        }
      },
      "meta": {
        "particulars": "abc123",
        "code": "abc123",
        "reference": "abc123",
        "other_account": "00-0000-0000000-00",
        "conversion": {
          "amount": 100,
          "currency": "GBP",
          "rate": 1.25
        },
        "logo": "https://cdn.akahu.nz/logos/merchants/merchant_cm6pib1l5000i08lhfah11sht"
      }
    }
  ]
}

Changes

  • 52ef70f3df76Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      added the new CREDIT CARD enum value to the // response property for the response status

    • warning

      added the new EFTPOS enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the CARD enum value from the // response property for the response status

    • info

      removed the FX enum value from the // response property for the response status

    • info

      removed the KIWISAVER enum value from the // response property for the response status

    • info

      removed the UNKNOWN enum value from the // response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status