AKakahu
Transactions

Get pending transactions

Changed on

Get a list of pending transactions from a user's connected accounts.

This endpoint returns pending transactions from all of a user's accounts that the user has connected to your application.

Pending transactions are not stable (eg. the date or description may change) due to the unreliable nature of the underlying NZ bank data.

️ ℹ️ You can tell when we last fetched a transaction by looking at it's updated_at key.

  • All transactions timestamps are in UTC.

For more details see:

  • 📚 Accessing transactional data guide
  • 📚 Pending transactions guide
  • 📖 Transaction model
get/transactions/pending

Request

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

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "success": true,
  "items": [
    {
      "_account": "acc_1111111111111111111111111",
      "_connection": "conn_1111111111111111111111111",
      "_user": "user_1111111111111111111111111",
      "updated_at": "2020-01-01T01:00:00.000Z",
      "date": "2020-01-01T01:00:00.000Z",
      "description": "{ RAW TRANSACTION DESCRIPTION }",
      "amount": -5.5,
      "type": "EFTPOS",
      "meta": {
        "particulars": "abc123",
        "code": "abc123",
        "reference": "abc123",
        "other_account": "00-0000-0000000-00",
        "conversion": {
          "amount": 100,
          "currency": "GBP",
          "rate": 1.25
        }
      }
    }
  ]
}

Changes

  • 52ef70f3df76Revision changes
    • 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

      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