API Documentation
GET /accounts/:id/balance
Retrieve this Account’s balance.
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. |
