Accounts

The account object represents an account held with a financial institution (e.g. a savings account). You can use this object to retrieve specific account details such as the account number, balance and available funds.

Attributes
`type`	Value is "account".
`id`	Uniquely identifies the account.
`accountNo`	Full account number.
`name`	Account name as defined by institution or user.
`currency`	The currency the funds are stored in, using ISO 4217 standard.
`balance`	Amount of funds in the account right now - excluding any pending transactions. For a credit card this would be zero or the minus amount spent. For an account providing no balance then the value provided by the bank would be passed on which could be null e.g. an insurance account.
`availableFunds`	Funds that are available to an account holder for withdrawal or other use. This may include funds from an overdraft facility or line of credit. As well as funds classified as the available balance, such as from cleared and existing deposits.
`lastUpdated`	Timestamp of last update, UTC, RFC 3339 format e.g. "2017-09-28T13:39:33Z"
`class`	Identifies the account type and product as defined by institution. Possible values for account type are: `transaction` - a keycard or chequing account. `savings` - savings account. `credit-card` - a credit card account. `mortgage` - a home loan. `loan` - a loan (e.g. personal or business loan). `investment` - a investment account. `term-deposit` - a term deposit account. `insurance` - an insurance account. `foreign` - a foreign cash account e.g. travel card - note, there is no support to retrieve transactions for travel cards. `unknown`
`transactionIntervals`	An array of date intervals indicating the coverage of the transaction data relating to the account. Will return a single element for accounts sourced from a single bank connection. Will return multiple elements in cases where there have been multiple PDF/CSV uploads for an account.
`product`	A property of class object. Product name as defined by institution.
`meta`	A property of `class` object. Meta data related to account type. For account type `mortgage` meta data include: `accountNumber` - full account number. `interestType` - loan interest rate type `fixed rate` or `variable` `repaymentType` - loan repayment type `interest only` or `interest and principal` `repaymentFrequency` - loan repayment frequency `weekly`, `fortnightly` or `monthly` `nextInstalmentDate` - next loan instalment date `instalmentAmount` - next loan instalment amount `interestRate` - current loan percentage interest rate - 4.8% p.a expressed as "4.08" `endDate` - loan maturity date `fee` - loan service fees "500.00" or text such as "waived" `availableRedraw` - loan paid off that is available for redraw (variable loans only) `offsetAccountNumber` - account linked to loan account, balance is offset against loan.
`status`	Indicates the account status. Always set to 'available'. Field kept for backward compatibility. Possible values include: `available` newest account data is available.
`institution`	The id of the institution resource the account originated from.
`accountHolder`	The name of the account holder as returned by the institution. No formatting is applied. Returns a string or null when not available.
`connection`	The latest id of the connection resource that was used to retrieve the account.
`links`	A links object containing the following members: `self` link to the requested account `transactions` link to the transactions associated with this connection `connection` link is always null, use the `connection` attribute for the most recent connection Changelog `institution` link to institution

{
  "type": "account",
  "id": "s55bf3",
  "accountNo": "34567834567890",
  "name": "Savings 123890",
  "currency": "AUD",
  "balance": "26978.76",
  "availableFunds": "26978.76",
  "lastUpdated": "2019-09-28T13:39:33Z",
  "class": {
    "type": "savings",
    "product": "Hooli Saver"
  },
  "transactionIntervals": [
    {
      "from": "2019-04-30",
      "to": "2021-01-08"
    }
  ],
  "status": "available",
  "institution": "AU00000",
  "accountHolder": "Max Wentworth-Smith",
  "connection": "8fce3b",
  "links": {
    "self": "https://au-api.basiq.io/users/ea3a81/accounts/s55bf3",
    "transactions": "https://au-api.basiq.io/users/ea3a81/transactions?filter=account.id.eq('s55bf3')",
    "connection": null,
    "institution": "https://au-api.basiq.io/institutions/AU00000"
  }
}

{
  "meta": {
    "accountNumber": "60000015744111",
    "availableRedraw": "525.28",
    "endDate": "2025-05-12T00:00:00Z",
    "fee": "waived",
    "instalmentAmount": "1768.23",
    "interestRate": "4.8",
    "interestType": "fixed rate",
    "nextInstalmentDate": "2018-02-228T00:00:00Z",
    "offsetAccountNumber": "60000045564000",
    "repaymentFrequency": "weekly",
    "repaymentType": "interest only"
  }
}