get https://sandbox.onebrick.io/v1/avg-balance
The Average Balance GET API will allow clients to receive user authorized average balance.
It can be generated with selected period of month&year
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 (MM-YYYY) | Starting period of the requested avg-balance |
to | Date (MM-YYYY) | Ending period of the requested avg-balance |
Response parameters
Key Parameter | Data type | Description |
---|---|---|
institution_id | Integer | Identification number of the transaction |
accountId | String | End-user account number that is used to do the transaction |
beginningBalance | Float | Starting balance for month |
avgBalance | Float | Average balance for month |
endingBalance | Float | Ending balance of month |
month | Float | Month for which data is given |
year | Float | Year for which data is given |