# About Nueve
Source: https://docs.nuevesolutions.com/guides/nueve/about
Nueve Solutions is a banking technology company based in Austin, TX, specializing in helping banks and credit unions modernize their digital banking experience through automation, self-service tools, and scalable integrations. With **50+ banking clients**, Nueve is a trusted technology partner for financial institutions looking to reduce operational overhead, grow deposits, and deliver better digital experiences to their account holders.
## What We Do
Nueve works directly with banks and credit unions to design, build, and deploy digital banking solutions that solve real operational and growth challenges. Our core focus areas are:
* **Automation** — Eliminating manual, repetitive banking operations through intelligent rule-based workflows
* **Self-Service Experiences** — Empowering account holders to manage accounts, deposits, and referrals entirely online
* **Account Origination** — Enabling fully digital account opening and funding with no branch visit required
* **Integrations** — Connecting digital banking environments with third-party tools for identity verification, payments, e-signing, SSO, and more
We collaborate closely with each institution throughout the process, ensuring every solution aligns with their operational goals, compliance requirements, and user expectations. All solutions are built for long-term scalability, security, and efficiency.
## Platform Partnerships
Nueve is an official certified partner on two leading digital banking platforms, and is actively expanding to serve institutions across additional platforms.
| Platform | Status |
| - | - |
| **Q2** | Official Q2 Certified Partner |
| **Banno** (by Jack Henry & Associates) | Official Banno Partner |
| **Other Platforms** | Actively expanding |
This multi-platform approach means Nueve can serve financial institutions regardless of the technology stack they run on — and continue as a long-term partner as institutions grow or evolve their platforms.
## Why Nueve
* Official **Q2 Certified Partner** and official **Banno Partner**
* **50+ banking clients** across banks and credit unions
* Expanding to additional digital banking platforms
* Fast to implement, easy to manage — no-code configuration
* Built for compliance, security, and long-term scalability
* Collaborative, client-focused delivery model
# Frequently Asked Questions
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/faq
## What is a source group?
A source group is a customer group that scopes an automation to a specific segment of your customer base. When a source group is configured, only customers who belong to that group are eligible to be evaluated by the automation — customers outside the group are skipped entirely.
Source groups are optional. If no source group is set, the automation applies to all customers across your institution, subject to any criteria that are configured.
For On Login Popup automations, the source group is always required because those prompts are designed to target a defined segment rather than every customer who logs in.
## What automation types does Nueve Automate Banking offer?
Automate Banking ships with five pre-built automation scenarios under the Segment & Notify tab:
**Minor Users**
Identifies customers below a configured age threshold. Typically used to move minor account holders into an appropriate group or restrict their online access.
**Inactive Users**
Identifies customers who have not logged in for a specified number of days. Used for dormancy outreach, group reclassification, or account disabling.
**New Users**
Identifies recently registered customers. Supports a wide range of criteria combinations, making it suitable for onboarding workflows that need to account for deposit balances, account types, or group membership.
**No Open Accounts**
Identifies customers who currently have zero open accounts. Used for follow-up outreach or group reassignment.
**New (Other – Group)**
A variant of the new users scenario that is scoped to a specific source group. Used when onboarding workflows should only apply to customers within a particular group.
In addition to these, Automate Banking supports On Login Popup automations for real-time prompts at login, and File automations for bulk operations driven by uploaded or SFTP-delivered files.
## How do I configure an automation?
To configure an automation, navigate to the relevant tab — Segment & Notify, or File — and select an automation type from the dropdown, then click **Create**.
From there you will configure:
* **Name and description** — a label and brief summary of what the automation does
* **Source group** — optionally limit the automation to a specific customer group
* **Criteria** — one or more filters that define which customers are targeted. The criteria available depend on the automation type selected
* **Actions** — what to do when a customer matches. For Segment & Notify automations this includes options like Move Group, Send Email, or Disable User. For On Login Popup automations, you configure cases with criteria and a designated prompt for each
* **Scheduling** — when and how often the automation should run
Once configured, use the toggle on the automation card to enable it. It is recommended to run the automation in preview mode first to verify the target segment before enabling live execution.
## How do I configure timing and scheduling?
Each Segment & Notify automation has two scheduling options:
**Recurring**
The automation runs automatically at a set interval. You specify how many days between each run and optionally set a start date. The platform tracks when the automation last ran and triggers the next run when the interval has elapsed.
**One-time**
The automation runs once at a specific date and time you choose. After it executes, it does not run again unless re-configured.
A master process switch controls whether all automations are actively running. This can be toggled on or off without changing the configuration of individual automations, useful for pausing all processing during maintenance windows or business holds.
On Login Popup automations do not have a schedule — they are evaluated in real time each time a customer logs in, as long as the automation is enabled.
## What is preview mode and when should I use it?
Preview mode lets you run an automation without committing any changes. When preview mode is on, the platform evaluates all configured criteria and identifies which customers would be affected — but no actions are executed. No customers are moved, no emails are sent, and no accounts are changed.
Preview mode is recommended whenever you are setting up a new automation or adjusting criteria on an existing one. It gives you a chance to verify that the right customers are being targeted before going live.
Preview mode can be toggled on or off globally from the settings area of the Automate Banking tool.
## What happens when multiple criteria are configured on an automation?
All criteria must match for a customer to be included. If a customer meets some criteria but not all, they are excluded from the run. This AND logic allows you to build precise segments — for example, targeting only customers who registered recently AND have not made a deposit AND do not already hold a savings account.
## How are automation results delivered?
Once all automations for the day have completed, the platform generates an audit report that includes the outcome for every customer processed — whether each action succeeded or failed. This report is delivered by email to the administrator addresses configured for your institution.
For file automations, the report is generated and sent as soon as that individual file automation completes, rather than waiting for all automations to finish. A processed output file is also included so staff can review results record by record.
## Can I build criteria or actions beyond what is listed?
Yes. The available criteria and actions cover the most common scenarios out of the box, but additional options can be developed to meet your institution's specific requirements. Reach out to [hello@nuevesolutions.com](mailto:hello@nuevesolutions.com) to discuss what's possible.
# Overview
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/overview
Automate Banking is a customer engagement platform for financial institution staff. It lets customer service teams build rule-based workflows that automatically identify customer segments and take action — without manual follow-up.
## What It Does
Staff configure automations by selecting which customers to target and what to do when a match is found. The platform handles the execution: processing customers in the background, tracking results, and delivering audit reports when a run completes.
## How It Works
Automate Banking operates in two modes:
**Automations**
Scheduled workflows that run on a recurring or one-time basis. Staff define filtering criteria to identify a customer segment, then assign one or more actions — such as moving customers to a different group, sending an email, or disabling an account. Each run processes customers in batches and generates a downloadable report.
**File Processing**
Bulk operations driven by files delivered via upload or SFTP. When a file arrives, the platform reads each record and applies the configured action. A results report is emailed to the configured administrator when processing is complete.
## In This Section
* [Automations](./workflows/automations) — Create and manage scheduled customer-targeting workflows
* [File Processing](./workflows/file-processings) — Configure batch workflows driven by uploaded or SFTP-delivered files
* [Criteria](./reference/criterias) — Reference for all available customer-targeting filters
* [Actions](./reference/actions) — Reference for all actions that can be applied to matched customers
# Actions
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/reference/actions
Actions define what happens when a customer matches the criteria configured for an automation. One or more actions can be assigned to each automation, and all assigned actions execute against every matched customer when the run completes.
## Available Actions
**Move Group**
Moves matched customers from their current group to a specified target group. A source group can be set to limit which customers are eligible for the move. An optional setting prevents customers who have pending actions from being moved until those actions are resolved.
**Disable User**
Disables the online banking account for each matched customer. The account remains in the system but the customer can no longer log in until the account is re-enabled.
**Enable User**
Re-enables an online banking account that was previously disabled. Used to restore access for customers who have been reactivated or who have met the conditions for reinstatement.
**Send Email**
Delivers an email notification to each matched customer. The subject line, message body, and login portal URL are all configurable per automation. Formatted to display correctly across all email clients.
**Send Push Notification**
Sends a mobile push notification to each matched customer's most recently active registered device. Used for time-sensitive outreach where immediate visibility is important.
## Execution and Reporting
Actions run automatically when the automation executes on its configured schedule. Each action logs whether it succeeded or failed for every customer processed. When the run is complete, the platform compiles a full audit report and delivers it to the configured administrator email address.
Before committing a run, staff can enable preview mode to see which customers would be affected and which actions would execute — without making any changes. This allows validation of criteria and action configuration before going live.
## Need a Custom Action?
> **The actions listed above cover the most common operations out of the box.**
>
> If your institution requires something beyond these — such as a core system update, a custom notification channel, or an integration with a third-party service — additional actions can be developed to fit your workflow.
>
> Contact us at [hello@nuevesolutions.com](mailto:hello@nuevesolutions.com) to discuss what's possible.
# Criteria
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/reference/criterias
Criteria are the filters that determine which customers an automation targets. Each automation can have one or more criteria configured. When multiple criteria are set, a customer must match all of them to be included in the run.
## Available Criteria
**Days Since Online Banking Account Creation**
Targets customers whose online banking account was created a specified number of days ago. Useful for onboarding workflows that should trigger shortly after a new user registers.
**User Is Under a Specified Age**
Targets customers below a configured age threshold. Commonly used to identify minor account holders who may require different group placement or restricted access.
**Customer Holds Specific Product Types**
Targets customers who hold one or more specified product types, such as Deposit or Loan accounts. Can be configured to include or exclude selected product types.
**Total Deposits Meet or Exceed a Minimum**
Targets customers whose combined deposit balance is at or above a configured dollar amount. Used to identify customers who have sufficiently funded their accounts.
**Days Since Last Login**
Targets customers who have not logged in to online banking for a specified number of days. The primary criterion for inactivity-based workflows.
**Customer Has No Open Accounts**
Targets customers with zero currently open accounts. No additional configuration is required — this criterion matches or does not match based on account status alone.
**Customer Has a Specific Account Type**
Targets customers who hold at least one account of a selected type, such as Savings or Certificate of Deposit. Multiple account types can be selected.
**Customer Does Not Have a Specific Account Type**
Targets customers who do not hold any account of a selected type. The inverse of the criterion above — useful for identifying customers who are candidates for a new product.
**Total Balance At or Below a Specified Amount**
Targets customers whose total account balance is at or below a configured dollar threshold.
**Customer Has a Qualifying Direct Deposit**
Targets customers based on the presence of non-recurring transactions within a specified number of recent months. Used to identify customers with or without active direct deposit activity.
**Total Deposits Below a Specified Amount**
Targets customers whose combined deposit balance falls below a configured threshold. Useful for identifying low-balance customers for outreach or incentive campaigns.
**Customer Has a Maturing CD**
Targets customers who have a Certificate of Deposit maturing within a specified number of days. Used to trigger renewal outreach before a CD reaches its maturity date.
**Customer Has Open Accounts of Specific Types**
Targets customers who currently hold open accounts matching selected product codes. Supports flexible set-based matching — any, none, all, or not all of the selected types.
**Customer Is Inactive or Has No Open Accounts**
A composite criterion that matches customers who either have not logged in for a specified number of days or have no open accounts. Useful for broad dormancy cleanup workflows.
**Customer Belongs to Specified Groups**
Targets customers whose current group membership matches one or more configured group values. Used to scope an automation to a particular segment that is already organized by group.
## Operators
The operators available for a criterion depend on the type of value it accepts.
**Numeric** — used for criteria that compare days, age, or dollar amounts:
* Equals
* Not equals
* Greater than
* Greater than or equal to
* Less than
* Less than or equal to
* Range (between two values, inclusive)
**List** — used for criteria that match against one or more selected types:
* Any of (inclusion)
* None of (exclusion)
* All in
* Not all in
## Need a Custom Criterion?
> **The criteria listed above cover the most common customer-targeting scenarios out of the box.**
>
> If your institution requires a filter that isn't available — such as a product-specific balance threshold, a custom transaction pattern, or a data point unique to your core system — additional criteria can be built to match your exact requirements.
>
> Contact us at [hello@nuevesolutions.com](mailto:hello@nuevesolutions.com) to discuss what's possible.
# Push Notifications & Deep Linking
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/reference/push-notifications
The Send Push Notification action already delivers alerts to a customer's most recently active registered device. This page covers what push notifications do today, and the deep linking upgrade currently in progress that lets a tapped notification open directly to a specific screen in the app.
## What is a push notification?
A push notification is the alert that appears on a customer's phone — a title and a short message. This is working today. What happens after the customer taps it depends on the app being told where to send them, which is where deep linking comes in.
## What is deep linking?
Deep linking lets a tap or a link take a customer straight to one specific screen inside the app, rather than opening the app to wherever it last was. Instead of opening the app and requiring the customer to navigate to Transfers, a deep link opens directly to Transfers.
**Without deep linking**
Customer taps a notification. The app opens. The customer still has to navigate to the right screen themselves.
**With deep linking**
Customer taps a notification. The app opens directly to the relevant screen — accounts, a transfer, a message, or whatever the notification was about.
## How the two work together
Today, a push notification and a deep link are two separate pieces. For a tap to land on a specific screen, the app needs a built-in instruction that says where to go when the notification is tapped. The same mechanism also lets the app open to a specific screen from a regular web link — for example, one shared in an email, a text message, or on a website — with no push notification involved at all.
Customer taps a notification or link, the app reads where it should go, then the app opens directly to that screen.
If a customer isn't logged in yet, the app doesn't lose the request — it takes them to that screen right after they log in.
## What's needed to finish deep linking
The mechanics are ready. Turning this on for a specific bank's app requires the following confirmed.
**1. Production app identifiers**
Every link is addressed to the exact app, so two values are needed:
* **Android app ID** — the unique identifier the Android app is published under in the Play Store. The production ID is required; a test/preproduction ID is not sufficient.
* **iOS URL scheme** — the short custom name the iOS app registers with the phone so it knows to open when a matching link is tapped.
Example — Android: `com.yourbank.appname` · iOS: `yourbank`
**2. Production web banking address**
The live web address customers use for online banking today, not the test/PTE address. Used as the fallback destination any time a link needs to point to the website instead of the app — for example, on a device where the app isn't installed.
Example — `https://secure.yourbank.com/onlinebanking`
**3. Screen names for each destination**
Each screen inside the app has an internal route name that a link points to. The correct route name is needed for every screen customers should be able to jump to directly. Common ones:
| Route | Screen |
| - | - |
| `accounts` | Account summary |
| `transfer` | Fund transfer |
| `messages` | Secure messages |
| `statements` | E-statements |
| `transactions` / `activityCenter` | Recent activity |
| `settings` / `profile` | Profile page |
| `branches` | Branch locator |
Any additional screen not in this list can be named and its route will be confirmed.
**4. Default landing page**
Where the customer lands when a notification or link doesn't specify an exact screen. Most banks use their account summary screen.
Example — `accounts` or `dashboard`
**5. Looking up identifiers if not already known**
Both identifiers from item 1 can still be looked up even if they're not on hand:
* **iOS URL scheme** — export the app's installer file using a device-management tool such as iMazing, then check the settings file inside it for the app's registered URL scheme.
* **Android package name** — usually visible in the app's Google Play Store listing address, or confirmed directly from the installed app.
## Good to know
If a link ever points to a screen that doesn't exist or isn't recognized, the app simply stays where it is — nothing breaks. Once the values above are confirmed, no new app submission is needed; this is a configuration update.
On Android, a customer needs to have opened the app at least once for links to work. If it's installed but has never been launched, a link shows a blank page until the customer opens it the first time.
# Release Notes
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/release-notes
***
## v2.3.0 — Upcoming
Added per-automation preview control, customer filtration error reporting, FI-level customization for criteria and action names, one-off template testing, and a bankruptcy file criteria fix.
### Features
* Added per-automation preview mode, allowing preview to be enabled or disabled independently per automation instead of one global toggle
* Added capture and reporting of customer filtration errors, grouped by error message, instead of silently dropping affected customers
* Introduced a centralized Wedge-first/constants-fallback utility for FI-level customization of criteria and action names, requiring no redeploy
* Added a "Test Template" action on Email, Text, and Push templates to send a one-off test directly from the console
### Fixes & Improvements
* Fixed bankruptcy file criteria regex to handle trailing columns and CRLF line endings, plus added a wedge-config override for required file columns
***
## v2.2.0 — Sep 7th 2026
Standardized criteria and switch-case processing across automations, added user-scoped notifications and reporting, unified case updates, and improved resumable inactive-user processing with account validation fixes.
### Features
* Standardized criteria processing using **CriteriaResult** and **ChainScope** contracts, enabling consistent customer- and user-level filtering across automations
* Added per-user pool claiming so individual users are exclusively processed by the appropriate switch-case, preventing unintended duplicate actions
* Extended matched-user scoping to Email, SMS, and Push Notifications to prevent active co-account users from receiving notifications intended for specific users
* Added customer and user name resolution through `REPORT_CUSTOMER_FIELDS` and `REPORT_USER_FIELDS`, replacing bare IDs with meaningful details in automation reports
* Added the `update_case_data` endpoint to process criteria and action updates, including inserts and deletions, in a single request
* Migrated 10+ criteria to the standardized result contract with cached user resolution for improved consistency and performance
* Enhanced `days_since_last_login` processing with ArdentFS-based pagination and persistent state tracking, allowing processing to resume across execution cycles
* Added automation-level cache scoping to maintain independent processing state for each automation case and prevent cache conflicts
* Optimized switch-case processing by allowing multiple cases to share a common candidate pool, reducing unnecessary Q2 API calls
* Implemented per-page user claiming so users matched by earlier switch-case conditions are not re-evaluated by subsequent cases
* Added cycle-draining logic to ensure paginated inactive-user processing completes successfully without leaving partial results
* Updated ALL-type automations to include complete customer and user details instead of only IDs
* Added criteria for evaluating user accounts with product ID filtering and external account exclusion support
### Fixes & Improvements
* Fixed an issue where `if_all_in` and `if_not_all_in` operators incorrectly returned True for customers without active accounts
* Added an early False result when the active values collection is empty, preventing incorrect subset evaluations
* Refactored active-value handling logic to improve readability and maintainability
* Improved automation key sorting, cache-state recovery, logging, and backward compatibility for existing GROUP-type and standalone automations
* Added configuration options for inactive-user pagination, bulk ALL-type criteria, bankruptcy required columns, and external product exclusions
* Renamed `ACCOUNT_STATUS_ID` to `OPEN_ACCOUNT_STATUS_ID` for improved configuration clarity
***
## v2.1.0 — Jul 31st 2026
Expanded Automate Banking with enhanced SMS, push notification, and file-processing capabilities, along with improved execution scheduling and data privacy controls.
### Features
* Added support for SMS templates, including variable mapping, template persistence, and management APIs
* Introduced configurable execution windows across Email, SMS, Push Notifications, Group Move, and Disable User actions to ensure automations run only within defined time windows
* Enhanced **HOURS**-based recurring automations to retry skipped or failed executions by preserving the last execution timestamp when actions are blocked by execution windows or Q2 API failures
* Updated the Disable User workflow to operate directly on matched user IDs, preventing unintended disabling of active co-account users, and added a configuration option to control user status changes
* Enabled push notifications to be delivered to all registered devices, added variable mapping support for push templates, and introduced a demo push notification capability for testing
* Unified dynamic variable resolution across Email, SMS, and Push Notification templates, supporting configurable user field mappings from the Q2 API
* Added customer name resolution for report generation, enabled report delivery after each processed file, and introduced execution interval support for file-based actions
* Added automatic masking of account numbers in CD Maturity processing to improve data privacy (for example, `1282252301` → `******2301`)
* Added independent preview and processing controls for File Central, separate from existing file records processing controls
* Added new configuration options for execution windows, File Central preview and cron card visibility, automation report subject, and logon status filtering for Days Since Last Login criteria
### Fixes & Improvements
* Improved null handling, standardized criteria matching logic, and corrected recurring automation start time initialization for more reliable scheduling
***
## v2.0.0 — May 21st 2026
Expanded Automate Banking with a redesigned automation platform focused on intelligent workflow orchestration, flexible execution scheduling, advanced file-processing capabilities, and high-performance banking operations at scale.
### Features
* Introduced a completely redesigned Console UI with improved workflow management and modernized user experience
* Added one-time and recurring execution interval support for flexible automation scheduling and processing control
* Introduced switch-case automation handling to support multiple workflow cases within a single automation, reducing the need for separate automation configurations
* Added optimized customer pre-filtering and workflow partitioning to improve automation execution performance and reduce redundant SDK calls
* Added advanced file-processing workflows with automated file parsing, delimiter detection, and customer resolution support
* Integrated Caliper APIs for customer account retrieval, balance evaluation, and transaction-based automation workflows
* Added parallel batch-processing support for high-volume banking operations
* Enhanced file-based automations to support multiple configured actions per customer workflow
* Added source group tracking for automation consistency across file-processing workflows
* Introduced validation decorator support for file-processing criteria and workflow validation
### Fixes & Improvements
* Improved operator and range evaluation handling for automation criteria processing
* Enhanced logging and exception handling across automation and file-processing workflows
* Improved consistency and reliability of Q2 API operations during processing tasks
* Removed legacy GroupMover extension files and unused templates to streamline platform maintenance
***
## v1.4.0 — Apr 09th 2026
Enhanced the Automated Banking Console with expanded file-based processing capabilities and improved architectural foundations.
### Features
* Added complete support for file-based automation processing with new file-processing routes and configurations
* Refactored dependency injection from Injector-based implementation to a factory pattern using `create_services()`
* Unified database state management for both automation and file-processing workflows
* Added new criteria support for validating user open accounts against configurable product IDs
* Added new database configurations for file processing, timeout handling, and product code filtering
* Refactored routing logic by renaming process\_entrypoint to process\_member\_group
### Fixes & Improvements
* Improved database error handling with enhanced null checks and defensive validations
* Enhanced SFTP file retrieval with improved logging and exception handling
* Removed unused navigation routes and improved overall code maintainability
***
## v1.3.0 — Feb 23rd 2026
Enhanced Automate Banking with improved processing performance and expanded SFTP integration support for Q2 environments.
### Features
* Added Q2 SFTP integration support using the q2\_open API for /mnt/sftp path handling in Q2 PTE environments
* Added multi-encoding fallback support for bankruptcy file processing from SFTP sources
* Improved minimum deposit criteria processing with early-exit optimization to reduce unnecessary API calls
### Fixes & Improvements
* Fixed missing hq\_credentials parameter handling in GetUserAccountList API calls
* Improved validation and logging for SFTP file operations and path management
* Enhanced exception handling for file processing workflows
***
## v1.2.0 — Jan 21st 2026
Enhanced Automate Banking with expanded automation processing capabilities, improved transaction filtering, and additional workflow configuration controls.
### Features
* Added advanced minimum deposit filtering with configurable date ranges and pagination support
* Implemented automated CSV file processing with preview and execution modes
* Introduced configurable Cron and Preview card visibility controls for report-generation workflows
* Added improved Q2 transaction processing with date-based history filtering and deposit-only support
* Added new automation criteria for "User does not have account type"
* Reorganized and enhanced automation criteria configurations
* Introduced updated frontend components with responsive layouts and modernized styling
* Added new utility support for date calculations, filesystem operations, and action mapping
### Fixes & Improvements
* Optimized timeout handling for large processing operations
* Simplified direct deposit verification workflows
* Removed redundant transaction validation methods
* Improved overall automation processing efficiency
***
## v1.1.0 — Dec 1st 2025
Migrated Automate Banking from Central Extension to Console, delivering an improved management experience and expanded personalization capabilities for financial institutions.
### Features
* Added centralized API routing for automation management workflows
* Introduced the Personalized Dashboard tab within Scenarios
* Added support for image and video-based dashboard content experiences
* Enhanced frontend support for personalized advertising criteria configurations
* Updated validation and configuration handling for new dashboard display experiences
### Fixes & Improvements
* Improved age verification workflow performance with optimized batch processing
* Improved application logging and response consistency
* Enhanced environment configuration management
* Improved utility handling for request processing and data parsing
***
## v1.0.0 — Nov 6th 2025
Introduced the first release of Automate Banking, providing financial institutions with automated user management and rule-based banking workflows on the Q2 platform.
### Features
* Automated group mover for dynamic Q2 user segmentation
* Rule-based automation engine for user lifecycle workflows
* Automated movement of users between banking groups based on eligibility and activity
* User notification support via email, SMS, and push notifications
* Inactivity and access management workflows
* Fraud and risk-based user restriction workflows
* Centralized automation controller and workflow processing architecture
* Validation and field sanitization support
* SDK module integrations
# Reporting
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/reporting
Automate Banking generates reports for both Segment & Notify automations and file processing jobs. Reports are delivered by email to all configured administrator addresses and include a download link to the full results file.
## Automation Reports
Once all Segment & Notify automations for the day have completed, the platform compiles a consolidated CSV report covering every customer that was evaluated across all runs. The report is uploaded to secure storage and a download link is included in the email delivered to your team.
Each row in the report represents one action result and includes:
* **Timestamp** — the date and time the automation ran
* **Automation Name** — the name of the automation as configured
* **Action Type** — the action that was executed, such as Move Group, Send Email, or Disable User
* **Source Group** — the group from which customers were drawn
* **Destination Group** — the target group, populated for Move Group actions
* **Success** — whether the action completed successfully for that record
* **Reason** — a description of the outcome, including any error detail if the action failed
* **User List** — the users who were processed during the run
* **Customer List** — the customers who were processed during the run
Each automation is listed separately within the consolidated report so results can be reviewed per automation.
## Preview Mode Reports
When preview mode is enabled, the automation evaluates criteria and identifies which customers would be affected — but no actions are executed. The report generated in preview mode reflects this:
* The User List and Customer List columns show who **would have been** processed
* No group moves, emails, notifications, or account changes are recorded as having occurred
* Preview results are clearly separated from live results
Preview reports are useful for validating a new automation or reviewing changes to criteria before enabling live execution.
## File Processing Reports
When a file automation completes, a report is generated and sent immediately — it does not wait for other automations to finish. The report tracks the outcome for every record in the file. Each row in the file processing report includes:
* **Timestamp** — the date and time the file was processed
* **Action Type** — the action applied to each record
* **Record Type** — whether the record was successfully processed or is pending (waiting for retry)
* **Target Group** — the group records were moved to, where applicable
* **Customer IDs** — the customers associated with each record
* **Status** — Success, Failed, or Preview
* **Reason** — a description of the result or the reason a record could not be processed
Pending records are those that could not be processed in the current run — for example, due to a data issue or a temporary system error. They are retained for review so staff can take follow-up action as needed.
## Report Delivery
Reports are emailed automatically to every address listed in your institution's configured administrator email list. Each administrator receives an individual email containing:
* A summary message confirming the run completed
* A download link to the full CSV report
The download link is valid for **3 days** from the time the report is generated. After that, the file expires and the link will no longer work. If you need a report after the expiry window, re-run the automation or contact your administrator.
## Configuring Report Recipients
Report emails are sent to the addresses configured in the Target Emails setting for your Automate Banking installation. To add or update recipient addresses, contact your institution's system administrator or reach out to [hello@nuevesolutions.com](mailto:hello@nuevesolutions.com).
# Use Cases
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/use-cases
Here are some popular use cases for Automate Banking. If you have a use case that is not listed here, please reach out to us to discuss your requirements.
***
## Group Move
Automatically move users between groups based on account type, age, deposit behavior, or risk status.
**1. Premium Account Upgrade**
* Based on the user's minimum total deposit over a defined period of time, automatically move them into a premium account group and send a push notification to inform them of the upgrade.
**2. New Users**
* Automatically move users into the correct group based on their account type 30 days after enrollment, ensuring they always have access to the appropriate features and resources.
**3. Disable Inactive Users**
* Automatically disable accounts for users who have not logged in for a defined period of time, reducing the attack surface and keeping account access limited to active users.
**4. Minors**
* Automatically move minor users into the appropriate group when they turn 16 or 18 years old, ensuring account permissions match their current age bracket.
**5. Suspected Fraud**
* Automatically disable accounts when fraud is suspected, containing risk quickly and preventing further unauthorized activity.
**6. No Open Accounts**
* Automatically manage users who no longer have any open accounts, keeping the user base aligned with active account relationships.
**7. Bankruptcy**
* Automatically move users to appropriate groups when they declare bankruptcy, ensuring their account access and permissions are adjusted accordingly.
***
## Notifications
Send email or push notifications to users based on account activity, balances, or upcoming events.
**1. Promote New CD & High Yield Savings Rates**
* Send push or email notifications to eligible users when new CD or high yield savings rates launch, driving quick awareness and deposit growth.
**2. Maturing CD**
* Send email notifications to users with an upcoming CD maturity date, giving them time to decide on renewal or withdrawal.
**3. CD Renewal**
* Send email notifications to users with an upcoming CD renewal, keeping them informed before the renewal takes effect.
**4. Loan Payment Due**
* Send email notifications to users with an upcoming loan payment due, helping reduce missed or late payments.
**5. Low Balance**
* Send push notifications to users with a low account balance, helping them avoid overdraft fees.
**6. Personalized Offers**
* Send personalized offers to specific group customers based on their account type, transaction history, and other relevant criteria, increasing engagement and product adoption.
**7. Drive Loans**
* Send push notifications to users who have not applied for a loan, encouraging them to explore available loan products and services.
**8. Setup Direct Deposit**
* Send push notifications to users who have not set up direct deposit, encouraging adoption of a core banking feature.
**9. Fraud Alerts**
* Send push or email notifications to members when new fraud threats or suspicious activity are detected on their accounts, enabling quick awareness and response.
**10. Fraud Education**
* Send push or email notifications with fraud education content to account holders, helping them recognize and avoid common scams.
**11. Promote Third-Party Offerings**
* Send push or email notifications to eligible users promoting new third-party offerings and services, driving quick awareness and adoption.
***
## On Login Popup
Show popups upon Online Banking login to collect missing information or prompt product adoption.
**1. Update Address**
* Prompt users with outdated or missing address information to update it upon login to Online Banking, keeping account records accurate and compliant.
**2. Update Income**
* Prompt users with outdated or missing income information to update it upon login to Online Banking, supporting accurate underwriting and risk assessment.
**3. Prompt Credit Card to New Users**
* Prompt new users to apply for a credit card upon login to Online Banking, encouraging adoption of a core banking product.
# Automations
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/workflows/automations
Automations are scheduled workflows that identify a segment of customers and apply a set of actions to each matched customer. They run automatically on a configured schedule — no manual triggering required.
## How Automations Work
Each automation is built around two components:
**Criteria**
One or more filters that define which customers to target. Customers must match all configured criteria to be included in the run. See [Criteria](../reference/criterias) for the full list of available filters.
**Actions**
One or more operations to perform on each matched customer — such as moving them to a different group, sending an email, or disabling their account. See [Actions](../reference/actions) for the full list of available operations.
When the automation runs, the platform retrieves customers in batches, applies the criteria, and executes the configured actions on every customer that matches. Previously processed customers are tracked so they are not processed again in subsequent runs.
## Pre-Built Scenarios
Automate Banking includes five pre-built scenarios to help staff get started quickly. Each scenario comes with a focused set of recommended criteria and actions that are appropriate for the use case.
**Minor Users**
Targets customers below a configured age threshold. Designed for workflows that need to identify and act on minor account holders — for example, moving them to an age-appropriate group or disabling online access.
**Inactive Users**
Targets customers who have not logged in for a specified number of days. Used for dormancy notifications, account disabling, or group reclassification of long-inactive users.
**New Users**
Targets recently registered customers. Supports flexible multi-criteria configuration, making it suitable for onboarding workflows that need to account for deposit minimums, account types, or other qualifying factors.
**No Open Accounts**
Targets customers who currently have zero open accounts. Used to identify customers who may need outreach, group reassignment, or account closure follow-up.
**New (Other – Group)**
A variant of the new users scenario scoped to a specific customer group. Used when onboarding workflows should apply only to customers within a defined group rather than the entire customer base.
Staff can also create custom automations beyond the pre-built set by selecting any combination of supported criteria and actions.
## Scheduling
Each automation can be configured to run on a recurring schedule — expressed as a number of days between runs — or as a one-time execution at a specific date and time. Automations can be enabled or disabled individually without deleting the configuration.
## Preview Mode
Before a run executes any changes, staff can enable preview mode. In this mode, the automation processes criteria and returns the list of customers who would be affected, without executing any actions. Preview mode is recommended when setting up a new automation or after changing criteria to verify the target segment is correct.
# File Processing
Source: https://docs.nuevesolutions.com/guides/products/automate-banking/workflows/file-processings
File Processing automates bulk customer operations driven by files delivered from external systems. When a new file arrives in a configured location, the platform reads each record and applies the associated action — no manual data entry required.
## How It Works
A file automation is configured with a file source location and an action to perform on each record in the file. The platform checks for new files on a scheduled basis. When a new file is detected, it is queued for processing. Each record is read in sequence, the action is applied, and the result — success or failure — is logged per record.
Once processing is complete, the platform generates a results report and emails it to the configured administrator address, along with a link to download the processed output file.
## File Delivery
Files can be delivered in two ways:
**Upload**
Files are uploaded directly through the administrative interface. The platform detects the new file and begins processing on the next scheduled check.
**SFTP**
Files are delivered to a configured SFTP path by an external system. The platform monitors the path for new arrivals and picks them up automatically. This is the preferred method for integrations with core banking systems or third-party data sources.
## Supported Actions
File processing supports the same actions available in standard automations — including group moves, account enable and disable, and notifications — applied row by row to the records in the file.
## Results and Reporting
After each file is processed, a downloadable report is generated that includes the outcome for every record. The report is emailed to the configured administrator so staff can review results, identify any records that failed, and take follow-up action as needed.
Each file automation tracks which files have already been processed to prevent records from being applied more than once.
# Admin Guide
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/banno/admin-console
## Overview
The Admin Console is where FI staff manage the Refer a Friend program for the Banno integration — creating and editing campaigns, reviewing referrals, and processing reward payouts. Staff sign in with their own console credentials to access it, separate from the member-facing login.
## 1. Overview Dashboard
The landing page gives staff an at-a-glance summary of the institution's referral activity — total referrals, and how many are submitted, have met their criteria, are ready to pay, have been paid, or have expired.
**Campaigns table:**
Lists every campaign for the institution, active and past. Each row shows the campaign type, an optional restriction to a specific promoter, priority, start/end dates, and both reward amounts.
* **Edit** — opens the edit form for that campaign.
* **Status toggle** — turns the campaign on or off. Turning it off ends the campaign immediately, even before its scheduled end date.
* **Add New Campaign** — opens the new-campaign form described below.
**Campaign priority** — when a referral could qualify for more than one active campaign, the campaign with the highest priority is the one shown to the inviter. The acceptor's progress is still tracked against every matching campaign behind the scenes.
## 2. Referrals List
The referrals list is where staff review and act on individual referrals. Filters let staff narrow the list by date range, status, and campaign before deciding what action to take.
**Bulk actions:**
| Button | Behavior |
| - | - |
| **Pay Reward** | Sends the reward directly to the inviter's and acceptor's accounts. |
| **Mark as Paid** | Records a reward as paid without sending a transfer — use this when the reward was already paid outside the system. |
| **Download** | Exports the current filtered list as a CSV file for reporting. |
Each row also shows which account the reward goes to — by default, the inviter's and acceptor's primary checking account, unless the campaign specifies a different account type.
## 3. New Campaign Form
Campaign creation is the FI's main setup flow for launching a new referral program.
### Campaign fields
| Field | Notes |
| - | - |
| Name | A descriptive name for the campaign |
| Campaign Type | New Relationship or New Product |
| Creator/Promoter | Optional — limits code generation to a single member, used for ambassador or influencer campaigns. Leave blank for open campaigns. |
| Start Date / End Date | The window during which the campaign is active |
| Inviter Amount | Reward paid to the inviter; set to \$0 for acceptor-only promotions |
| Acceptor Amount | Reward paid to the acceptor |
| Completion Window (Days) | How many days after submission the acceptor has to meet all requirements |
| Payment Mode | Automatic, Manual, or Mark Paid Externally |
| Max Inviter Rewards | Optional cap on how many times a single inviter can be rewarded |
| Inviter/Acceptor Account Type | Which account type receives the reward (e.g., checking or savings) |
| Do Not Pay Codes | Promo codes that qualify the acceptor for a reward but never pay the inviter — used for influencer-distributed codes |
| Priority | Higher priority wins when a referral matches more than one campaign |
| Promo Code | Optional self-service code for FI promotions — rewards the acceptor only |
### Payment Mode options
| Mode | Behavior |
| - | - |
| Automatic | The reward pays out on its own as soon as all requirements are met |
| Manual | The reward waits for staff to click **Pay Reward** in the referrals list |
| Mark Paid Externally | The reward waits for staff to click **Mark as Paid** once it's been paid outside the system |
### Eligibility criteria
| Criterion | Input |
| - | - |
| Account | Required account type (default: Checking) |
| Balance | Minimum balance the acceptor must maintain during the completion window |
| Payroll | Minimum direct-deposit total (default: \$500) |
| Debit | Minimum number of qualifying debit card transactions (default: 5) |
Staff can combine these into whichever rule fits the campaign — for example, requiring the account and balance criteria together, or either payroll or debit activity.
Once submitted, the new campaign appears on the overview dashboard. Turning it on makes it live immediately, as long as it falls within its scheduled dates.
# Member Experience
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/banno/member-experience
This page walks through the end-to-end member journey for the Banno integration, screen by screen. The journey covers both roles:
* **Acceptor** (new member) — lands on the Banno dashboard, discovers the referral tile, submits a referral code, and tracks eligibility.
* **Inviter** (existing member) — shares a permanent personal code via email, text, or social media, and watches their "Joined" count grow as friends sign up.
Every screen below appears directly inside the member's Banno dashboard, without ever leaving the app.
## 1. Referral Tile — First Look
The referral tile sits on the Banno dashboard and changes based on where the member is in their referral journey:
| What the Member Sees | When It Appears |
| - | - |
| A banner inviting them to submit a referral code | They haven't entered a code yet |
| Their personal invite code, a "Joined" count, and an Invite Now button | They have their own code ready to share |
| "Click here to check eligibility status" | They've submitted a code and are working toward the reward |
| A confirmation that all requirements are met | The reward is ready to be paid |
| A note that the reward has been paid | The reward has already been paid out |
## 2. Submitting a Referral Code
After signing in through Banno, new members land on the full Refer-a-Friend page. They're shown a program description alongside a field to enter a referral code.
s
Referral codes are six characters long and are not case-sensitive. Behind the scenes, a few rules protect the program from misuse:
* The code must belong to a program that's currently running.
* A member can't refer themselves, even from a second account.
* A member can only submit one referral code per program.
* Two members can't refer each other using each other's codes at the same time.
Once a valid code is submitted, the member sees a confirmation message and their referral begins being tracked toward the reward.
## 3. Sharing a Referral
Existing members see their own permanent referral code (`1TUXR0` in the example) along with the reward amount, and can share it by:
* **Email** — sending an invite directly from within the app.
* **Social media** — sharing to Facebook, WhatsApp, or X, or copying a link to send however they like.
Each member's code is generated the first time they sign in and stays the same for every program they take part in.
## 4. Tracking Referrals
Members who have already shared their code see a running "Joined" count of how many friends have signed up using it, alongside the Invite Now button to keep sharing. If that same member also submitted someone else's code, a link to check their own eligibility status appears too.
## 5. Checking Reward Eligibility
New members can check their progress toward the reward at any time. This status page shows:
* The program name and current status (submitted, criteria met, ready to pay, paid, or expired).
* The deadline to complete all the requirements.
* A checklist of each requirement, marked as met or not yet met.
The checklist updates each time the member visits — as soon as a requirement is satisfied, it's reflected the next time they check.
## 6. Program Terms & Conditions
A terms and conditions page is available from both the sharing screen and the eligibility status page. It typically covers:
* Which account types qualify (for example, consumer checking only — HSAs are excluded).
* The good-standing requirement — no negative balances during the program period.
* Forfeiture if the referred member closes their account within six months.
* Rules against self-referral and other abuse of the program.
* Tax treatment — rewards are reportable on 1099 forms.
The wording is fully editable, so each FI can supply its own program-specific terms.
# Admin Guide
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/candescent/admin-console
The **RAF Admin Console** is a back-office web app for your institution's staff to manage the referral program. It gives you full visibility into campaigns, referrals, and rewards — all in one place, with no technical knowledge required.
Staff can create and edit campaigns, monitor how referrals are progressing, process reward payouts, and download reports — all from a simple web interface.
***
## Dashboard
The dashboard is the first thing staff see when they log in. It gives an at-a-glance summary of the entire referral program:
**Overview stats (top row)**
| Stat | What It Means |
| - | - |
| **Total Referrals** | Every referral ever submitted across all campaigns |
| **Submitted** | Referrals where the acceptor hasn't yet finished the qualifying activity |
| **Criteria Met** | Acceptors who have completed all the required activity — reward is ready to be paid |
| **Ready to Pay** | Referrals queued and confirmed for reward payout |
| **Paid** | Referrals where both the inviter and acceptor have received their rewards |
| **Expired** | Referrals where the eligibility window closed before criteria were met — no reward will be issued |
| **Members** | Total number of unique members who have a referral code |
**Campaigns table (bottom section)**
Below the stats, the dashboard lists all active and inactive campaigns. For each campaign you can see its name, type, priority, start and end dates, how much each party earns, and whether the campaign is currently live (the toggle on the right).
From here staff can click **Details** to view the full campaign, **Edit** to update dates or reward amounts, or **Add New Campaign** to create a new one.
***
## Referrals
The Referrals page shows every referral in the system with full details about both the inviter (who shared their code) and the acceptor (who submitted it).
**Filtering**
Staff can filter the list by date range, referral status, and campaign to zero in on exactly what they need to review or action.
**Referral table columns**
| Column | What It Shows |
| - | - |
| **Ready to Reward?** | Whether the acceptor has met all eligibility criteria and is cleared for payment |
| **Campaign** | Which active campaign this referral belongs to |
| **Inviter Name** | The member who shared their referral code |
| **Inviter Amount** | The reward amount the inviter will receive |
| **Acceptor Name** | The acceptor who submitted the referral code |
| **Acceptor Amount** | The reward amount the acceptor will receive |
| **Relationship Start Date** | When the acceptor opened their account |
| **OLB Enrollment Date** | When the acceptor first logged into digital banking |
| **Code Submit Date** | When the referral code was entered |
| **Inviter Code** | The unique referral code used for this referral |
| **Inviter Reward Status** | Whether the inviter's reward has been paid or is still pending |
**Paying rewards**
Staff can select one or more referrals using the checkbox on the left and then:
* **Pay Reward** — Sends the reward directly to both the inviter's and acceptor's accounts from the configured holding account
* **Mark as Paid** — Records the reward as paid manually, without triggering a transfer (useful if the payment was handled outside the system)
* **Download** — Exports the filtered list as a CSV for records or reporting
***
## Campaigns
The Campaigns section lets staff manage all referral campaigns for the institution.
Each campaign defines the rules of the program: who qualifies, what the acceptor needs to do to earn the reward, how much the inviter and acceptor receive, and how long the program runs.
**What you can do:**
* **Create a new campaign** — Set the campaign name, type, dates, reward amounts, and eligibility rules
* **Edit an existing campaign** — Update end dates or adjust reward amounts at any time; start dates can only be changed before the campaign begins
* **Enable or disable a campaign** — Use the status toggle to turn a campaign on or off without deleting it
***
## Transaction Report
The Transaction Report gives a paginated view of all reward transactions — every transfer that has been made from the FI's holding account to inviters and acceptors as part of the referral program.
Staff can filter by date range and download the full report as a CSV for reconciliation, auditing, or sharing with finance teams.
***
## Who Has Access
The admin console uses role-based access to control what different staff members can see and do:
| Role | What They Can Do |
| - | - |
| **Super Admin** | Full access — manage campaigns, process rewards, manage other admin users |
| **Admin** | Manage campaigns and process rewards |
| **Viewer** | Read-only — can view all data and download reports but cannot make changes |
# Member Experience
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/candescent/introduction
The **Refer a Friend (RAF)** program lets your existing members invite friends and family to join your financial institution — and rewards both of them when the acceptor gets started.
Everything is built into the Candescent digital banking experience, so members never leave your app to participate.
***
## How It Works
There are two roles in every referral:
**Inviter (your existing member)**
The inviter gets a unique referral code directly inside their digital banking dashboard. They can share it by email, text, or copy the link — however they prefer. Once shared, they can track how many people they've referred and when their reward is on its way.
**Acceptor (the person who joins)**
After joining and completing onboarding, the acceptor enters the referral code at login. From there, the app guides them through the steps needed to earn their reward — such as setting up a direct deposit or completing a few debit card purchases.
Once the acceptor completes those steps within the required timeframe, both parties are automatically rewarded. No paperwork, no manual review, no waiting on staff.
***
## Campaign Types
| Campaign Type | Who It's For | Who Gets Rewarded |
| - | - | - |
| **Refer a Friend** | Inviter shares their personal code with an acceptor | Both the inviter and acceptor |
| **FI Reward Campaign** | Financial institution runs a promotion for new acceptors | Acceptor only |
***
## Eligibility Requirements
Before rewards are paid out, the acceptor needs to meet a set of qualifying conditions. These are fully configurable per financial institution — each one can be turned on or off as needed.
Common eligibility requirements include:
* **Qualifying account** — The acceptor must open the right type of account (e.g., checking, not an HSA)
* **Direct deposit** — One or more direct deposits totaling a minimum amount within a set number of days
* **Debit card usage** — A minimum number of debit card purchases within the eligibility window
* **Account standing** — The account must remain in good standing (no negative balance)
* **Unique identity check** — The inviter and acceptor cannot be the same person
* **Eligibility window** — All requirements must be met within a configured number of days after the referral code is submitted
***
## Member Experience Overview
# FAQ
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/faq
This FAQ explains how the Refer-a-Friend reward program works day-to-day for FI staff (marketing, operations, and admin console users) managing it. It covers eligibility rules, how rewards get paid, and how to use the admin reporting tools.
## Program basics
> **What is this program?**
> An existing member (the *inviter*) shares a referral code. A new or existing member (the *acceptor*) submits that code, and if they meet the program's eligibility criteria within a set time window, both the inviter and acceptor can receive a reward.
>
> **What's the difference between a "New Relationship" campaign and a "New Product" campaign?**
>
> * **New Relationship campaigns** are the member-to-member referral program described above — one member invites another.
> * **New Product campaigns** are a separate campaign type your institution can run independently of any referral relationship (e.g., a new-product signup bonus). Whether each type is available to create is controlled by your program configuration (`CAN_CREATE_REFERAFRIEND_CAMPAIGN` / `CAN_CREATE_FI_REWARD_CAMPAIGN`).
## Eligibility
> **What makes an acceptor (new member) eligible for a reward?**
> All of the following must be true within the eligibility window (see below):
>
> 1. They open an account of an allowed type/product for the campaign.
> 2. They meet an activity requirement — either payroll direct deposit activity **or** debit card activity, depending on your `PAYROLL_DEBIT_CONDITION` setting:
> * Set to **OR**: either payroll deposits *or* debit card activity is enough.
> * Set to **AND**: both are required.
> 3. (If enabled) Their account does not have a negative balance.
>
> **What counts as qualifying payroll or debit activity?**
>
> * **Payroll**: a configurable minimum total in direct-deposit credits (default: \$500+), excluding deposits from restricted sources such as PayPal or Venmo.
> * **Debit card**: a configurable minimum number of qualifying debit transactions (default: 5+).
>
> **How long does the acceptor have to meet the criteria?**
> They have a configurable number of days (`DAYS_TO_MEET_CRITERIA`, default 360) from their relationship start date to meet the criteria above.
>
> **What happens if the window expires before they qualify?**
> The referral is automatically closed out — the acceptor is not rewarded, and it's silently excluded from further processing. No error is shown; the widget's help text explains this can happen if the completion window expired or the member never logged in to complete the qualifying activity.
>
> **Does the inviter have any eligibility requirements?**
> The inviter mainly needs an eligible account of their own to receive the reward into (`invtr_act_id`). Beyond that, their reward is primarily gated by the reward limit and skip-code rules below.
## Rewards & payment
> **How does the acceptor's/inviter's reward actually get paid?**
> There are two modes, controlled by the `IS_REWARD_AUTOMATICALLY_PAID` setting:
>
> * **Automatic** ("YES"): the moment eligibility is confirmed (checked whenever the member logs in), the reward is disbursed automatically — no admin action needed.
> * **Manual** ("NO", the default): eligible referrals appear in the admin console (GetReferralsCentral or InviteFriendConsole) for an admin to review and pay using the **"Pay Reward"** action, which triggers the actual fund transfer.
>
> **What's the difference between "Pay Reward" and "Mark as Paid" in the admin console?**
>
> * **Pay Reward** actually moves money — it initiates a real fund transfer to the inviter's and/or acceptor's account.
> * **Mark as Paid** does **not** move any money. It only flags the referral as paid in our records. Use this only when a reward was already paid outside the system (e.g., by check, or another manual process) and you need our reporting to reflect that.
>
> **Can the same referral get paid twice?**
> No. Before any payment attempt (automatic or manual), the system checks whether the inviter and/or acceptor already has a recorded reward transaction for that referral. If one side was already paid but the other wasn't (e.g., a prior attempt partially failed), only the unpaid side is processed — the already-paid side is left untouched. If both sides are already paid, no further payment is attempted at all. A referral marked "Mark as Paid" is also skipped by the automatic-payment flow.
>
> **Is there a limit on how many rewards one inviter can receive?**
> Yes, if `INVITER_REWARD_LIMIT_CHECK` is enabled — the inviter can earn up to `INVITER_REWARD_LIMIT_COUNT` rewards. Once they hit the limit, **their** reward is withheld and they see a configurable limit-reached message — but this does **not** affect the acceptor, who is still paid their reward normally.
>
> **Are there referral codes that never earn an inviter reward?**
> Yes — codes listed in `INVITER_CODES_TO_SKIP_REWARD` (e.g., internal or marketing-distributed codes) always pay \$0 to the inviter, even if every other criterion is met.
## Reporting & admin tools
> **Where do I review and manage referrals?**
> In the admin console — either the classic GetReferralsCentral page or the newer InviteFriendConsole. Both let you:
>
> * Search/filter referrals by date range and status (**All / Not Paid / Paid**).
> * View inviter/acceptor name, account, reward amount, and reward status for each referral.
> * See whether the criteria-completion window has expired for a given referral.
> * Pay a reward or mark one as paid.
> * Manage campaigns (create, edit, view active campaigns).
>
> **Do we get a regular report of referral activity?**
> Yes — a monthly email report is sent automatically (covering the previous calendar month) to the configured admin recipients (`REFERRAL_REPORT_ADMIN_EMAIL_IDS`), with a CSV of that period's referrals attached. If there was no referral activity that month, a "no data" notice is sent instead.
## Troubleshooting
> **A member says they should be eligible but the widget doesn't show it — what should I check?**
>
> * Confirm their account was opened within the criteria-completion window (`DAYS_TO_MEET_CRITERIA`) of their relationship start date.
> * Confirm the account type/product is one your campaign allows.
> * Confirm they meet the payroll/debit activity requirement (and whichever combination — AND/OR — your campaign requires).
> * Check whether `NEGATIVE_BALANCE_CHECK` is blocking them due to a negative balance.
> * Check the admin console to see if their referral shows as expired.
>
> **A referral shows as eligible but hasn't been paid — why?**
>
> * If `IS_REWARD_AUTOMATICALLY_PAID` is off, it's waiting for an admin to trigger **Pay Reward** in the console.
> * If automatic payment is on, it's re-checked and retried on the member's next login — a transient failure (e.g., a temporary transfer error) will be retried rather than silently dropped, but only for the side (inviter/acceptor) that hasn't yet succeeded.
> * Check whether the inviter has hit their reward limit — that only withholds the inviter's portion, not the acceptor's.
>
> **Why does the report show "Not Paid" for something I already paid manually outside the system?**
> Use **Mark as Paid** in the admin console for that referral — it updates the reported status without attempting a duplicate transfer.
# Overview
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/overview
Refer a Friend is a fully automated referral program that helps financial institutions grow deposits by turning existing account holders into advocates. The platform handles everything from invitation through reward distribution — no manual tracking or staff follow-up required.
## How It Works
Account holders share a personal referral link or code via email, text, or social media. When a referred person signs up and completes the qualifying activity, the system automatically tracks their progress and dispenses the reward.
The qualifying activity is fully configurable — common triggers include:
* Opening a specific account type
* Completing a minimum number of debit card transactions per month
* Meeting a deposit threshold
* Any other custom-defined criteria
## Types of Campaigns
The type of campaign determines when the referral code popup prompt is displayed.
**NewRelationshipCampaign**
The goal is to acquire new customers from existing customer referrals. The referral code popup prompt is displayed on login for new users.
**NewProductCampaign**
The goal is to open new accounts from the FI's marketing efforts (from new or existing customers). The acceptor clicks a button to enter the referral code.
## Key Features
**Automated reward dispensation**
A daily job checks qualifying activity and issues rewards automatically, with no manual intervention needed.
**Self-service progress tracking**
Referred users can monitor their own progress toward the reward from within online banking.
**Gamification**
Dynamic banners and referral count displays keep existing customers engaged and motivated to refer more.
**Back-office management**
Full control through Q2 Central/Console, including reporting, manual payout overrides, and campaign configuration.
**Compliance built in**
Terms acceptance checkboxes are included in the referral flow out of the box.
## Who It's For
Refer a Friend is built for banks and credit unions that want to grow deposits and new relationships through word-of-mouth — without adding operational overhead or running manual campaigns.
## Business Impact
| Outcome | What to Expect |
| - | - |
| Deposit growth | New relationships and account openings driven by existing customers |
| Acquisition cost | Lower cost per acquisition compared to paid marketing channels |
| Engagement | Gamification keeps referrers active and motivated throughout the campaign |
| Operations | Zero manual tracking — rewards are calculated and distributed automatically |
## How It's Delivered
Refer a Friend is available on the **Q2 Marketplace** and integrates directly with Q2 Central/Console for back-office management. Configuration covers campaign type, qualifying activity rules, reward amounts, messaging, and disclosures.
## Definitions
**Inviter**
Existing user who referred a friend to the FI.
**Acceptor**
New customer who accepts a referral.
**ReferralCode**
Each campaign has a unique referral code for each inviter.
**DepositAccount**
Checking, savings, etc.
**CampaignStartDate**
Start date of a campaign.
**CriteriaCompletionWindowLength**
Number of days in which the new user must fulfill the criteria. The default window length is 60 days.
**CampaignType**
Type of campaign. Values are `NewRelationshipCampaign` and `NewProductCampaign`.
For a `NewRelationshipCampaign`:
* **OLBEnrollmentDate** — date the user enrolled in digital banking (Q2 user creation date).
* **DepositAccountOpenDate** — for each deposit account, the date the account was opened. This uses the Q2 SDK if the account open date is available from it; otherwise, a file is obtained from the FI listing all current account holders and each deposit account the user has open. The day before a campaign starts, a script runs that records each open account and the current date as the `DepositAccountOpenDate` in the Q2 user table.
* **OldestDepositAccountOpenDate** — for each user, the oldest `DepositAccountOpenDate`.
* **RelationshipStartDate** — the older of the `OldestDepositAccountOpenDate` and the `OLBEnrollmentDate`.
* **CriteriaCompletionWindow (CCW)** — the period that starts with the `RelationshipStartDate` and ends after `CriteriaCompletionWindowLength`.
For a `NewProductCampaign`:
* **IncentivizedProductCode** — the incentivized product code that the FI rewards customers for opening.
* **IncentivizedProductOpenDate** — the open date of the first account with the `IncentivizedProductCode`.
* **CriteriaCompletionWindow (CCW)** — the period that starts with the `IncentivizedProductOpenDate` and ends after `CriteriaCompletionWindowLength`.
**RewardDepositAccount (RDA)**
A valid checking account that will receive the inviter's or acceptor's reward. It cannot be an HSA checking account, and it cannot be used by more than one acceptor.
**DoNotPayInviterReferralCodes**
Used when the FI is the inviter. A configurable list of referral codes that instruct the app not to pay a reward to the inviter when their referral code is used by an acceptor.
## Earning a Reward
### Acceptor
The acceptor must enter a valid referral code within the CriteriaCompletionWindow.
The referral code popup displays if all of these requirements are met:
* For a `NewRelationshipCampaign`, the `RelationshipStartDate` is after the `CampaignStartDate`.
* For a `NewProductCampaign`, the `IncentivizedProductOpenDate` is after the `CampaignStartDate`.
* The user has not answered no and submitted the popup.
* A referral code has not already been submitted within the CriteriaCompletionWindow.
* The current date is within the CriteriaCompletionWindow.
A referral code is accepted if both of these requirements are met:
* The acceptor's SSN does not have access to any other deposit account opened before the `CampaignStartDate`.
* The code is valid.
The acceptor must complete the acceptor requirements within the CriteriaCompletionWindow. These are checked:
* On each subsequent login after a valid code is submitted. (This is not checked at the time the code is submitted, because the check can take a while, and it would be a rare edge case for a user to have already met all the criteria by the time they enter the code.)
* When the user clicks to view their eligibility status.
**Acceptor requirements:**
* Have a `RewardDepositAccount`.
* Complete one of the following:
* **Payroll** — accumulate payroll deposits totaling at least \$500. Restricted payment sources (PayPal, Zillow, Venmo, Klarna, Zelle, Cash Award, Cash ID, Cash App) do not count.
* **Debit card** — complete at least 5 debit card transactions.
* Log into digital banking *after* meeting the above criteria.
The acceptor must not have a negative balance at this time to qualify for the reward. If there is a negative balance, "Has a negative balance" is marked "Yes" and "Ready to pay?" is marked "No" — the checkbox to pay the reward is also disabled.
The acceptor can receive only one reward during the campaign period. This eliminates multiple rewards for the same checking account in the case of joint account holders.
**Code prompt popup messages:**
| Scenario | Message |
| - | - |
| Acceptor already submitted the referral code through one account and attempts to use it with another | "You have already submitted a referral code in another Digital Banking account. The code can only be submitted in one account." |
| Acceptor has multiple digital banking accounts with the same SSN | "You are not eligible for the referral program as you already have a Digital Banking account." |
| A referral code that has not been issued is submitted | "Invalid referral code" |
| Acceptor enters their own referral code | "Invalid referral code" |
| An invalid code is entered (too long or incorrect characters) | "Invalid referral code" |
| Acceptor submits a valid code | "Thank you for submitting the referral code" |
### Inviter
The inviter's referral code must not be in `DoNotPayInviterReferralCodes`.
The inviter must have a `RewardDepositAccount` by the expiration of the CriteriaCompletionWindow.
## Report Legend
**(\*)**
When the acceptor submits the code, the Host ID shows `*` until the acceptor logs into their account again or clicks the eligibility link. If a `RewardDepositAccount` is not found, it remains `*` until one is found or the CriteriaCompletionWindow expires.
**N/F — Not Found**
The Host ID is marked `N/F` if a `RewardDepositAccount` is not found when the CriteriaCompletionWindow expires.
**N/A — Not Applicable**
The Host ID is marked `N/A` if the inviter's referral code is found in `DoNotPayInviterReferralCodes`.
# Admin Guide
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/q2/admin-guide
Administrators manage the Refer a Friend program through a dedicated console within Q2 Digital Banking. This guide covers campaign setup, referral tracking, reward processing, and transaction reporting.
## Campaign Management
Campaigns define when the referral program is active, who receives rewards, and how much they receive.
### Creating a Campaign
1. Navigate to the **Campaigns** section of the admin console.
2. Click to create a new campaign and provide the following:
| Field | Description |
| - | - |
| Campaign Name | A unique identifier for the campaign (e.g. `SPRING2025`). Maximum 15 characters. |
| Campaign Type | `New Relationship Campaign` or `New Product Campaign` |
| Start Date / End Date | The date range during which referrals are accepted |
| Inviter Reward Amount | Dollar amount paid to the referring member |
| Acceptor Reward Amount | Dollar amount paid to the new member |
| User ID | User ID associated with the campaign |
3. Only one campaign should be active at a time. Campaigns can be enabled or disabled at any time without being deleted.
> **Note:** A campaign can only be edited before its start date. Once a campaign has started, its configuration is locked.
### Types of Campaigns
The campaign type determines when and how the referral code submission prompt is presented to the user.
#### New Relationship Campaign
The goal of this campaign is to acquire new customers through referrals from existing customers.
* The referral code submission prompt is automatically displayed when a new user logs in for the first time.
* The user can submit a referral code during the onboarding process.
* This campaign is intended for users who are establishing a new relationship with the financial institution.
#### New Product Campaign
The goal of this campaign is to encourage the opening of new accounts or products through the financial institution's marketing efforts, whether the user is a new or existing customer.
* The referral code submission prompt is not displayed automatically on login.
* The acceptor must click the **Submit Referral Code** button to enter their referral code.
* This campaign is intended for users opening a new qualifying account or product after enrollment.
### Managing Campaigns
All campaigns are listed in the console with their status, date range, and reward amounts. Use the toggle next to any campaign to disable it before its end date without deleting it.
## Referral List and Search
The Referral List page shows all referrals submitted under active and past campaigns.
By default, the list displays referrals from the past 7 days. Administrators can filter by:
* **Date range** — narrow results to a specific period
* **Reward status** — filter by `Not Paid` or `Paid`
* **Member search** — search by member name or account ID
Each row shows the inviter's name, the new member's name, the referral code used, reward amounts for each party, and the current reward status for both.
## Reward Processing
Rewards are processed from the Referral List page once referrals are eligible for payout.
1. Select the date range and transaction status to surface eligible referrals.
2. The system verifies each party before disbursing a reward.
For the **inviting member**, the system checks:
* Holds an eligible account type
* Has not exceeded the configured reward limit (e.g. maximum 10 rewards per year)
* Is not on the administrator-defined skip list
For the **new member**, the system checks:
* Holds an eligible account type
* Account was opened within the campaign date range
* Has satisfied all eligibility criteria
* Account balance is non-negative
3. Select the referrals to process and confirm the payout.
4. The system transfers funds from the reward holding account to each party's account and records the transaction ID.
5. Reward statuses update to **Paid**. Failed transactions are flagged for manual review.
> **Note:** Rewards can also be marked as Paid manually by an administrator without initiating a fund transfer — for example, when a reward was issued outside the system.
## Transaction Report
The Transaction Report page provides a full history of all reward transactions across campaigns.
By default it shows the past 7 days across all active campaigns. Use the date range filter and **Campaign** dropdown to narrow results, then click **Search** to update the table.
The table includes: transaction ID, date, user information, campaign name, amount, and status. Pagination controls and a per-page record count let you navigate large result sets. Use the **Download** button to export the filtered data as a CSV file for reporting, auditing, or sharing.
# Member Experience
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/q2/member-experience
The Refer a Friend program surfaces in multiple places within digital banking to maximize visibility. Members can share their referral code with friends, and referred individuals can submit the code when they first log in — all without leaving the app.
## Program Surfaces
The referral experience can appear in the following locations depending on how your institution configures the program.
### Sidebar Widget
The referral widget sits in the right panel of the application dashboard, giving members direct access to the program at a glance. It shows the referral offer, a call-to-action to share, and a running count of successful referrals.
### Full-Width Landing Page
The referral experience can also be presented as a dedicated full-width page within digital banking. Members who have already submitted a referral code can check their reward eligibility status from this view via the **Check Eligibility Status** action.
### Composable Dashboard Card
The referral program can appear as a card within the composable dashboard alongside other features. The card provides a quick entry point and includes a call-to-action to share a referral or check eligibility status.
### Smart Ads
The referral experience can also be promoted through Smart Ads — contextual banners, pop-ups, or inline cards that appear within digital banking to guide members into the program.
## Sharing a Referral
When a member taps or clicks the referral widget, the sharing experience adapts to their device.
### Mobile
On mobile, the device's native share sheet opens with a pre-filled message containing the referral code, the institution's name, and a sign-up link. The member can share directly to any app or contact.
### Desktop
On desktop, a referral form opens in a panel within digital banking. The member can send the referral via email or other available channels from within the panel.
The widget also shows the member a running count of how many friends they have successfully referred to date.
## Submitting a Referral Code
When a referred individual logs into digital banking for the first time, the system checks whether a referral code prompt should be shown based on the following conditions:
* An active campaign is currently running
* The new member's account was opened within the campaign's date range
* The member has not already submitted a referral code for this campaign
* The submission window (configured in days) has not yet expired
If all conditions are met, a prompt appears asking whether the new member was referred by someone.
* Selecting **Yes** reveals a text field to enter the referral code
* Selecting **No** dismisses the prompt permanently — the member will not be prompted again
* Selecting **Remind Me Later** hides the prompt for the current session and shows a button to reopen it
After a valid code is submitted, the member sees a confirmation page.
## Checking Eligibility Status
After submitting a referral code, the new member can track their progress toward the reward on a dedicated eligibility status page. This page is accessible via the **Check Eligibility Status** button that appears on the referral widget following a successful submission.
The eligibility status page displays:
* Each eligibility criterion and whether it has been completed
* The number of days remaining to meet all criteria
* The reward amount the member will receive upon completion
If one or more criteria are not yet satisfied, a warning message is shown indicating what still needs to be completed.
# Release Notes
Source: https://docs.nuevesolutions.com/guides/products/refer-a-friend/q2/release-notes
## V1.4.2 — September 22, 2026
### Fixed
* Fixed the referral code submission date format issue in the eligibility check for Direct Deposits and Debit Card Transactions for the New Product Type Campaign.
* Fixed the criteria window expiry calculation issue for the New Product Type Campaign.
## V1.4.1 — September 15, 2026
### Fixed
* Prevented duplicate reward payments when the FI has already processed the payment internally and marked the reward as Paid.
* Prevented duplicate reward payments after the acceptor's eligibility has been confirmed and the FI manually processes the payment through the Q2 Back Office, including scenarios where the acceptor logs into Online Banking again.
* Prevented duplicate reward payments in scenarios involving multiple concurrent logins or simultaneous payment requests.
## V1.4.0 — July 14, 2026
### Added
* Upgraded the Refer a Friend application to the latest Q2 SDK version as requested by the Q2 team.
* Added a Submit Referral Code button to the InviteFriend extension landing page for both mobile and desktop when the campaign type is New Product and the user accesses the page directly through the InviteFriend extension URL.
* Made the Eligibility Status Check page title and the "You have not submitted a referral code. Please return to the previous menu to submit your referral code." message configurable so they can be displayed dynamically for all campaign types when a user accesses the page through the InviteFriendEligibility extension URL without first submitting a referral code.
## V1.3.1 — July 1, 2026
### Added
* Added a Joined Count feature to the Composable Dashboard widget (3-column layout).
* Added the capability to display a different image on the Smart Ads landing screen for mobile devices. Also added a Back to Home button to improve the user experience and provide easy navigation back to the main page.
### Fixed
* Fixed the responsive design issues in the Composable Dashboard widget and added the capability to use separate images for the before-code-submission and after-code-submission states. This allows different graphics to be displayed based on the user's referral status.
* Identified and fixed the issues in the automatic reward payment process to ensure rewards are processed correctly when all eligibility criteria are met.
## V1.3.0 — May 21, 2026
### Added
* Implemented support for loading the Share widget in the Composable Dashboard.
* Added functionality to support Smart Ads.
* Added configurable whitelisting for payment types used in direct deposits and debit card transactions. Default behavior remains blocklisted.
### Fixed
* Fixed the issue to ensure the popup is not shown to existing users whose Relationship Start Date is before the campaign start date in New Relationship Campaign.
* Fixed the issue where the inviter reward limit count was not updated during Mark as Paid. This optional functionality works only for FIs with the Inviter Reward Limit enabled.
### Changed
* Introduced configuration options for inviter reward limits based on either campaign-wise or calendar year–wise settings. If not configured, the default remains an unlimited reward amount for inviters.
## V1.2.0 — March 3, 2026
### Added
* Introduced Q2 Secure Message delivery of the previous month's report to configured email addresses on a specified date. This feature enables recipients to receive a detailed report similar to the downloadable report available in Q2 Central/Q2 Console. By default, this feature is disabled.
* Introduced Q2 Console access (replicating Q2 Central functionality). Q2 Central will be deprecated in future releases.
* Implemented a feature to restrict the inviter reward amount according to the configured inviter limit. By default, the reward amount for inviters was unlimited.
### Fixed
* Changed inviter eligibility window. Once the acceptor is paid, the inviter eligibility is no longer checked.
### Changed
* Updated and refined the Acceptor Eligibility status check screen design to improve clarity and usability.
## V1.1.1 — November 26, 2025
### Fixed
* Fixed an issue where acceptors encountered an error when submitting a referral code, specifically when the inviter had selected "No" in the popup. In these cases, the popup incorrectly displayed: "Something went wrong with Q2 (InviteFriend update\_popup status)".
## V1.1.0 — September 21, 2025
### Added
* Added support for creating a New Product Campaign — the goal is to open new accounts from FI marketing efforts (from new or existing customers).
* Added new criteria for reward eligibility: the acceptor must not have a negative balance in order to qualify for the reward.
* Full Automation: once automated payments are set up and the acceptor meets all eligibility criteria, the Refer a Friend app will automatically initiate transactions for both the inviter and the acceptor without delay.
* Added a wedge configuration (`DISPLAY_REFERRAL_CODE_SHARE_WIDGET`) to enable or disable the "Invite Now" banner.
### Fixed
* Fixed the Reward Target Account (RTA) determination timing: the RTA for both the Inviter and Acceptor is now determined only after the Acceptor meets all qualifying criteria, rather than being stored for the Inviter the first time they log in after the campaign start date.
* Fixed an issue with Q2 SDK account mapping: the SDK returns accounts as a list when the user has multiple accounts and as a dict when they have only one. The dict mapping now handles this correctly.
* Fixed the referral loading timeout issue in Q2 Central.
* Fixed the issue where the Q2 SDK was throwing a KeyError when the acceptor did not have a date of birth.
* Fixed the mutual referral code submission issue: if both the acceptor and inviter use each other's codes, only one submission is accepted. The second user's submission will be rejected.
## V1.0.1 — April 29, 2025
### Fixed
* Fixed handling of transactions that do not have a HostTranCode. Symptoms of this bug included the "Acceptor Reward Host Account ID" column not updating properly, and the "Ready to Reward" column not updating properly when the debit card transactions requirement was satisfied.
* Changed eligibility status page link color to black to improve readability.
* Fixed a reward transfer bug that occurred when the user login name was of type integer rather than the expected type string.
* Fixed the "Mark as Paid" issue that occurs when the acceptor or inviter has special characters in their first or last name.
## V1.0.0 — January 1, 2025
### Features
Financial institutions (FIs) can:
* Create new campaigns with a start and end date.
* Offer rewards for each campaign.
* Define Acceptor Eligibility criteria.
* Define Inviter Eligibility criteria.
* Set up an expiration window for the criteria.
An online user (Inviter) can invite friends to open an account via text message, email, and social media platforms. Every online user will have a unique referral code, which they can share through any media.
# CD Closure
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/manage-certificates/cd-closure/index
## Closing and Transferring a Certificate
### Step 1 — Certificate of Deposit Closure Options
The closure screen shows the selected certificate at the top and a **Close and transfer to another account** form below. Fill in:
* **Select account** — choose where the balance will be transferred (internal or external account)
* **Reason for closing** — select from available options (e.g. "Reached my savings goal")
* **Transfer amount** — pre-filled with the full current balance; edit if a partial transfer is needed
### Step 2 — Fill in your transfer details
Select the destination account and a reason for closing. The full balance is pre-populated in the transfer amount field.
Click **Submit** when ready.
### Step 3 — Internal Transfer Authorization
A **Internal Transfer Authorization** modal appears showing a summary of the transfer:
| Field | What it shows |
| - | - |
| Certificate | The certificate being closed |
| Amount | Balance being transferred |
| Account Number | Masked destination account number |
| Transfer Date | The date the funds will be available |
Click **Submit** to complete the closure, or **Cancel** to go back.
### Step 4 — Success
A **Success** confirmation modal confirms the certificate has been closed and the balance transferred.
The confirmation shows:
* Effective Date
* Transferred to Account
* Amount Transferred
Click **Close** to return to the dashboard. The closed certificate will no longer appear in the CD list.
**Warning**
Closing a certificate before its maturity date may result in an early withdrawal penalty. The institution's terms and conditions apply. Review your certificate's maturity date before proceeding.
# CD Dashboard
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/manage-certificates/cd-dashboard/index
## Your Certificate of Deposit Dashboard
When a customer opens the CD management section, the **Certificate of Deposit Management** screen shows every CD account they hold. Each certificate card displays:
* Certificate term (e.g. 6 Month, 9 Month, 12 Month Certificate)
* Account Number
* Current Balance
* Maturity Date
* APY (Annual Percentage Yield)
* Interest Rate
Click **Manage** on any certificate to see the available options for that account.
## Certificate of Deposit Options
After clicking **Manage**, the **Certificate of Deposit Options** screen appears. It shows the selected certificate's details at the top and two action choices below:
* **Renew certificate** — renew at the same or a different term at today's published rate
* **Close and transfer to another account** — close the certificate and move the balance to another account
Click **Select** under the action you want.
# CD PreClosure
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/manage-certificates/cd-preclosure/index
## Scheduling a CD Closure before Maturity
CD PreClosure allows you to schedule your CD to close and transfer the balance to another account before it reaches maturity. By default, every CD is automatically set to renew to the same term. With CD PreClosure, you can set a closure in advance — so your CD automatically closes and transfers the balance when it matures.
From the **CD Maturity Options** screen, click **Select** under **Close and transfer at maturity**. You will be taken to the closure options screen where you can select the account you want the balance transferred to after the maturity date. Once you select an account and submit, your CD is scheduled to automatically close and transfer the balance to that account when it matures.
Once confirmed, the CD Maturity Options screen updates to reflect the scheduled closure and the destination account.
# CD Prerenewal
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/manage-certificates/cd-prerenewal/index
## Scheduling a CD Renewal before Maturity
CD Prerenewal allows you to schedule your CD to renew to a different term before it reaches maturity. By default, every CD is automatically set to renew to the same term. With CD Prerenewal, you can select a new term in advance — so your CD automatically renews to that term when it matures.
From the **CD Maturity Options** screen, click **Select** under **Renew CD at maturity**. You will be taken to the renewal options screen where you can select the term you want your CD to renew to after the maturity date. Once you select a term and submit, your CD is scheduled to automatically renew to that term when it matures.
Once confirmed, the CD Maturity Options screen updates to reflect the newly scheduled renewal term.
# CD Renewal
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/manage-certificates/cd-renewal/index
## Renewing a Certificate
### Step 1 — Certificate of Deposit Renewal Options
The renewal screen shows the selected certificate at the top. There are two sections:
**Add or withdraw funds from certificate** (left panel)
* Choose **Add funds** or **Withdraw funds** using the radio buttons
* Select a funding account from the dropdown
* Enter a funding amount
**Renew certificate** (right panel)
* Select a new term from the **Term options available** dropdown (e.g. 9 Months)
* The rate and APY for that term appear automatically once a selection is made
* Click **View Current Rates** to see all available rates before deciding
### Step 2 — Fill in your preferences
Select your funding account, enter an amount, and pick a term. The rate and APY populate automatically on the right once a term is selected.
Click **Submit** when ready.
### Step 3 — Transfer Authorization
A **Transfer Authorization** modal summarises the transaction before anything is submitted. Review the details carefully:
| Field | What it shows |
| - | - |
| Certificate | The term and name of the renewed certificate |
| Account Number | The certificate's account number |
| APY | Annual percentage yield for the new term |
| Interest Rate | Interest rate for the new term |
| Funding Amount | The amount being added or withdrawn |
| Funding Account | The masked account number of the source |
Click **Submit** to confirm, or **Cancel** to go back and make changes.
### Step 4 — Success
A **Success** confirmation modal confirms the renewal. It shows the final account details:
* Account Number
* Effective Date
* APY
* Interest Rate
* Balance
Click **Close** to return to the CD dashboard. The dashboard will refresh automatically to reflect the updated account.
**Note**
After a successful renewal, an alert notification confirmation is sent to the customer.
# Overview
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/overview
## What Is Self-Service CDs?
Self-Service CDs lets customers open, manage, and close Certificates of Deposit entirely within online banking — no branch visit, no phone call, no waiting. Everything appears directly inside the online banking dashboard.
## What Customers Can Do
There are two main areas:
**Open an Account** — start a new deposit account:
* Open a new Certificate of Deposit from available terms (6, 9, or 12 months)
* Open a Checking account (Free, Interest Bearing, or Premium)
* Open a Savings account
* Open a Money Market account
* Fund the new account from any existing internal account
**Manage Certificates** — for existing CD accounts:
* View all current CDs with live balance, maturity date, APY, and interest rate
* Renew a certificate at the same or a different term at today's published rate, with the option to add or withdraw funds at the same time
* Close and transfer a certificate balance to any internal or external account
## How to Access It
Customers find the CD widget inside their online banking dashboard. Depending on how the institution has configured the navigation, it typically appears under **Accounts**, **Products**, or as a dedicated **CD Management** tile. There is nothing to install or download — the experience is fully embedded.
## What to Expect
Every action follows the same pattern:
1. Review the account details shown at the top of the screen
2. Fill in your preferences (term, funding account, amount)
3. Review a Transfer Authorization or confirmation modal showing the exact details before anything is submitted
4. Receive a **Success** confirmation with your new account number, effective date, APY, and transferred amount
If something goes wrong — for example, if your funding account does not have enough balance — an error message is shown and no transaction is submitted.
## Open an Account
* [Open an Account](./q2/open-account) — Open a new CD, Checking, Savings, or Money Market account, step by step with screenshots.
## Manage Existing Certificates
* [Manage Certificates](./manage-certificates) — Renew or close an existing CD, step by step with screenshots.
## Manage Beneficiaries
* [Manage Beneficiaries](./q2/manage-beneficiaries) — Add or remove a beneficiary on an eligible account, step by step with screenshots.
# Manage Beneficiaries
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/q2/manage-beneficiaries
## Overview
Use **Manage Beneficiaries** to add or remove beneficiaries for eligible accounts. A beneficiary is a person you designate to inherit assets on the account.
To access this flow, open **Account Options** and click **Manage** under **Manage Beneficiaries**.
## Add a Beneficiary
### Step 1 - Select an account
On the **Manage Beneficiaries** screen, click **Add Beneficiary** next to the account you want to update.
### Step 2 - Enter beneficiary details
Complete all required fields on **Add Beneficiary Information**:
* First Name
* Last Name
* Social Security Number (SSN)
* Date of Birth (DOB)
* Relationship
Click **Next**.
### Step 3 - Confirm and submit
Review the summary on **Confirm Beneficiary Information** and click **Confirm Beneficiary**.
### Step 4 - Success
After submission, a success modal confirms the beneficiary was added.
## Remove a Beneficiary
### Step 1 - Locate the beneficiary
On the **Manage Beneficiaries** screen, expand the account and find the beneficiary card you want to remove.
### Step 2 - Confirm removal
Click **Remove** on the beneficiary card. In the **Remove Beneficiary** modal, review the beneficiary details and click **Remove Beneficiary**.
### Step 3 - Success
A success modal confirms the beneficiary was removed.
**Note**
Removing a beneficiary is permanent. To add that person again later, complete the Add Beneficiary flow again.
# CD Closure
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/q2/manage-certificates/cd-closure/index
## Closing and Transferring a Certificate
### Step 1 — Certificate of Deposit Closure Options
The closure screen shows the selected certificate at the top and a **Close and transfer to another account** form below. Fill in:
* **Select account** — choose where the balance will be transferred (internal or external account)
* **Reason for closing** — select from available options (e.g. "Reached my savings goal")
* **Transfer amount** — pre-filled with the full current balance; edit if a partial transfer is needed
### Step 2 — Fill in your transfer details
Select the destination account and a reason for closing. The full balance is pre-populated in the transfer amount field.
Click **Submit** when ready.
### Step 3 — Internal Transfer Authorization
A **Internal Transfer Authorization** modal appears showing a summary of the transfer:
| Field | What it shows |
| - | - |
| Certificate | The certificate being closed |
| Amount | Balance being transferred |
| Account Number | Masked destination account number |
| Transfer Date | The date the funds will be available |
Click **Submit** to complete the closure, or **Cancel** to go back.
### Step 4 — Success
A **Success** confirmation modal confirms the certificate has been closed and the balance transferred.
The confirmation shows:
* Effective Date
* Transferred to Account
* Amount Transferred
Click **Close** to return to the dashboard. The closed certificate will no longer appear in the CD list.
**Warning**
Closing a certificate before its maturity date may result in an early withdrawal penalty. The institution's terms and conditions apply. Review your certificate's maturity date before proceeding.
# CD Dashboard
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/q2/manage-certificates/cd-dashboard/index
## Your Certificate of Deposit Dashboard
When a customer opens the CD management section, the **Certificate of Deposit Management** screen shows every CD account they hold. Each certificate card displays:
* Certificate term (e.g. 6 Month, 9 Month, 12 Month Certificate)
* Account Number
* Current Balance
* Maturity Date
* APY (Annual Percentage Yield)
* Interest Rate
Click **Manage** on any certificate to see the available options for that account.
## Certificate of Deposit Options
After clicking **Manage**, the **Certificate of Deposit Options** screen appears. It shows the selected certificate's details at the top and two action choices below:
* **Renew certificate** — renew at the same or a different term at today's published rate
* **Close and transfer to another account** — close the certificate and move the balance to another account
Click **Select** under the action you want.
# CD PreClosure
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/q2/manage-certificates/cd-preclosure/index
## Scheduling a CD Closure before Maturity
CD PreClosure allows you to schedule your CD to close and transfer the balance to another account before it reaches maturity. By default, every CD is automatically set to renew to the same term. With CD PreClosure, you can set a closure in advance — so your CD automatically closes and transfers the balance when it matures.
From the **CD Maturity Options** screen, click **Select** under **Close and transfer at maturity**. You will be taken to the closure options screen where you can select the account you want the balance transferred to after the maturity date. Once you select an account and submit, your CD is scheduled to automatically close and transfer the balance to that account when it matures.
Once confirmed, the CD Maturity Options screen updates to reflect the scheduled closure and the destination account.
# CD Prerenewal
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/q2/manage-certificates/cd-prerenewal/index
## Scheduling a CD Renewal before Maturity
CD Prerenewal allows you to schedule your CD to renew to a different term before it reaches maturity. By default, every CD is automatically set to renew to the same term. With CD Prerenewal, you can select a new term in advance — so your CD automatically renews to that term when it matures.
From the **CD Maturity Options** screen, click **Select** under **Renew CD at maturity**. You will be taken to the renewal options screen where you can select the term you want your CD to renew to after the maturity date. Once you select a term and submit, your CD is scheduled to automatically renew to that term when it matures.
Once confirmed, the CD Maturity Options screen updates to reflect the newly scheduled renewal term.
# CD Renewal
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/q2/manage-certificates/cd-renewal/index
## Renewing a Certificate
### Step 1 — Certificate of Deposit Renewal Options
The renewal screen shows the selected certificate at the top. There are two sections:
**Add or withdraw funds from certificate** (left panel)
* Choose **Add funds** or **Withdraw funds** using the radio buttons
* Select a funding account from the dropdown
* Enter a funding amount
**Renew certificate** (right panel)
* Select a new term from the **Term options available** dropdown (e.g. 9 Months)
* The rate and APY for that term appear automatically once a selection is made
* Click **View Current Rates** to see all available rates before deciding
### Step 2 — Fill in your preferences
Select your funding account, enter an amount, and pick a term. The rate and APY populate automatically on the right once a term is selected.
Click **Submit** when ready.
### Step 3 — Transfer Authorization
A **Transfer Authorization** modal summarises the transaction before anything is submitted. Review the details carefully:
| Field | What it shows |
| - | - |
| Certificate | The term and name of the renewed certificate |
| Account Number | The certificate's account number |
| APY | Annual percentage yield for the new term |
| Interest Rate | Interest rate for the new term |
| Funding Amount | The amount being added or withdrawn |
| Funding Account | The masked account number of the source |
Click **Submit** to confirm, or **Cancel** to go back and make changes.
### Step 4 — Success
A **Success** confirmation modal confirms the renewal. It shows the final account details:
* Account Number
* Effective Date
* APY
* Interest Rate
* Balance
Click **Close** to return to the CD dashboard. The dashboard will refresh automatically to reflect the updated account.
**Note**
After a successful renewal, an alert notification confirmation is sent to the customer.
# Open an Account
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/q2/open-account
## Account Opening Overview
From the CD management section, customers can open new deposit accounts without leaving online banking. Four account types are available:
* **Certificate of Deposit (CD)** — fixed-term savings with a guaranteed rate and APY
* **Checking** — everyday transaction accounts with no or minimal fees
* **Savings** — basic interest-bearing savings accounts
* **Money Market** — higher-minimum accounts with competitive rates
Select the account type you want to open from the options page. Each flow follows the same pattern: choose a product, fund it from an existing account, authorize the transfer, and receive a confirmation.
***
## Opening a Certificate of Deposit
### Step 1 — Select a CD term
The **Certificate of Deposit Account Types** screen lists all available CD terms along with their APY, interest rate, and minimum balance. Click **Open** on the term you want to open.
### Step 2 — Fund your new CD
The **Certificate of Deposit Open Options** screen displays the selected CD details at the top. In the **Fund your new certificate of deposit** section:
* **Select funding account** — choose the source account from the dropdown
* **Funding amount** — enter the amount to deposit (must meet the minimum balance)
* Check the **I accept the Terms and Conditions** checkbox
Fill in the funding account and amount, then accept the Terms and Conditions.
Click **Submit** when ready.
### Step 3 — Transfer Authorization
A **Transfer Authorization** modal summarises the funding transaction before it is submitted. Review the details:
| Field | What it shows |
| - | - |
| Funding Source | The masked account number of the source account |
| Funding Amount | The amount being transferred |
| APY | Annual percentage yield for the selected term |
| Interest Rate | Interest rate for the selected term |
Click **Submit** to confirm, or **Cancel** to go back and make changes.
### Step 4 — Success
A **Success** confirmation modal confirms your new CD has been funded.
Click **Close** to return to the dashboard. Your new CD will appear in the Certificate of Deposit Management list.
***
## Opening a Checking Account
### Step 1 — Select a checking account type
The **Checking Account Types** screen shows all available checking products. Click **Open** on the account type you want.
### Step 2 — Fund your new checking account
The **Checking Account Open Options** screen displays the selected account details at the top. Fill in:
* **Select funding account** — choose the source account from the dropdown
* **Funding amount** — enter the initial deposit amount
* Check the **I accept the Terms and Conditions** checkbox
Click **Submit** when ready.
### Step 3 — Transfer Authorization
A **Transfer Authorization** modal confirms the funding details before submission.
Click **Submit** to confirm.
### Step 4 — Success
A **Success** modal confirms the checking account has been funded.
Click **Close** to return to the dashboard. You can manage your new checking account from the Accounts section of online banking.
***
## Opening a Savings Account
### Step 1 — Fund your new savings account
The **Savings Account Open Options** screen displays the Savings Account details and a funding form. Fill in:
* **Select funding account** — choose the source account from the dropdown
* **Funding amount** — enter the initial deposit (minimum balance is \$0.00)
* Check the **I accept the Terms and Conditions** checkbox
Click **Submit** when ready.
### Step 2 — Transfer Authorization
A **Transfer Authorization** modal shows the funding summary.
Click **Submit** to confirm.
### Step 3 — Success
A **Success** modal confirms the savings account has been funded.
Click **Close** to return to the dashboard.
***
## Opening a Money Market Account
### Step 1 — Fund your new money market account
The **Money Market Account Open Options** screen displays the account details and a funding form. Fill in:
* **Select funding account** — choose the source account from the dropdown
* **Funding amount** — enter the initial deposit (minimum balance is \$250.00)
* Check the **I accept the Terms and Conditions** checkbox
Click **Submit** when ready.
### Step 2 — Transfer Authorization
A **Transfer Authorization** modal shows the funding summary.
Click **Submit** to confirm.
### Step 3 — Success
A **Success** modal confirms the money market account has been funded.
Click **Close** to return to the dashboard.
***
**Note**
After any successful account opening, an alert notification confirmation is sent to the customer. If a funding transfer fails — for example, if the source account has insufficient funds — an error message is displayed and no account is created.
# Release Notes
Source: https://docs.nuevesolutions.com/guides/products/self-service-cds/release-notes
## v1.8.0 — Upcoming
**FIS IBS Core Optimizations**
* Updated APY display to use the value provided in the Certificate of Deposit (CD) details instead of calculating it through the APY Calculation API.
**Correlation Core**
* Enhanced the CD renewal process to automatically add the joint owner to the newly created account.
**Secure Messaging**
* Added support for attachments in secure messages.
**New Feature — Account Closure**
* Added a Closing Reason field to the Account Closure flow.
***
## v1.7.0 — July 21st, 2026
**CD Management**
* Added status pills on CD cards to indicate CDs currently in the Grace Period and the remaining days until maturity for active CDs.
**PRE-CD Closure Flow**
* Customers can now schedule a CD closure before maturity and choose an internal or external account to receive the funds when the CD matures.
* A decision tag displays the customer’s previously selected closure option and transfer account for easy reference.
**Account Closure**
* Introduced a new Account Closure feature for Checking and Savings accounts.
**Secure Messaging**
* Enhanced Secure Message functionality to support Group-to-Group message routing.
**Maintenance**
* Resolved linting issues across the entire codebase to improve code quality and consistency.
***
## v1.6.1 — July 15th, 2026
* Fixed system library dependency issues.
***
## v1.6.0 — May 7th, 2026
* **Reporting System Implementation** — Added support for sending secure messages to administrators upon specific CD actions performed by users.
* **Enhanced Wedges** — Updated `HIDE_RENEW_TILE_CD` and `HIDE_CLOSURE_TILE` to support both account type and sub-account type conditions.
* **Core Optimization** — Improved correlation logic to ensure newly created accounts are properly linked in joint relationship scenarios.
* **Signature Card Implementation** — Enabled automatic delivery of signature cards to users upon successful CD renewal.
* **Renewal Flow Enhancement** — Added support for multiple Terms & Conditions with checkbox acknowledgments and associated URLs.
* **Default Flow Core Enhancement:**
* **Closure Flow Improvement** — Introduced functionality to capture closure reasons during the CD closure process.
* **Renewal Flow Improvement** — Introduced a comment field to capture additional user input during the renewal process.
***
## v1.5.0 — January 12th, 2026
* **Email Notification Implementation** — Added support for sending email notifications to end users upon performing specific CD actions.
* **New Wedge — `ENABLE_EMAIL_NOTIFICATION`** — Controls whether email notifications can be sent to end users.
* Integrated Savings and Money Market account opening flows for one Financial Institution.
* Introduced additional security validations before performing post actions.
* Implemented dynamic fields for core calls based on scenario requirements.
* Added scenario-level Custom UI handling to support FI-specific UI behavior.
* Added a new wedge key `ACCT_NUM_HADE_VALID_KEY` for enhanced validation of user accounts before allowing any actions.
* Integrated a Default Flow Core Adapter that sends secure messages on CD renewal or closure instead of making an actual core call.
***
## v1.4.0 — November 10th, 2025
* **Added configuration:** `NON_CD_ACCOUNT_TYPES` for calling the Create API for both Non-CD and CD accounts.
* **Updated wedge key name:** Renamed `EXCLUDED_SAVINGS` to `EXCLUDED_SAVINGS_TYPES` for better clarity and consistency.
* **Integrated new core adapter:** Integrated `CoreProApi` for Fiserv DNA.
* **Added new flag:** `DESCRIPTION_FROM_CORE` — when set to `true`, the interest plan name is retrieved from the Core and displayed in the UI using the wedge `RENEWAL_SKIP_TERM` in both the Terms dropdown and the View Current Rates modal.
* **Added new feature:** Enabled the ability to send secure messages to end users upon performing specific actions.
* **Added new wedge:** `ENABLE_SECURE_MESSAGE` — controls whether secure messages can be sent to end users.
***
## v1.3.1 — October 20th, 2025
* Updated the certificate renewal API request.
***
## v1.3.0 — September 11th, 2025
* **New Core Adapter Added** — Integrated Fiserv Premier Open Communicator as a core adapter.
* **Enhanced Wedge Configuration Access** — Enabled wedge configuration access for financial institutions with multiple regions, as well as through ABA values for banks sharing the same configuration.
* **Dynamic Secure Message Body** — Implemented support for a dynamic secure message body to ensure consistent and flexible secure messaging across different financial institutions.
* **CD Rates Filtering** — Added frontend filtering capabilities to display CD rates by sub-account type for improved usability.
* **New Wedge Configuration for CD Options (optional)** — Introduced the `HIDE_RENEW_TILE_CDS` and `HIDE_CLOSE_TILE_CDS` configurations to hide the Renew tile and the Close and Transfer tile, respectively, for specified sub-account types on the Certificate of Deposit Options page.
***
## v1.2.0 — August 19th, 2025
* **Account Opening Flow** — Added support for CD opening with funding validation, maturity handling, and dividend transfer options, including:
* Auto-renewal with same term at maturity
* Choice to retain or transfer monthly dividends to a funding account
* Option to transfer principal to primary savings at maturity and close CD
* Redesigned UI with enhanced validations, error handling, and self-service maturity/dividend instructions
* **Dynamic Account List** — Introduced a dynamic account list to automatically reflect updated FI values (e.g., balance, share ID, account number, and other key fields).
***
## v1.1.0 — July 15th, 2025
* Added a dynamic Wedge configuration to control the display of all available CDs. CDs in the grace period will appear first with the **Manage** button enabled, followed by CDs outside the grace period with the **Manage** button hidden.
* Introduced a new feature to enable or disable certificate rates based on Wedge configuration.
* Through Wedge configuration in online banking, this feature allows financial institutions to control which certificate rates appear in the dropdown and pop-up modal when users renew their certificates.
***
## v1.0.0 — May 14th, 2025
Online Banking (OLB) users can:
* Create a new Certificate of Deposit account
* Renew a Certificate of Deposit with different terms
* Renew a Certificate of Deposit with the same term
* Create a new Certificate of Checking account
* Close and transfer a Certificate of Deposit account
# Welcome
Source: https://docs.nuevesolutions.com/index
Guides, product documentation, and technical references for Nueve Solutions.
Nueve Solutions is a banking technology company based in Austin, TX, helping banks and credit unions modernize their digital banking experience through automation, self-service tools, and scalable integrations.
## Explore the Docs
* [**About Nueve**](guides/nueve/about) — Learn who we are, what we do, and the platforms we partner with.
* [**Refer a Friend**](guides/products/refer-a-friend/Q2/introduction/index) — Automated referral program for growing deposits through member referrals.
* [**Self Service CDs**](guides/products/self-service-cds/Q2/introduction/index) — Let account holders open, renew, and cash out CDs without branch visits.
## Need Help?
Reach out to [hello@nuevesolutions.com](mailto:hello@nuevesolutions.com) for assistance.