--- updatedAt: 2026-04-22T22:43:18.000Z agentTools: projectIndex: https://developers.akahu.nz/llms.txt --- # 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](/docs/accessing-transactional-data) - [📚 Pending transactions guide](/docs/accessing-transactional-data#pending-transactions) - [📖 Transaction model](/docs/the-transaction-model) # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Akahu Enduring API", "description": "This API is the primary way for apps to interact with a user's data.", "version": "1.0.0" }, "servers": [ { "url": "https://api.akahu.io/v1" } ], "components": { "parameters": { "xAkahuId": { "name": "X-Akahu-Id", "in": "header", "required": true, "description": "Your **App ID Token**.", "schema": { "type": "string" }, "example": "{{app_token}}" } }, "securitySchemes": { "user_token": { "type": "http", "scheme": "bearer", "description": "User-level Authentication:\n\nHttp Bearer Auth with the token being a consented **User Access Token**.\n> `Bearer {user_token}`\n\nThis will allow you to act on a **user's** behalf when accessing the API." } }, "responses": { "400": { "description": "Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid Content-Type" } } } } } }, "401": { "description": "You are not authorised to access this content.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Permission Denied" } } } } } }, "403": { "description": "You are not allowed to access this content.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Forbidden" } } } } } }, "404": { "description": "The item you are trying to access doesn't exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Not Found" } } } } } }, "500": { "description": "An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Something went wrong" } } } } } } }, "schemas": { "TransactionType": { "type": "string", "example": "EFTPOS", "enum": [ "CREDIT", "DEBIT", "PAYMENT", "TRANSFER", "STANDING ORDER", "EFTPOS", "INTEREST", "FEE", "TAX", "CREDIT CARD", "DIRECT CREDIT", "DIRECT DEBIT", "ATM", "LOAN" ], "description": "Type of the transaction:\n\n - `CREDIT` → Money has entered the account.\n\n - `DEBIT` → Money has left the account.\n\n - `PAYMENT` → Payment to an external account.\n\n - `TRANSFER` → Transfer between accounts that are associated with the same credentials.\n\n - `STANDING ORDER` → Automatic payment.\n\n - `EFTPOS` → Payment made via an EFTPOS system.\n\n - `INTEREST` → An interest payment.\n\n - `FEE` → Fee payment to the account provider.\n\n - `TAX` → Tax payment.\n\n - `CREDIT CARD` → Credit card payment.\n\n - `DIRECT DEBIT` → Direct debit payment.\n\n - `DIRECT CREDIT` → Direct credit (someone paying into the account).\n\n - `ATM` → ATM deposit or withdrawal.\n\n - `LOAN` → Loan payment." }, "PendingTransaction": { "type": "object", "properties": { "_account": { "type": "string", "description": "The Akahu Account ID that this transaction belongs to", "example": "acc_1111111111111111111111111" }, "_connection": { "type": "string", "description": "The Akahu Connection ID that this transaction belongs to", "example": "conn_1111111111111111111111111" }, "_user": { "type": "string", "description": "The Akahu User ID that this transaction belongs to", "example": "user_1111111111111111111111111" }, "updated_at": { "type": "string", "format": "date-time", "description": "The ISO 8601 timestamp of when this transaction was last updated by Akahu", "example": "2020-01-01T01:00:00.000Z" }, "date": { "type": "string", "format": "date-time", "description": "The ISO 8601 timestamp for the transaction from the bank.", "example": "2020-01-01T01:00:00.000Z" }, "description": { "type": "string", "description": "The raw transaction description, essentially what you see on a bank statement", "example": "{ RAW TRANSACTION DESCRIPTION }" }, "amount": { "type": "number", "description": "How much money this transaction was for", "example": -5.5 }, "type": { "$ref": "#/components/schemas/TransactionType" }, "meta": { "type": "object", "description": "Additional metadata we manage to retrieve for the transaction. Only present when you have permission to view enriched transactions. All fields are optional and provided on a \"best-effort\" basis.", "properties": { "particulars": { "type": "string", "description": "The particulars field set on this transaction.", "example": "abc123" }, "code": { "type": "string", "description": "The code field set on this transaction.", "example": "abc123" }, "reference": { "type": "string", "description": "The reference field set on this transaction.", "example": "abc123" }, "other_account": { "type": "string", "description": "The formatted NZ bank account number of the other party to this transaction.", "example": "00-0000-0000000-00" }, "conversion": { "type": "object", "description": "If this transaction was made in another currency, details about the currency conversion.", "properties": { "amount": { "type": "number", "description": "The amount transacted in the foreign currency", "example": 100 }, "currency": { "type": "string", "description": "The (3 letter ISO 4217 currency code)[https://www.xe.com/iso4217.php] that was used for this transaction.", "example": "GBP" }, "rate": { "type": "number", "description": "The foreign currency conversion rate applied to this transaction.", "example": 1.25 } } }, "card_suffix": { "type": "string", "description": "If this transaction was made with a credit or debit card, the last four digits of the card number.", "example": 1234 } } } } } } }, "tags": [ { "name": "Transactions" } ], "paths": { "/accounts/{id}/transactions/pending": { "parameters": [ { "name": "id", "in": "path", "required": true, "description": "An Akahu Account ID", "example": "acc_1111111111111111111111111", "schema": { "type": "string" } } ], "get": { "tags": [ "Transactions" ], "summary": "Get pending transactions by account", "security": [ { "user_token": [] } ], "description": "Get a list of the user's pending transactions for a specific connected account.\n\nPending transactions are not stable (eg. the date or description may change) due to the unreliable nature of the underlying NZ bank data.\n\n>ī¸ ℹī¸ You can tell when we last fetched a transaction by looking at it's `updated_at` key.\n\n- All transactions timestamps are in **UTC**.\n\nFor more details see:\n- [📚 Accessing transactional data guide](/docs/accessing-transactional-data)\n- [📚 Pending transactions guide](/docs/accessing-transactional-data#pending-transactions)\n- [📖 Transaction model](/docs/the-transaction-model)", "parameters": [ { "$ref": "#/components/parameters/xAkahuId" } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PendingTransaction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } } } } ```