These docs are for v2.5. Click to read the latest docs for v3.0.

Manual Accounts - Account Details

Requirements for the accounts details object when creating a manual account

When creating a manual account, you specify an account details object, the below table describes which fields are allowed to be specified for each account type, and which fields are required.

Account TypeAllowed FieldsRequired Fields
investment, pension:*, cryptononenone
cash:currentAER, overdraftLimitnone
savingsAERnone
cardAPR, creditLimitnone
loanAPR, monthlyRepayment, endDate, interestFreePeriodnone
mortgage:*APR, monthlyRepayment, term, endDate, interestType, fixedDate, linkedPropertyterm
assetrunningCost, runningCostPeriod, yearlyAppreciationnone
properties:*postcode, yearlyAppreciationnone