Retrieve Bank Transaction (by id)
GET {{base_url}}/banking/v2/transactions/:transactionId
This endpoint can be used to retrieve a particular bank transaction using a transaction id.
All bank transactions are returned for all the accounts that the user has connected. If dates are specified, then only transactions for specific dates are downloaded.
Bank transactions can be queried by bankId and accountId.
Path variables
| Field | Type | Description |
|---|---|---|
| transactionId | string | Unique identifier for the transaction |
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 transactionId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string | ||
X-Api-Key | string | ||
X-Partner-Id | string | ||
X-Company-Id | string |