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.
{
"type": "list",
"data": [
{
"type": "account",
"id": "s55bf3",
"depositRate": "string",
"lendingRate": "string",
"bsb": "string",
"unmaskedAccNum": "string",
"creationDate": "string",
"accountHolder": "GAVIN BELSON",
"maskedNumber": "string",
"accountOwnership": "ONE_PARTY",
"isOwned": "true",
"amortisedLimit": "string",
"bundleName": "string",
"accountNo": "600000157441965",
"availableFunds": "420.28",
"balance": "356.50",
"creditLimit": "400000.00",
"class": {
"type": "mortgage",
"product": "Hooli Home Loan"
},
"connection": "8fce3b",
"currency": "AUD",
"institution": "AU00000",
"lastUpdated": "2019-09-28T13:39:33Z",
"name": "Master Savings",
"status": "available",
"meta": {
"fees": [
{
"name": "Dishonour fee",
"feeType": "EVENT",
"amount": "10.00",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "P1M",
"currency": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": {
"description": "string",
"discountType": "string",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": {
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
}
}
],
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "0.0385",
"calculationFrequency": "string",
"applicationFrequency": "P1M",
"tiers": {
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "PURCHASE",
"rate": "0.2024",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": {
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "PAID_OUT_AT_MATURITY"
}
],
"loan": {
"startDate": "2019-10-01",
"endDate": "2045-10-01",
"repaymentType": "PRINCIPAL_AND_INTEREST",
"loanAmount": "string",
"loanCurrency": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentFrequency": "string"
},
"creditCard": {
"minPaymentAmount": "117.00",
"paymentDueAmount": "5847.00",
"paymentCurrency": "AUD",
"paymentDueDate": "2023-12-12"
},
"addresses": [
{
"addressType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "string",
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
}
]
},
"transactionIntervals": [
{
"from": "2018-07-01",
"to": "2018-12-30"
}
]
}
],
"links": {
"self": "https://au-api.basiq.io/users/cd6fbd92/accounts/319ae910",
"transactions": "https://au-api.basiq.io/users/ea3a81/transactions?filter=account.id.eq('s55bf3')",
"connection": "https://au-api.basiq.io/users/cd6fbd92/connections/321312asa",
"institution": "https://au-api.basiq.io/institutions/AU00000",
"statements": []
}
}
Attributes | Description |
---|---|
id | Uniquely identifies the account. |
accountHolder | The name of the account holder as returned by the institution. No formatting is applied. Returns a string or null when not available. |
accountOwnership | Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers. The enum options for accountOwnership are: UNKNOWN |
accountNo | Full account number. This represents the unified form of the BSB and Account Number where applicable. |
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. |
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. |
creditLimit | Eligible account types are credit-card, loan, and mortgage. |
class.type | Account type.
|
class.product | Product name. |
connection | The ID of the connection resource that was used to retrieve the account. |
currency | The currency the funds are stored in, using ISO 4217 standard. |
institution | The ID of the institution resource the account originated from. |
lastUpdated | Timestamp of the last update in UTC, RFC 3339 format (e.g., "2017-09-28T13:39:33Z"). |
name | Account name as defined by the institution or user. |
status | Account status. |
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. |
transactionIntervals.from | Date of the first transaction on this account. |
transactionIntervals.to | Date of the last transaction on this account. |
meta.fees | Array of fees associated with the account. |
fees.name | Name of the fee. |
fees.feeType | The type of fee. Possible values:
|
fees.amount | The amount charged for the fee. |
fees.accrualFrequency | The indicative frequency with which the fee is calculated on the account. |
meta.depositRates | Array of deposit rates associated with the account. |
depositRates.depositRateType | The type of rate (base, bonus, etc.) for deposit rates. Possible values:
|
depositRates.rate | The rate to be applied for the deposit rate type. |
depositRates.applicationFrequency | The period after which the calculated amount(s) are 'applied' (i.e., debited or credited) to the account for deposit rates. |
meta.lendingRates | Array of lending rates associated with the account. |
lendingRates.lendingRateType | The type of rate (fixed, variable, etc.) for lending rates. Possible values:
|
lendingRates.rate | The rate to be applied for the lending rate type. |
lendingRates.applicationFrequency | The period after which the calculated amount(s) are applied (i.e., debited or credited) to the account for lending rates.Formatted according to ISO 8601 Durations (excludes recurrence syntax) |
meta.loan | loan metadata associated with the account. |
loan.startDate | Start date for the loan. |
loan.endDate | Date that the loan is due to be repaid in full. |
loan.repaymentType | Options in place for repayments. If absent, defaults to
|
loan.minInstalmentAmount | Minimum amount of the next installment. |
meta.creditCard | Array of credit card metadata associated with the account. |
creditCard.minPaymentAmount | The minimum payment amount due for the next card payment. |
creditCard.paymentDueAmount | The amount due for the next card payment. |
creditCard.paymentCurrency | If absent, assumes |
creditCard.paymentDueDate | Date that the next payment for the card is due. |
links.self | URL of the requested account. |