v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB

Transactions Raw Data

Get 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.

get/data/v2/accounts/{account_id}/transactions

Path parameters

account_idstring uuid required

The account_id used to fetch requested data

Query parameters

asyncboolean

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it's recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

pageinteger

The page you're requesting - returns page 0 of a response if not specified.

sizeinteger

The number of objects you want to return as a page size.

entity_idstring uuid

The entity_id you're querying for, which is created by LinkSDK .connect() function.

metastring

Additional data you would like to store against the request. Example: {"foo": "val"}

start_datestring date

The start date in UTC (in the format YYYY-MM-DD) you want to query transactions for.

end_datestring date

The end date in UTC (in the format YYYY-MM-DD) you want to query transactions for.

Response

The status of the request

results_idstring uuid required

The unique identifier for the request

messagestring required

A message describing the status of the request

metaobject nullable

Meta information about the request

timestampstring date-time required

The datetime of when the request was made

refreshed_atstring date-time nullable

The datetime of when the data was refreshed

typestring nullable

The endpoint the original request was made to.

Example response

{
  "data": {
    "transactions": [
      {
        "amount": {
          "currency": "AED"
        },
        "balance": {
          "amount": {
            "currency": "AED"
          }
        },
        "currency_exchange": {
          "instructed_amount": {
            "currency": "AED"
          }
        }
      }
    ]
  }
}