Accounts - Examples

Data returned per account type

Some fields such as IBAN, account number, sort code, PAN and account holder require the account_details:read scope.
Please refer to our API reference for more information

Cash

{
      "id": "344f69f8-0172-4d68-ac38-ea11be1f7373",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "Starling Current Account",
      "accountReference": "7729",
      "type": "cash:current",
      "providerName": "Starling",
      "providerId": "DEMO",
      "providerReference": "demo",
      "accountHolderName": "Robert Cantu",
      "connectionId": "DEMO:999",
      "balance": {
        "date": "2020-07-12",
        "amount": {
          "value": 124885,
          "currency": "GBP"
        }
      },
      "currency": "GBP",
      "details": {
        "AER": 0,
        "overdraftLimit": 0,
        "sortCodeAccountNumber": "56002926207729",
        "iban": "GB2960161331926819"
      },
      "transactionData": {
        "count": 108,
        "earliestDate": "2019-07-28",
        "lastDate": "2020-07-12"
      }
    }

Field

Description

id

Unique identifier of the account

accountName

Name of the account

type

Type of the account

providerName

Display name for the Provider

providerID

Unique identifier for the Provider

accountReference

A reference number for the account - typically the last 4 digits of the account number or iban number

accountHolderName

Account Holder name - optional per provider. It requires the accounts_details:read scope.

balance date

The balance as of the last refresh

amount

Value and Currency

AER

Annual Equivalent Rate - optional per provider

overdraftLimit

Overdraft Limit

TransactionData

Transactional information

sortCodeAccountNumber

Sort Code and Account number It requires the accounts_details:read scope.

iban

IBAN. It requires the accounts_details:read scope.

Card (Credit Card)

{
      "id": "7abc948a-416d-44ab-8a23-69d3ea13bcf1",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "Credit Card",
      "type": "card",
      "providerName": "Virgin",
      "providerId": "DEMO",
      "providerReference": "demo",
      "accountHolderName": "Robert Cantu",
      "connectionId": "DEMO:888",
      "balance": {
        "date": "2020-07-27",
        "amount": {
          "value": -196700,
          "currency": "GBP"
        }
      },
      "currency": "GBP",
      "details": {
        "creditLimit": 250000,
        "APR": 0,
        "pan": "4012888888881881"
      },
      "transactionData": {
        "count": 163,
        "earliestDate": "2019-07-28",
        "lastDate": "2020-07-27"
      }
    }

Field

Description

id

Unique identifier of the account

accountName

Name of the account

Type

Card is returned for Credit Card

providerName

Display name for the Provider

providerID

Unique identifier for the Provider

accountReference

A reference number for the account - typically the last 4 digits of the pan

accountHolderName

Account Holder name - optional per provider. It requires the accounts_details:read scope.

balance date

The balance as of the last refresh

amount

Balance on card

currency

The currency of the balance

creditLimit

The Credit Limit available

APR

Optional by provider

pan

Primary Account Number. It requires the accounts_details:read scope.

transactionData

Transactions on account

Savings

{
      "id": "478a84cc-296f-4388-af24-cf15f81a2fd4",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "Natwest savings a/c",
      "accountReference": "7729",
      "type": "savings",
      "providerName": "Natwest",
      "providerId": "DEMO",
      "providerReference": "demo",
      "connectionId": "DEMO:222",
      "accountHolderName": "Robert Cantu",
      "balance": {
        "date": "2020-07-05",
        "amount": {
          "value": 1500000,
          "currency": "GBP"
        }
      },
      "currency": "GBP",
      "details": {
        "AER": 0,
        "sortCodeAccountNumber": "56002926207729"
      },
      "transactionData": {
        "count": 12,
        "earliestDate": "2019-08-05",
        "lastDate": "2020-07-05"
      }
    }

Field

Description

id

Unique identifier of the account

accountName

Name of account

type

Type of account

providerName

Name of provider

providerId

Provider ID

providerReference

Reference

accountReference

A reference number for the account - typically the last 4 digits of the account number or iban number

accountHolderName

Account Holder name - optional per provider. It requires the accounts_details:read scope.

balance

balance at specific time

currency

Currency

details

Includes AER and sort code/account number

transactionData

Transactions on account

sortCodeAccountNumber

Sort Code and Account number It requires the accounts_details:read scope.

iban

IBAN. It requires the accounts_details:read scope.

Mortgage

{
      "id": "fe9e0391-960e-4251-b3b6-f7f9d144db36",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "Nationwide Repayment Mortgage",
      "type": "mortgage:repayment",
      "providerName": "Nationwide",
      "balance": {
        "amount": {
          "value": -16900000,
          "currency": "GBP"
        },
        "date": "2020-07-01"
      },
      "currency": "GBP",
      "details": {
        "linkedProperty": "2e30e166-70f8-4b46-b0e3-8afe4acda964",
        "monthlyRepayment": 1000,
        "term": 300,
        "APR": 1.94,
        "interestType": "fixed",
        "fixedDate": "2023-07-27"
      }
    }

Field

Description

id

Unique identifier of the account

accountName

Name of account

type

Type of account

providerName

Name of provider

balance

balance of account

currency

The Currency of the balance

date

Last update

fixedDate

Estimated end

APR

Interest Rate

interestType

Type of Interest

fixedDate

End date of mortgage

Loan

{
      "id": "5cbf59cf-c112-4864-b4e3-11b3ca794000",
      "accountName": "Audi Finance",
      "type": "loan",
      "providerName": "Audi Financial Services",
      "balance": {
        "amount": {
          "value": -1095000,
          "currency": "GBP"
        },
        "date": "2020-07-05"
      },
      "currency": "GBP",
      "details": {
        "monthlyRepayment": 35000,
        "endDate": "2020-07-27",
        "APR": 4.1,
        "interestFreePeriod": 24
      }
    }

