1. Home
  2. Docs
  3. Data Subscriber API Documentation
  4. Endpoints Reference
  5. GET /accounts/:id/balance

GET /accounts/:id/balance

Retrieve this Account’s balance.

Note. This endpoint counts as a billable query. Pricing may be different if you set the input option “live”.

Headers

Name Value
Authorization Bearer {token}

URL parameters

Name Value
live int. Use 1 to fetch real-time balance. Use 0 to fetch the last available data point (not older than 24h). Default is 0.

Response

Name Value
available_at string. Timestamp [YYYYMMDDhhmmss] that indicates when the available balance was fetched.
available float. Available balance.
posted_at string. Timestamp [YYYYMMDDhhmmss] that indicates when the posted balance was fetched.
posted float. Posted balance.

Status Code

Code Comment
200 Request OK.
404 Cannot retrieve balance’s detail from the financial institution.
401 User not authorized.

How can we help?