Get Balance History

get

https://api.sau.sandbox.tarabutgateway.io/insights/v2/balance-history

Retrieves historical balance data for a specific user account over a defined period.
Note: you must have a valid consent to fetch your customer's historical balance

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

months

int32

1 to 12

Defaults to 12

You can specify the period for which you want to retrieve historical balance, which can be any number of months from 1 to 12. If you don't specify a period, it will automatically be set to 12 months by default

frequency

string

Defaults to daily

You can specify the frequency for which you want to retrieve historical balance to a daily or monthly. If you don't specify the frequency, it will automatically be set to daily by default

purposeStatement

string

To filter account responses based on the purpose statement, pass one of the following values PFM, ACCOUNT_AGGREGATION, CREDIT_ASSESSMENT, E_STATEMENT, ELECTRONIC_VERIFICATION, ENTERPRISE_FINANCIAL_MANAGEMENT, LETTER_OF_GUARANTEE, TAX_FILING, OTHER. By default, all accounts will be included regardless of the purpose statement

Responses

200Successful response

400Error response

401Error response