API Documentation

GET /accounts/:id/report

Returns a collection of additional information from a bank Account, as provided by the data source. Every data field in the response is optional, except the "status" field.

Headers

NAME VALUE
Authorization Bearer {token}

Response

NAME VALUE
available_balance float
credit_available float
credit_max float. The credit limit for the Account.
institution_id string
name string. The displayed name for the Account.
short_no string. The displayed numbers for the Account.
posted_balance float
posted_balance_at string (YYYYMMDD[hhmmss])
status int. If the Account is correctly connected, then this element will be zero.

Status Code

CODE COMMENT
200 Request OK.
401 User not authorized.