AKakahu
Transactions

Get a transaction by ID

Changed on

Get a single transaction from one of the user's connected accounts.

  • Transactions will look different depending on your app's permissions.
  • All times on the transaction are in UTC.

For more details see:

  • 📚 Accessing transactional data guide
  • 📖 Transaction model
  • 📖 Transaction webhooks
get/transactions/{id}

Request

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

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "item": {
    "_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