Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Transaction Enrichment

Enrich a batch of transactions

Enrich a batch of transactions using Genie.

post/search

Request body

idstring

A unique correlation ID for the query to help you to find the corresponding result in the response data.

descriptionstring

The transaction description. This should be the full description as provided by the bank / transaction source.

_connection'conn_cjgaawozb000001nyd111xixr' | 'conn_cjgaaqcna000001ldwof8tvj0' | 'conn_cjgaatd57000001pe1t1z0iy9' | 'conn_ck5rhsdbv0000ftx1bmdu9zas' | 'conn_cjgaac5at000001qi2yw8ftil' | 'conn_ckydkmy3r000009mde2sx2i4d' | 'conn_cjgab1c8e000001pmyxrkhova' | 'conn_cjgab6fis000001qsytf1semy' | 'conn_cjgaaozdo000001mrnqmkl1m0'

The Akahu connection identifier corresponding to the bank from which the transaction description was sourced. It is strongly recommended to include this parameter to ensure best results.

The following connection identifiers are available:

  • ANZ: conn_cjgaawozb000001nyd111xixr
  • ASB: conn_cjgaaqcna000001ldwof8tvj0
  • BNZ: conn_cjgaatd57000001pe1t1z0iy9
  • Heartland: conn_ck5rhsdbv0000ftx1bmdu9zas
  • Kiwibank: conn_cjgaac5at000001qi2yw8ftil
  • Rabobank: conn_ckydkmy3r000009mde2sx2i4d
  • The Cooperative Bank: conn_cjgab1c8e000001pmyxrkhova
  • TSB: conn_cjgab6fis000001qsytf1semy
  • Westpac: conn_cjgaaozdo000001mrnqmkl1m0
amountnumber

Transaction amount (+ for credit, - for debit).

direction'DEBIT' | 'CREDIT'

Whether the transaction is a debit or credit.

type'CARD' | 'DIRECT DEBIT' | 'PAYMENT' | 'STANDING ORDER'

The type of transaction this query relates to.

Response

Success

successtrue required

Example response

{
  "items": [
    {
      "results": [
        {
          "category": {
            "_id": "nzfcc_ckouvvy84001608ml5p6z4d8j",
            "name": "Supermarkets and grocery stores",
            "groups": {
              "personal_finance": {
                "_id": "group_clasr0ysw000xhk4mf7mg2j1z",
                "name": "Food"
              }
            }
          },
          "merchant": {
            "_id": "merchant_cjipiuvdk000lbpzytryqtjkv",
            "name": "FreshChoice",
            "logo": "https://cdn.akahu.nz/logos/merchants/merchant_cjipiuvdk000lbpzytryqtjkv",
            "website": "https://www.freshchoice.co.nz",
            "nzbn": "9429040683379",
            "tags": []
          },
          "outlet": {
            "_id": "outlet_cm0qk0idc000l08kydt9gf9gz",
            "name": "FreshChoice Greytown",
            "website": "https://greytown.store.freshchoice.co.nz/",
            "phone": "06 304 7237",
            "location": {
              "accuracy": "establishment",
              "formatted": "12 Hastwell Street, Greytown 5712, New Zealand",
              "address": {
                "street": "12 Hastwell Street",
                "city": "Greytown",
                "region": "Wellington",
                "country": "New Zealand",
                "postal_code": "5712"
              },
              "coordinates": {
                "lat": -41.0809289,
                "lon": 175.4589657
              }
            },
            "tags": []
          }
        }
      ]
    }
  ]
}