Returns a collection of savings accounts searched with filtering and sorting.
This document defines relevant information so that the AI model can work with the Money Broker API for Savings Accounts. Below there's a list of available numeric IDs for filtering savings account products, the AI model must use numeric values not enum names.
Savings account types:
| ID | Enum Name | Description | |----|-----------|-------------| | 1 | CASH_ISA | Standard tax-free Cash ISA | | 3 | EASY_ACCESS | Instant access savings accounts with no withdrawal restrictions | | 5 | NOTICE_ACCOUNT | Savings accounts requiring advance notice for withdrawals | | 7 | CHILD_TRUST_FUND | Government savings scheme for children (legacy) | | 8 | FIXED_RATE_BOND | Fixed interest rate bond products with term commitment | | 9 | FIXED_TERM_BOND | Fixed term bond products with locked-in rates | | 11 | FIXED_RATE_CASH_ISA | Tax-free ISA with fixed interest rate | | 12 | REGULAR_SAVER | Regular monthly savings accounts | | 13 | NOTICE_CASH_ISA | Tax-free ISA requiring withdrawal notice | | 14 | ISA_REGULAR_SAVER | Regular saver with ISA tax benefits | | 15 | CHILDREN_EASY_ACCESS | Easy access savings for children | | 16 | CHILDREN_NOTICE_ACCOUNT | Notice account for children | | 17 | CHILDREN_REGULAR_SAVER | Regular saver for children | | 18 | CHILDREN_FIXED_RATE | Fixed rate savings for children | | 19 | OFFSHORE_EASY_ACCESS | Offshore easy access accounts | | 20 | OFFSHORE_NOTICE_ACCOUNT | Offshore notice accounts | | 21 | OFFSHORE_REGULAR_SAVER | Offshore regular saver accounts | | 22 | OFFSHORE_FIXED_RATE | Offshore fixed rate products | | 23 | FIXED_TERM_CASH_ISA | Tax-free ISA with fixed term commitment | | 24 | CHILDREN_FIXED_TERM_ACCOUNT | Fixed term savings for children | | 25 | CASH_JUNIOR_ISA | Tax-free savings for children under 18 | | 26 | REGULAR_SAVER_JUNIOR_ISA | Junior ISA with regular contributions | | 27 | ALTERNATIVE_JUNIOR_ISA | Alternative Junior ISA products | | 28 | HELP_TO_BUY_ISA | Government Help to Buy ISA scheme | | 29 | LIFETIME_ISA | Tax-free ISA for first-time buyers and retirement |
Common groupings:
- All standard bonds: "[8, 9]"
- All ISAs: "[1, 11, 13, 14, 23]"
- All Junior ISAs: "[25, 26, 27]"
- Fixed rate products: "[8, 11, 18, 22]"
- Fixed term products: "[9, 23, 24]"
- Easy access products: "[3, 15, 19]"
- Notice accounts: "[5, 13, 16, 20]"
- Regular savers: "[12, 14, 17, 21, 26]"
- Children's accounts: "[7, 15, 16, 17, 18, 24, 25, 26, 27]"
- Offshore accounts: "[19, 20, 21, 22]"
- Government schemes: "[28, 29]"
Age eligibility criteria:
| ID | Enum Name | Age Range | Description | |----|-----------|-----------|-------------| | 1 | UNDER_SIXTEEN | Under 16 years | Children and minors | | 2 | SIXTEEN_TO_TWENTY_TWO | 16-22 years | Young adults and students | | 3 | TWENTY_THREE_TO_FORTY_NINE | 23-49 years | Working-age adults | | 4 | FIFTY_AND_OVER | 50+ years | Senior savers |
Usage notes:
- Multiple age ranges can be combined with "filterType: 'ANY'"
- Use "filterType: 'ALL'" only if product must match all age criteria (rare)
Account opening channels:
| ID | Enum Name | Description | |----|-----------|-------------| | 1 | BRANCH | Open account in physical branch | | 2 | ONLINE | Open account via website | | 3 | POST | Open account by postal application | | 4 | PHONE | Open account via telephone | | 8 | MOBILE_APP | Open account via mobile application |
Usage notes:
- Use "filterType: 'ANY'" to find accounts available through at least one channel
- Combine multiple IDs to find accounts available via multiple channels
Product category groupings:
| ID | Enum Name | Description | |----|-----------|-------------| | 1 | CASH_ISA_ACCOUNTS | All Cash ISA products | | 2 | EASY_ACCESS_ACCOUNTS | Instant access accounts | | 3 | NOTICE_ACCOUNTS | Accounts requiring withdrawal notice | | 4 | REGULAR_SAVING_ACCOUNTS | Regular monthly savers | | 5 | FIXED_RATE_BONDS | Fixed interest rate bonds | | 6 | FIXED_TERM_BONDS | Fixed term bond products | | 7 | OFFSHORE_ACCOUNTS | Offshore savings products | | 8 | CHILD_TRUST_FUNDS | Child Trust Fund accounts | | 9 | HELP_TO_BUY_ISA | Help to Buy ISA products | | 10 | CASH_JUNIOR_ISA | Junior ISA products | | 11 | LIFETIME_ISA | Lifetime ISA products |
Account access channels:
| ID | Enum Name | Description | |----|-----------|-------------| | 1 | BRANCH | Manage account in branch | | 2 | ONLINE | Manage account via website | | 3 | POST | Manage account by post | | 4 | PHONE | Manage account via telephone | | 8 | MOBILE_APP | Manage account via mobile app | | 9 | ATM | Manage account via cash machine |
Usage notes:
- Use "filterType: 'ANY'" to find accounts manageable through at least one channel
- Modern accounts typically support: "[2, 4, 8]" (Online, Phone, Mobile App)
Interest rate types:
| ID | Enum Name | Description | |----|-----------|-------------| | 1 | VARIABLE | Interest rate can change over time | | 2 | FIXED | Interest rate guaranteed for term | | 3 | FIXED_THEN_VARIABLE | Fixed rate initially, then variable |
Usage notes:
- Fixed (2): Best for rate certainty
- Variable (1): May benefit from rate rises
- Fixed Then Variable (3): Initial guarantee with future flexibility
Interest payment frequency:
| ID | Enum Name | Description | Best For | |----|-----------|-------------|----------| | 1 | HALF_YEARLY | Interest paid twice per year | Semi-annual income | | 2 | ANNIVERSARY | Interest paid on account anniversary | Annual budgeters | | 3 | MONTHLY | Interest credited every month | Regular income seekers | | 4 | ON_CLOSURE | Interest paid when account closes | Flexible savers | | 5 | ON_MATURITY | Interest paid at end of term | Long-term savers | | 6 | ON_MATURITY_COMPOUNDED_ANNUALLY | Interest compounded and paid at maturity | Maximum growth | | 7 | ON_REQUEST | Interest paid on demand | Flexible income | | 8 | QUARTERLY | Interest paid four times per year | Quarterly income | | 9 | YEARLY | Interest paid once per year | Annual budgeters | | 10 | IN_ADVANCE | Interest paid upfront | Immediate income | | 11 | DAILY | Interest calculated and credited daily | Maximum compounding |
Usage notes:
- Most common: Monthly (3), Yearly (9), On Maturity (5)
- For maximum growth: Daily (11) or On Maturity Compounded Annually (6)
Product term lengths and notice periods:
| ID | Enum Name | Description | Applies To | |----|-----------|-------------|------------| | 1 | INSTANT_OR_NONE | No term or notice requirement | Easy access accounts | | 2 | THIRTY_DAYS | 30 days notice or term | Notice accounts, short bonds | | 3 | SIXTY_DAYS | 60 days notice or term | Notice accounts | | 4 | ONE_TWENTY_DAYS | 120 days notice or term | Long notice accounts | | 5 | ONE_YEAR | 1 year term | Fixed term bonds | | 6 | TWO_YEARS | 2 year term | Fixed term bonds | | 7 | THREE_YEARS | 3 year term | Fixed term bonds | | 8 | FOUR_YEARS | 4 year term | Fixed term bonds | | 9 | FIVE_YEARS_PLUS | 5+ year term | Long-term bonds |
Usage notes:
- Easy access: Use "1" (INSTANT_OR_NONE)
- Notice accounts: Use "[2, 3, 4]"
- Bonds: Use "[5, 6, 7, 8, 9]" based on desired term length
Product category codes (dynamically assigned based on account type and term):
| Code | Description | Assignment Logic | |------|-------------|---------------------------------------------------| | "all_tiers" | All products | Default filter (assigned to all products) | | "all_products_and_all_tiers" | All products and tiers | Standard filter (assigned to all products) | | "savings-childrens-accounts" | Children's accounts | Any children's account type (IDs: 7, 15-18, 24-27) | | "seo easy access" | Easy access accounts | EASY_ACCESS account type (ID: 3) | | "seo notice accounts" | Notice accounts | NOTICE_ACCOUNT type (ID: 5) | | "seo help to buy isas" | Help to Buy ISAs | HELP_TO_BUY_ISA type (ID: 28) | | "seo cash isa" | Cash ISAs | CASH_ISA type (ID: 1) | | "seo fixed rate bonds 1 year" | 1-year fixed rate bonds | Fixed rate bond with 1-365 days term | | "seo fixed rate bonds 18 months" | 18-month fixed rate bonds | Fixed rate bond with 366-458 days term | | "seo fixed rate bonds 2 year" | 2-year fixed rate bonds | Fixed rate bond with 459-731 days term | | "seo fixed rate bonds 3 year" | 3-year fixed rate bonds | Fixed rate bond with 732-1095 days term | | "seo fixed rate bonds 4 year" | 4-year fixed rate bonds | Fixed rate bond with 1096-1461 days term | | "seo fixed rate bonds 5 year" | 5-year+ fixed rate bonds | Fixed rate bond with 1462+ days term | | "seo fixed rate isa 1 year" | 1-year fixed rate ISA | Fixed rate ISA with 1-365 days term | | "seo fixed rate isa 2 years" | 2-year fixed rate ISA | Fixed rate ISA with 366-731 days term | | "seo fixed rate isa 3 years" | 3-year+ fixed rate ISA | Fixed rate ISA with 732-1095 days term | | "seo fixed rate isa 4 years" | 4-year fixed rate ISA | Fixed rate ISA with 1096-1461 days term | | "seo fixed rate isa 5 years" | 5-year+ fixed rate ISA | Fixed rate ISA with 1462+ days term | | "seo regular saver" | Regular saver accounts | REGULAR_SAVER type (ID: 12) | | "seo offshore" | Offshore accounts | Any offshore account type (IDs: 19-22) |
Usage notes:
- Categories are dynamically assigned to products by the backend based on account type and term length
- The AI model must filter using the default category.code "all_tiers" in all requests, to avoid getting duplicate products in results
- Use "accountTypeId" and "termAndNoticeId" filters should be used to filter products instead of specific categories
- Non default category codes are useful for interpreting response data and understanding product classification
How long someone must wait to access the funds in their savings account:
| Code | Description | |----------|-------------------------------------------------------| | "" | Notice period is not applicable | | "none" | Funds are available without notice | | "x days" | x days notice required, where x is the number of days |
UI control for product application:
| Value | Meaning | |-------|---------| | "1" | Show "Proceed" button (standard for user-facing results) | | "0" | Hide "Proceed" button |
Usage notes:
- Always request accounts that show the "proceed" button by default ("1")
Fee payment frequency:
| ID | Enum Name | Description | |----|-----------|-------------| | 1 | YEARLY | Annual fee charged | | 2 | MONTHLY | Monthly fee charged | | 3 | QUARTERLY | Quarterly fee charged | | 10 | NONE | No fees charged |
Usage notes:
- Fee Frequency Type Ids are useful for interpreting response data
The code will be added to each account's click out URL. It's an internal field used for tracking purposes. The field has two components separated by an underscore ("_"): 1. The first part indicates the general type of the account based on the productAttributes.accountDetails.accountTypeId filter used. a. If the filter is used accepted values for the first part are: "FIXED_RATE", "EASY_ACCESS" and "ISA" b. If the filter is not used or contains values matching multiple accepted values then "ALL_TIERS" should be used instead. 2. The second part is optional and indicates the term length or notice period based on the productAttributes.accountDetails.termAndNoticeId filter. a. If the filter is used accepted values are: "1Y", "2Y", "3Y", "4Y", "5Y", or "NO_NOTICE". b. If the filter is not used or contains values matching multiple accepted values then this part should be omitted.
The list of acceptable options is:
| filterCode | Description | |------------|-------------| | FIXED_RATE_1Y | Fixed rate bond with 1 year term | | FIXED_RATE_2Y | Fixed rate bond with 2 year term | | FIXED_RATE_3Y | Fixed rate bond with 3 year term | | FIXED_RATE_4Y | Fixed rate bond with 4 year term | | FIXED_RATE_5Y | Fixed rate bond with 5 year or more term | | FIXED_RATE | Fixed rate bond without a termAndNoticeId filter or a mix of terms | | EASY_ACCESS | Easy access account regardless of the termAndNoticeId filter | | ISA_1Y | ISA with 1 year term | | ISA_2Y | ISA with 2 year term | | ISA_3Y | ISA with 3 year or more term | | ISA_4Y | ISA with 4 year term | | ISA_5Y | ISA with 5 year or more term | | ISA_NO_NOTICE | ISA with termAndNoticeId of 1
| ALL_TIERS | Default code for all other cases |
When presenting results the AI model should always:
- round down total interest earned
- restrict the number of results to a maximum of 5 accounts