Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Transactions

Get a transaction by ID

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}

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

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