Field

Description

id

Unique identifier of the account

accountName

Name of account

type

Type of account

ProviderName

Name of provider

balance

Includes the value of the loan

currency

The currency of the balance

details

Includes information on monthly repayments, the end date, APR and any interest free period

Pensions/Investments

{
      "id": "54841fea-7eb6-4523-9a20-2722d19d7766",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "HL Sipp",
      "type": "pension",
      "providerName": "Hargreaves Lansdown",
      "balance": {
        "amount": {
          "value": 3525134,
          "currency": "GBP"
        },
        "date": "2020-07-01"
      },
      "currency": "GBP",
      "details": {},
      "performanceScore": {
        "months": [
          {
            "date": "2019-08",
            "openingBalance": 3325134,
            "nonContributionGrowth": 10000,
            "aer": 3.67
          },
          {
            "date": "2019-09",
            "openingBalance": 3335134,
            "nonContributionGrowth": 20000,
            "aer": 7.44
          },
          {
            "date": "2019-10",
            "openingBalance": 3355134,
            "nonContributionGrowth": 10000,
            "aer": 3.64
          },
          {
            "date": "2019-11",
            "openingBalance": 3365134,
            "nonContributionGrowth": 20000,
            "aer": 7.37
          },
          {
            "date": "2019-12",
            "openingBalance": 3385134,
            "nonContributionGrowth": 10000,
            "aer": 3.6
          },
          {
            "date": "2020-01",
            "openingBalance": 3395134,
            "nonContributionGrowth": 20000,
            "aer": 7.3
          },
          {
            "date": "2020-02",
            "openingBalance": 3415134,
            "nonContributionGrowth": 30000,
            "aer": 11.07
          },
          {
            "date": "2020-03",
            "openingBalance": 3445134,
            "nonContributionGrowth": 20000,
            "aer": 7.19
          },
          {
            "date": "2020-04",
            "openingBalance": 3465134,
            "nonContributionGrowth": 24000,
            "aer": 8.64
          },
          {
            "date": "2020-05",
            "openingBalance": 3489134,
            "nonContributionGrowth": 12000,
            "aer": 4.21
          },
          {
            "date": "2020-06",
            "openingBalance": 3501134,
            "nonContributionGrowth": 24000,
            "aer": 8.54
          }
        ],
        "totals": {
          "openingBalance": {
            "amount": {
              "value": 3325134,
              "currency": "GBP"
            },
            "date": "2019-08-01"
          },
          "currentBalance": {
            "amount": {
              "value": 3525134,
              "currency": "GBP"
            },
            "date": "2020-07-01"
          },
          "contributions": 0,
          "withdrawals": 0,
          "nonContributionGrowth": 200000,
          "growthRate": 6.01,
          "annualisedGrowthRate": 6.57
        }
      }
    },
      
    {
      "id": "fa447159-13d2-4089-bbbc-28be41d5febd",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "Wealthify ISA (Stocks and Shares)",
      "type": "investment",
      "providerName": "Wealthify",
      "balance": {
        "amount": {
          "value": 253214,
          "currency": "GBP"
        },
        "date": "2020-07-16"
      },
      "currency": "GBP",
      "details": {},
      "performanceScore": {
        "months": [
          {
            "date": "2020-01",
            "openingBalance": 200000,
            "nonContributionGrowth": 11534,
            "aer": 95.98
          },
          {
            "date": "2020-02",
            "openingBalance": 211534,
            "nonContributionGrowth": 11214,
            "aer": 85.87
          },
          {
            "date": "2020-03",
            "openingBalance": 222748,
            "nonContributionGrowth": 12151,
            "aer": 89.15
          },
          {
            "date": "2020-04",
            "openingBalance": 234899,
            "nonContributionGrowth": 2124,
            "aer": 11.41
          },
          {
            "date": "2020-05",
            "openingBalance": 237023,
            "nonContributionGrowth": 5140,
            "aer": 29.36
          },
          {
            "date": "2020-06",
            "openingBalance": 242163,
            "nonContributionGrowth": 11051,
            "aer": 70.83
          }
        ],
        "totals": {
          "openingBalance": {
            "amount": {
              "value": 200000,
              "currency": "GBP"
            },
            "date": "2020-01-16"
          },
          "currentBalance": {
            "amount": {
              "value": 253214,
              "currency": "GBP"
            },
            "date": "2020-07-16"
          },
          "contributions": 0,
          "withdrawals": 0,
          "nonContributionGrowth": 53214,
          "growthRate": 26.61,
          "annualisedGrowthRate": 60.5
        }
      }
    }

Field

Description

id

Unique identifier of the account

accountName

Name of account

type

Type of account

providerName

Name of Provider

balance

Balance of account including currency

date

Last update

currency

Currency of account

details

Includes performance score

contributions

Contributions made to account

withdrawls

Withdrawls made to account

nonContributionGrowth

Growth of balance excluding contributions

growthrate

Growth as a percentage

annualisedGrowthRate

Yearly growth as a percentatge

Property

{
      "id": "2e30e166-70f8-4b46-b0e3-8afe4acda964",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "15 Hardys Rd",
      "type": "properties:residential",
      "balance": {
        "amount": {
          "value": 27600000,
          "currency": "GBP"
        },
        "date": "2016-01-01"
      },
      "currency": "GBP",
      "details": {}
    }

Field

Description

id

Unique identifier of the account

accountName

Usually the name of the property

type

Type of account

balance

Valuation amount

date

Valuation as of specific date

currency

Currency of valuations