Skip to main content

Accounts

  • Array [
    • idstring<uuid>

    internal ID of account

    dataholderstring<uuid>required

    internal ID of the data holder associated with this account

    userstring<uuid>

    ID of the user associated with this account

    appstring

    The app associated with this account

    connectionstring<uuid>

    internal ID of the connection associated with this account

    currencyCurrency (string)required

    ISO 4217 currency code

    Example: USD, EUR, AUD, NZD
    externalIdstring

    external ID used by the account providers

    statusAccountStatus (string)

    Possible values: [OPEN, CLOSED, ALL]

    typeAccountType (string)required

    Possible values: [PERSONAL, BUSINESS, UNSPECIFIED]

    subtypeAccountSubtype (string)

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

    namestring
    nicknamestring
    accountNumber object[]
  • Array [
    • schemeNumberScheme (string)required

    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
    creationDatestring<date-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

    loan object
    originalStartDatestring<date-time>

    Optional original start date for the loan

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

    Optional original loan value

    loanEndDatestring<date-time>

    Date that the loan is due to be repaid in full

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

    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)

  • ]
    • Accounts
    [
      {
        "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,
        "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"
      }
    ]