Retrieve Bank Transactions
GET {{base_url}}/banking/v2/transactions
All bank transactions are returned across all connected user accounts. If dates are specified, then only transactions for specific dates are returned.
Bank transactions can be queried by bankId and accountId.
Query Parameters
| Field | Type | Description |
|---|
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| pageId | string | Page offset of results |
| from | dateTime | Returns transactions posted on or after from date |
| to | dateTime | Returns transactions posted on or before to date |
| status | string | Status of the transaction { PENDING, CLOSINGBOOKED } |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the transaction |
| accountId | string | Unique identifier for the account |
| bankId | integer | Unique identifier for the bank |
| bookingDate | datetime | Booking date for the transaction |
| valueDate | datetime | Value date for the transaction |
| transactionCode | string | Specifies the transaction family within a domain |
| transactionSubCode | string | Sub code of the transaction |
| proprietaryCode | string | Proprietary bank transaction code to identify the underlying transaction |
| proprietarySubCode | string | Proprietary sub code of the transaction |
| reference | string | Transaction reference |
| description | string | Description provided in the transaction |
| currency | string | Transaction currency |
| amount | integer | Transaction amount |
| type | string | Transaction type {DEBIT,CREDIT} |
| status | string | Transaction status {BOOKED,PENDING} |
| merchant | JSON Object | Details of the merchant |
| merchant->id | string | Unique identifier for the merchant |
| merchant->name | string | Name of the merchant |
| merchant->category | string | Business category that the merchant belongs to |
| merchant->categoryCode | integer | Category Code |
| merchant->addressLine | string | Address of the merchant (if available) |
| merchant->source | string | Source for how the merchant was identified {MODEL, USER, PROVIDER} |
| category | JSON Object | Details of the transaction category |
| category->id | integer | Unique identifier for the category |
| category->name | string | Name of the category |
| category->source | string | Source for how the category was identified {MERCHANT, MODEL, USER, PROVIDER} |
| externalId | string | An Id linked to an external source |
| source | string | Source of data import {MANUALIMPORT, OPENBANKING} |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid accountId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | { Message : "Missing/Invalid pageId” } |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
| | | |
from | null | | Returns transactions posted on or after "from" date |
to | null | | Returns transactions posted on or before "to" date |
bankId | null | | Unique identifier for the bank |
accountId | null | | Unique identifier for the bank account |
status | null | | Status of the transaction (PENDING, CLOSINGBOOKED) |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
Authorization | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"id":"transactionId1357","bankId":6,"accountId":"accountId5555","bookingDate":"2020-10-16T00:00Z","valueDate":"2020-10-16T00:00Z","reference":"","transactionCode":"","transactionSubCode":"","proprietaryCode":"","proprietarySubCode":"","description":"Dividends October","amount":"2000.00","currency":"GBP","type":"CREDIT","status":"BOOKED","merchant":{"id":"merchantId579","name":"Dividends","categoryCode":"","addressLine":"","source":"BANK"},"category":{"id":"categoryID9876","name":"Dividends","source":"USER"},"externalId":"","source":"MANUALIMPORT"},{"id":"transactionId1357","bankId":7,"accountId":"accountId1234","bookingDate":"2020-10-16T00:00Z","valueDate":"2020-10-16T00:00Z","reference":"","transactionCode":"","transactionSubCode":"","proprietaryCode":"","proprietarySubCode":"","description":"HMRC","amount":"6200.00","currency":"GBP","type":"CREDIT","status":"BOOKED","merchant":{"id":"merchantId579","name":"HMRC","categoryCode":"","addressLine":"","source":"MODEL"},"category":{"id":"categoryID9876","name":"Tax","source":"MODEL"},"externalId":"","source":"OPENBANKING"}],"links":{}}