--- title: "Get Transactions" method: GET path: "/data/v2/accounts/{account_id}/transactions" tags: ["Transactions Raw Data"] --- # Get Transactions `GET /data/v2/accounts/{account_id}/transactions` The `Get Transactions `endpoint retrieves a list of historical transactions associated with a specific bank account linked by a user via LinkSDK, identified by both the entity_id and the account_id. Each transaction object contains fields such as amount, status, balance after each transaction, transaction category and type, and additional information. Requires an active entity with the `transactions` permission to use. **A step by step guide** [here](https://docs.leantech.me/docs/lean-open-finance-data-integration-guide). ## Path parameters - `account_id` string, uuid, required ## Query parameters - `async` boolean - `page` integer - `size` integer - `entity_id` string, uuid - `meta` string - `start_date` string, date - `end_date` string, date ## Response `200` OK - FetchTransactionsResultV2 - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required — The status of the request - `results_id` string, uuid, required — The unique identifier for the request - `message` string, required — A message describing the status of the request - `meta` object, nullable — Meta information about the request - `timestamp` string, date-time, required — The datetime of when the request was made - `status_detail` StatusDetail, nullable - `granular_status_code` string, nullable — Granular status code - `status_additional_info` string, nullable — Additional information about the status - `refreshed_at` string, date-time, nullable — The datetime of when the data was refreshed - `type` string, nullable — The endpoint the original request was made to. - `data` TransactionsData - `type` string, required — The endpoint the original request was made to. - `transactions` Transaction[] — An array of transactions associated with the account. - `entity_id` string, uuid — The unique identifier for the entity. Provided as a UUID. - `account_id` string, required — The account_id this transaction is related to. - `transaction_id` string, required — A unique ID for the transaction used to help you tie data back to your systems - `transaction_information` string — Include the raw unparsed transaction description from the bank - `transaction_reference` string — A unique reference provided by the bank for the transaction when processed through a national payment system. As an example, it may be a reference code for the local payment scheme - `credit_debit_indicator` 'CREDIT' | 'DEBIT' | 'UNSUPPORTED' — Indicates whether the balance is a credit or debit balance - `amount` CurrencyAmount, required - `currency` string, required — The ISO 3 letter currency code - `amount` number, required — The amount of money in the currency specified. - `transaction_mutability` 'IMMUTABLE' | 'MUTABLE' | 'UNSUPPORTED' — Specifies whether the transaction details may change after posting (e.g., pending transactions can update upon settlement). - `booking_date_time` string, date-time — Date and time when a transaction entry is posted to an account. - `insights` Categorisation — Category enriched information when insights parameter is set to true. - `description_cleansed` string — A cleaned and standardized version of the transaction description. - `category` string — High-level classification of the transaction including BANK_FEES_AND_CHARGES CHARITY EDUCATION ENTERTAINMENT GOVERNMENT GROCERIES HEALTH_AND_WELLBEING LOANS_AND_INVESTMENT RENT_AND_SERVICES RESTAURANTS_DINING RETAIL SALARY_AND_REVENUE TRANSFER TRANSPORT TRAVEL OTHER - `category_confidence` number — Confidence of category expressed as a percentage between 0 and 1. - `balance` TransactionBalance - `type` string — The type of balance for the transaction - `credit_debit_indicator` 'CREDIT' | 'DEBIT' | 'UNSUPPORTED' — Indicates whether the balance is a credit or debit balance - `amount` CurrencyAmount - `currency` string, required — The ISO 3 letter currency code - `amount` number, required — The amount of money in the currency specified. - `status` string, required — Status of the transaction (e.g., pending, booked). - `statement_reference` string[] — A list of references for the statement if available. - `value_date_time` string, date-time — Date and time at which assets become available to the account owner (value date). - `index` integer — Index position of the transaction in the sequence for the day. - `charge_amount` TransactionChargeAmount - `amount` number — Amount of money charged for the transaction. - `currency` string — Currency in which the charge amount is expressed. - `charge_included` boolean — Indicates whether the charge is included in the transaction amount or is a separate charge. - `bank_transaction_code` BankTransactionCode - `code` string — Bank transaction code used by the bank to categorize the transaction. - `sub_code` string — Sub-category of the bank transaction code providing further details. - `card_instrument` CardInstrument - `authorization_type` string — Type of card authorization performed for the transaction. - `card_scheme_name` string — Name of the card scheme. - `identification` string — Identification assigned by an institution to identify the card instrument. - `name` string — Name of the cardholder using the card. - `merchant_details` MerchantDetails - `merchant_category_code` string — Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. - `merchant_name` string — Name by which the merchant is known and which is usually used to identify that merchant. - `proprietary_bank_transaction_code` ProprietaryBankTransactionCode - `code` string — Proprietary bank transaction code to identify the underlying transaction. - `issuer` string — Identification of the issuer of the proprietary bank transaction code. - `currency_exchange` CurrencyExchange - `source_currency` string — Currency from which an amount is to be converted in a currency conversion. - `target_currency` string — Currency into which an amount is to be converted in a currency conversion. - `unit_currency` string — Currency in which the rate of exchange is expressed in a currency exchange. - `exchange_rate` number — Factor used to convert an amount from one currency into another. - `contract_identification` string — Unique identification to unambiguously identify the foreign exchange contract. - `quotation_date` string, date-time — Date and time at which an exchange rate is quoted. - `instructed_amount` CurrencyAmount - `currency` string, required — The ISO 3 letter currency code - `amount` number, required — The amount of money in the currency specified. - `creditor_account` TransactionAccountIdentifier - `name` string — Name of the account, as assigned by the account servicing institution. - `scheme_name` string — Name of the identification scheme, in a coded form as published in an external list. - `identification` string — Identification assigned by an institution to identify an account. - `creditor_agent` Agent - `scheme_name` string — Name of the identification scheme, in a coded form as published in an external list. - `identification` string — Unique and unambiguous identification of the agent. - `name` string — Name by which the agent is known and which is usually used to identify that agent. - `postal_address` PostalAddress - `address_type` string — Identifies the nature of the postal address. - `address_line` string — Information that locates and identifies a specific address. - `building_number` string — Number that identifies the position of a building on a street. - `country` string — Nation with its own government. - `country_subdivision` string — Identifies a subdivision of a country such as state, region, county. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address. - `street_name` string — Name of a street or thoroughfare. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `debtor_account` TransactionAccountIdentifier - `name` string — Name of the account, as assigned by the account servicing institution. - `scheme_name` string — Name of the identification scheme, in a coded form as published in an external list. - `identification` string — Identification assigned by an institution to identify an account. - `debtor_agent` Agent - `scheme_name` string — Name of the identification scheme, in a coded form as published in an external list. - `identification` string — Unique and unambiguous identification of the agent. - `name` string — Name by which the agent is known and which is usually used to identify that agent. - `postal_address` PostalAddress - `address_type` string — Identifies the nature of the postal address. - `address_line` string — Information that locates and identifies a specific address. - `building_number` string — Number that identifies the position of a building on a street. - `country` string — Nation with its own government. - `country_subdivision` string — Identifies a subdivision of a country such as state, region, county. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address. - `street_name` string — Name of a street or thoroughfare. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `local_time_zone` string — Local time zone - `transaction_type` 'POS' | 'E_COMMERCE' | 'ATM' | 'BILL_PAYMENTS' | 'LOCAL_BANK_TRANSFER' | 'SAME_BANK_TRANSFER' | 'INTERNATIONAL_TRANSFER' | 'TELLER' | 'CHEQUE' | 'OTHER' | 'UNSUPPORTED' — Transaction type - `sub_transaction_type` 'PURCHASE' | 'REVERSAL' | 'REFUND' | 'WITHDRAWAL' | 'WITHDRAWAL_REVERSAL' | 'DEPOSIT' | 'DEPOSIT_REVERSAL' | 'MONEY_TRANSFER' | 'NOT_APPLICABLE' | 'UNSUPPORTED' | 'REPAYMENTS' | 'INTEREST' | 'FEE' | 'CHARGES' | 'PROFIT' | 'DISBURSEMENT' | 'TAX' | 'ADJUSTMENT' | 'REWARDS' | 'LEASE_REPAYMENT' — Sub transaction type - `payment_modes` 'ONLINE' | 'OFFLINE' | 'BATCH' | 'UNSUPPORTED' — Mode of the payment - `flags` string[] — The list of flags for a transaction by the bank e.g., CASHBACK - `page` PageMetadata, required — Metadata about the current page of results - `number` integer, required — The current page being returned by the API - `size` integer, required — The page size requested - `total_elements` integer, required — The total number of elements in all pages - `total_pages` integer, required — The total number of pages retrievable - `sort` string[] — Sort parameters applied to the results ## Other responses - `202` — Accepted (Asynchronous request) - `400` — Bad Request - `404` — Account or entity not found - `500` — Internal Server Error --- [API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)