Configure Increase as a Source in your Pipeline

Perform the following steps to configure your Increase Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select Increase.

4. On the Select Destination Type page, select the type of Destination you want to use.

5. In the Configure Source screen, specify the following:

   

   • Source Name: A unique name for your Source, not exceeding 255 characters. For example, Increase Source.

   • In the Connect to your Increase account section, specify the following:

     • Environment: The Increase environment from which you want to ingest data. Select Production or Sandbox. Default value: Production. You cannot change the environment after you create the Pipeline. To ingest data from the other environment, create a new Pipeline.

     • API Key: The API key with read-only access that you created in the environment that you selected.

     • Sync card numbers, security codes and PINs (PCI): Enable this option to ingest the full card number, security code, and PIN of your cards into the card_details object. Default value: Disabled. If Increase does not allow your account to access these card details, Hevo displays the card_details object as inaccessible. If you enable this option, your Destination stores card data that is in the scope of the Payment Card Industry Data Security Standard (PCI DSS). Unless you need this data, block the primary_account_number, verification_code, and pin fields of the card_details object.

6. Click Test & Continue to test the connection to your Increase Source. Hevo checks the connection by reading the details of the Increase group to which the API key belongs. The test fails if Increase rejects the API key, for example, if the key belongs to the other environment. Once the test is successful, you can proceed to set up your Destination.

On the Configure Objects page, the objects that Increase does not allow your account to access, such as objects that need a feature that is not enabled for your account, are displayed as inaccessible, and you cannot select them.

---

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.

Hevo ingests the following types of data from your Source objects:

• Historical Data: The first run of the Pipeline ingests all the data of the selected objects. For the events object, Hevo ingests the events of the last 30 days, as Increase retains events for 30 days. Hevo does not ingest any historical data for the real_time_decisions object.

• Incremental Data: Once the historical load is complete, Hevo ingests data as per the sync frequency:

  • For the card_purchase_supplements, declined_transactions, digital_wallet_token_requests, events, files, and transactions objects, Hevo ingests the records created since the previous run. Increase does not change these records once they are created.

  • For the card_tokens, lockbox_recipients, and oauth_applications objects, Hevo ingests the records created since the previous run. In addition, every seven days, Hevo ingests the entire data of the lockbox_recipients and oauth_applications objects, and the card_token_capabilities data of all card tokens, to capture the changes to existing records. Changes to existing card_tokens records are not ingested.

  • For the inbound_wire_drawdown_requests object, Hevo ingests the records created since the previous run.

  • For the entity_onboarding_sessions object, Hevo ingests the records created since the previous run. In addition, once an hour, Hevo ingests the sessions created in the last 24 hours again to capture the changes to their status. As a result, a change to a session can be ingested up to an hour after the next scheduled run.

  • For the groups object, Hevo ingests the entire data in each run.

  • For the account_balance_snapshots object, Hevo reads the balance of each account that has new or changed transactions or pending transactions since the previous run. In addition, Hevo reads the balance of every open account once a day.

  • For the account_intrafi_balances object, Hevo reads the IntraFi balance of each enrolled account once a day.

  • For all the other objects, Hevo uses the events that Increase generates when a record is created or updated. Hevo reads the events created since the previous run, and then ingests the records that the events refer to. For the real_time_decisions object, Hevo ingests only the decisions made after the first run of the Pipeline.

  Child objects, such as card_payment_elements, are ingested along with their parent object.

Increase retains events for 30 days. If a Pipeline does not run for more than 28 days, for example, because it is paused, the objects that Hevo ingests using events fail, as Hevo cannot read the events that were created while the Pipeline was not running. To resume ingesting data for these objects, resync them.

You cannot resync the account_balance_snapshots, account_intrafi_balances, and real_time_decisions objects. To resync a child object, resync its parent object.

If Hevo cannot ingest the account_intrafi_balances object, for example, because of a change to the permissions of your IntraFi enrollments, fix the permissions in Increase, and then deselect and select the object again. Hevo then ingests the current IntraFi balance of each enrolled account. The balances of the days that were missed cannot be ingested, as Increase does not keep the history of IntraFi balances. Do not drop the existing data of this object and load it again, as this deletes the balances of the earlier days.

Increase limits the number of API requests that a group can make. The limit is 100 requests per second in the Production environment and 20 requests per second in the Sandbox environment, and it is shared with the other API requests made to your Increase group. Read Rate limits. If a limit is reached, Hevo retries the request up to eight times, waiting for the duration that Increase specifies. If the limit is still exceeded, Hevo ingests the object in the next run.

Note: You can create a Pipeline with this Source using either the Merge or the Append load mode, and you can change the load mode for each object. Merge is the default load mode for all the objects except the following:

• The card_purchase_supplements, declined_transactions, digital_wallet_token_requests, files, and transactions objects support only the Append load mode.

• The account_balance_snapshots and card_tokens objects use the Append load mode by default.

• If you select a child object after its parent object is loaded, Hevo ingests the parent object again. If the parent object uses the Append load mode, its records are added a second time. To avoid this, select the child objects together with their parent object. For the card_purchase_supplements object, which supports only the Append load mode, select the card_purchase_supplement_line_items object along with it.

If you resync an object that uses the Append load mode, choose to drop the existing data and load all the data again, to avoid duplicate records. Do not do this for the events object (see Source Considerations).

---

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

The primary key of most objects is id. The following objects use other primary keys:

• account_balance_snapshots: account_id and snapshot_at.

• account_intrafi_balances: account_id and effective_date.

• ach_prenotification_notifications_of_change: ach_prenotification_id and element_index.

• ach_transfer_notifications_of_change: ach_transfer_id and element_index.

• card_details: card_id.

• card_payment_elements: card_payment_id and element_index.

• card_renewals: card_id and element_index.

• card_token_capabilities: card_token_id and route.

• check_deposit_adjustments: check_deposit_id and element_index.

• digital_wallet_token_updates: digital_wallet_token_id and element_index.

• entity_beneficial_owner_prongs: entity_id, entity_beneficial_owner_id, and prong.

• entity_supplemental_documents: entity_id and file_id.

• entity_terms_agreements: entity_id and element_index.

• event_subscription_selected_event_categories: event_subscription_id and event_category.

• fednow_transfer_returns: fednow_transfer_id and element_index.

• inbound_check_deposit_adjustments: inbound_check_deposit_id and element_index.

• inbound_mail_item_checks: inbound_mail_item_id and element_index.

---

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

---