Skip to main content

Account

iduuid

internal ID of account

dataholderuuidrequired

internal ID of the data holder associated with this account

useruuid

ID of the user associated with this account

appstring

The app associated with this account

connectionuuid

internal ID of the connection associated with this account

currencyCurrencyrequired

ISO 4217 currency code

Example: USD, EUR, AUD, NZD
externalIdstring

external ID used by the account providers

statusAccountStatus

Possible values: [OPEN, CLOSED, ALL]

typeAccountTyperequired

Possible values: [PERSONAL, BUSINESS, UNSPECIFIED]

subtypeAccountSubtype

Possible values: [CHARGECARD, CREDITCARD, CURRENTACCOUNT, EMONEY, INVESTMENT, LOAN, OTHER, PENSION, MORTGAGE, PREPAIDCARD, SAVINGS, UNSPECIFIED]

namestring
nicknamestring
accountNumber object[]
  • Array [
    • schemeNumberSchemerequired

    Possible values: [SORTCODE, IBAN, PAN, BIC, BBAN_SE, BBAN_DK, BBAN_NO, BECS, BSB_NO, MASKED, UNKNOWN, ABN, EMAIL, TELEPHONE, BPAY, ORG_ID]

    numberstringrequired
  • ]
    • productNamestring
    creationDatedate-time
    Example: 2022-03-10T12:15:50-04:00
    lendingRatenumber

    The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call

    lendingRates object[]
  • Array [
    • iduuid

    internal ID of the lending rate

    lendingRateTypeLendingRateTyperequired

    The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning

    Possible values: [BALANCE_TRANSFER, BUNDLE_DISCOUNT_FIXED, BUNDLE_DISCOUNT_VARIABLE, CASH_ADVANCE, DISCOUNT, FIXED, FLOATING, INTRODUCTORY, MARKET_LINKED, PENALTY, PURCHASE, VARIABLE]

    ratestringrequired

    The rate to be applied

    tiers object[]

    Rate tiers applicable for this rate

  • Array [
    • iduuid

    internal ID of the tier

    namestringrequired

    A display name for the tier

    unitOfMeasureTierUnitOfMeasureTyperequired

    The unit of measure that applies to the minimumValue and maximumValue values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers)

    Possible values: [DAY, DOLLAR, MONTH, PERCENT]

    minimumValuenumberrequired

    The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value

    maximumValuenumber

    The number of unitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as minimumValue. Where this is the same as the minimumValue value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.

  • ]
    • additionalValuestring
  • ]
    • loan object
    originalStartDatedate-time

    Optional original start date for the loan

    Example: 2022-03-10T12:15:50-04:00
    originalLoanAmountnumber

    Optional original loan value

    loanEndDatedate-time

    Date that the loan is due to be repaid in full

    Example: 2022-03-10T12:15:50-04:00
    repaymentTypeLoanRepaymentType

    Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST

    Possible values: [INTEREST_ONLY, PRINCIPAL_AND_INTEREST]

    Default value: PRINCIPAL_AND_INTEREST
    repaymentFrequencystring

    The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)

    Account
    {
      "app": "app",
      "loan": {
        "originalLoanAmount": 6.027456183070403,
        "originalStartDate": "2000-01-23T04:56:07.000+00:00",
        "repaymentType": "PRINCIPAL_AND_INTEREST",
        "repaymentFrequency": "repaymentFrequency",
        "loanEndDate": "2000-01-23T04:56:07.000+00:00"
      },
      "externalId": "externalId",
      "type": "PERSONAL",
      "accountNumber": [
        {
          "number": "number",
          "scheme": "SORTCODE"
        },
        {
          "number": "number",
          "scheme": "SORTCODE"
        }
      ],
      "creationDate": "2000-01-23T04:56:07.000+00:00",
      "productName": "productName",
      "lendingRate": 0.8008281904610115,
      "lendingRates": [
        {
          "rate": 0.8008,
          "lendingRateType": "VARIABLE",
          "additionalValue": "Debit excess interest rate",
          "tiers": [
            {
              "name": "DEBIT",
              "unitOfMeasure": "DOLLAR",
              "minimumValue": 0,
              "maximumValue": 150000
            }
          ]
        }
      ],
      "subtype": "CHARGECARD",
      "name": "name",
      "nickname": "nickname",
      "connection": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "currency": "USD, EUR, AUD, NZD",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "user": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dataholder": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "status": "OPEN"
    }