🤝Aggregators

Description

This module will allow the developer to use a data aggregator to connect financial institutions with ease. It will support services such as Plaid or MX.

Features:

• Allow the user to connect to financial institutions.

• Fetch and display accounts.

Common Communication Flow between Front End and Back End.

The following env vars are required:

AGGREGATOR_NAME=<your aggregator name>
ENABLE_AGGREGATOR_AUTOMATIC_CONNECTION=true
AGGREGATOR_TOKEN_URL='aggregators/token-link'
AGGREGATOR_BANKING_CONNECTION='aggregators/banking-connection'
AGGREGATOR_BANKING_ACCOUNT='aggregators/my-accounts'
UNLINK_AGGREGATOR_URL='aggregators/unlink-banking-connection'
AGGREGATOR_BANKING_ACCOUNT_CONNECTION='aggregators/banking-account-connection'

1. AGGREGATOR_NAME: This variable is used to decide automatically which aggregator service will be used. It also helps in choosing the correct interfaces and parsing functions to standardize the data displayed on the components.

2. ENABLE_AGGREGATOR_AUTOMATIC_CONNECTION: If using a BaaS service, this flag will be used to create a synthetic account linked to the aggregator account.

3. AGGREGATOR_TOKEN_URL: Endpoint to receive needed token or one-time-use URL for the selected aggregator service.

4. AGGREGATOR_BANKING_CONNECTION: Endpoint to return the aggregator's service generated token. Some aggregators won't require this.

5. AGGREGATOR_BANKING_ACCOUNT: Endpoint to fetch the user's connected accounts.

6. UNLINK_AGGREGATOR_URL: Endpoint to unlink the aggregator's connection. If supporting multiple accounts/connections, this endpoint will delete all connections from the service.

7. AGGREGATOR_BANKING_ACCOUNT_CONNECTION: Endpoint to link the aggregator connection.

How to use it?

Usage example

• Import these components AggregatorScreen and AggregatorStrings in your RootNavigation. 'src/navigation/ProtectedStackNavigator'.

import {AggregatorScreen} from 'LinkerStudio/modules/aggregators/common/components';
import aggregatorStrings from 'LinkerStudio/modules/aggregators/common/localization';

• Add this code block to the Stack.Navigator where you want to display the aggregator screen.

{/* screen for aggregators */}
  <Stack.Screen
     name="AggregatorScreen"
     component={AggregatorScreen}
     options={{title: aggregatorStrings.example.aggregatorExample}}
  />

• Import AggregatorsStackParams type in the types.ts file where you want to have the stack params list type.

import {AggregatorsStackParams} from 'LinkerStudio/modules/aggregators/common/navigation/types';

Add aggregator

Import AggregatorList where you want to add the option to display the aggregator.

import {AggregatorsList} from 'LinkerStudio/modules/aggregators/common/components/organisms';

<AggregatorsList/>

Custom button add account

In your AggregatorsList component, modify the Aggregator component. It should receive a child, for example:

<Aggregator
  onSuccess={onLinkSuccess}
  onError={onError}
  token={token}
>
  {/* add your custom component */}
</Aggregator>

Custom list aggregator

In your AggregatorsList component, modify the AccountsList and add your custom list.