The Transactions endpoint allows clients to receive user authorized transactions. Transactions data is standardised across financial institutions and accounts.
Request Parameter
Key Parameter | Data Type | Description |
|---|---|---|
user_access_token | String | token generated after successful institution connection through the widget which needs to be passed as the Bearer token in the Authorization header |
from | Date | Returns transactions posted on or after this date. Default value is date as of the API request minus 3 months |
to | Date | Returns transactions up to and including this date. Default value is date as of the API request |
Response parameters
Key Parameter | Data type | Description |
|---|---|---|
lastUpdateAt | String | The time stamp of when the data is last updated |
session | String | The session status of the particular accounts to the institution |
id | Int | Identification number of the transaction |
account_id | String | End-user account number that is used to do the transaction |
merchant_id | Integer | Merchant identification number of the transaction |
location_country_id | Integer | Country identification number of the merchant |
location_city_id | Integer | City identification number of the merchant |
outlet_outlet_id | Integer | Outlet identification number of the merchant |
amount | Float | Amount of the transaction |
date | String | Date of the transaction |
description | String | Description detail of the transaction |
status | String | Status of the transaction (Confirm or Pending) |
direction | String | Direction of the transaction (in or out) |
category | List | Category key |
category_id | Integer | Category identification number of the transaction |
category_name | String | Category Name |
classification_group_id | Integer | Category-group Identification |
classification_group | String | Name of the Category-group mapped with its id |
classification_subgroup_id | Integer | Category-subgroup Identification |
classification_subgroup | String | Name of the Category-subgroup mapped with its id |
institution_id | int | id of the institution's transaction |
reference_id | String | unique Id that identify a transaction |