1. Home
  2. Docs
  3. Data Subscriber API Documentation
  4. Endpoints – Banking
  5. GET /accounts/:id/report

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.

Headers

Name Value
Authorization Bearer {token}

Response

Name Value
available_balance float
credit_available float
credit_max float. The credit limit for the Account.
currency string (3 characters)
interest_rate float
last_payment float. The amount received in the last payment.
last_payment_at long integer. Epoch timestamp of the last payment.
loan_description string
loan_holder string. Name of the mortgage/loan holder.
loan_initial float. Original mortgage/loan amount.
loan_interest_period string. Period of interest (only for loan/mortgage Accounts).
loan_late_fee float. Late fee charged on mortgage/loan Accounts.
loan_length integer. Length of the loan in number of months.
loan_next_payment float. The minimum payment due (loan/mortgage Accounts only).
loan_next_payment_at string (timestamp in format YYYYMMDDhhmmss).
loan_payoff float. Amount to payoff the loan/mortgage.
loan_payoff_at string. Date of final loan/mortgage payment, in format YYYYMMDDhhmmss
name string. Account nickname.
opened_at string (timestamp in format YYYYMMDDhhmmss).
period_amount float. The total amount deposited in the period.
period_end_at string (YYYYMMDDhhmmss)
period_interest float. Interest accrued in period.
period_interest_rate float. Interest rate of period (APY).
period_start_at string (YYYYMMDDhhmmss)
posted_balance float. Cleared balance.
posted_balance_at string (YYYYMMDDhhmmss). Last update timestamp of the cleared balance.
short_no string. Account number in truncated form as given by the data source. Can also be an email address for certain institutions.
status integer. Unix-like meaning: zero means the Account is correctly connected. Values different from zero means the Account is not, and should be disconnected.
updated_at string (YYYYMMDDhhmmss). Last update timestamp of this report.
year_interest float. The interest accrued year-to-date.

Status Code

Code Comment
200 Request OK.
401 User not authorized.

How can we help?