v1
latestOpenAPI 3.1.02026-07-2483219318.4 KBTransactions
Get transactions by account
Get a list of the user's transactions for a specific connected account within the start and end time range.
This endpoint returns settled transactions. See GET /accounts/{id}/transactions/pending to also query pending transactions for the account.
️ ℹ️ Time range defaults to the entire range accessible to your app.
Some important things to know when querying transactions:
- Transactions will look different depending on your app's permissions.
- All transactions timestamps are in UTC.
- The start query parameter is exclusive.
- The end query parameter is inclusive.
- All Akahu timestamps use millisecond resolution (i.e. 2025-01-01T11:59:59.999Z is the instant before 2025-01-01T12:00:00.000Z).
For more details see:
- 📚 Accessing transactional data guide
- 📚 Pagination guide
- 📖 Transaction model
- 📖 Transaction webhooks
get/accounts/{id}/transactions
Query parameters
startstring date-time
ISO 8601 formatted date
endstring date-time
ISO 8601 formatted date
cursorstring
Cursor from an earlier query
Headers
X-Akahu-Idstring required
Your App ID Token.
Response
Successful response.
Example response
{
"items": [
{
"_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"
}
}
}
]
}