Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Transactions

Get pending transactions by account

Get a list of the user's pending transactions for a specific connected account.

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/accounts/{id}/transactions/pending

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "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,
      "meta": {
        "particulars": "abc123",
        "code": "abc123",
        "reference": "abc123",
        "other_account": "00-0000-0000000-00",
        "conversion": {
          "amount": 100,
          "currency": "GBP",
          "rate": 1.25
        }
      }
    }
  ]
}