Skip to main content
Redirect payouts to your bank. After a user connects their payroll account through Link, they can be prompted to direct all or part of their pay to a specified bank account.
Direct deposit switching in Link animated overview.

​
Platform support

To check if a specific Item supports deposit switching:
  • Console — In the Coverage tab, filter or search for Items where direct deposit switching (DDS) is supported. Selecting an individual Item will display additional information on the underlying platform’s DDS capabilities.
  • API - Filter Items using an Item filter or retrieve an individual Item by its ID and check the direct_deposit_switch object to see if deposit_account direct deposit switches are supported.
Our direct deposit switching (DDS) solution for embedded Link integrations is outlined below.

​
Structure a target deposit destination

Target deposit destinations contain the bank account information details used in a deposit switch. The steps outlined in DDS flows show how to construct target deposit destinations for different use cases, such as receiving the entirety or a partial amount of the user’s paycheck.

​
Create a deposit switch customization

We recommend limiting searchable Items in Link to only those that support deposit switching:
  1. Create a new customization using Flows in Console.
  2. Enable the setting “Only show Link items that support direct deposit switching.”
  3. Add additional branding, messaging, or other customizations as needed.
  4. After saving your customized Flow, pass in its ID via the flowId parameter in your Link initialization.
Use the optional ddsConfig Link initialization parameter to include an additional step for DDS after a user connects a payroll account.
For user privacy and security, sensitive banking information contained in target deposit destinations must be encrypted using the API’s /target-deposit-destinations encryption endpoint before being passed to your Link initialization via the ddsConfig parameter when adding deposit switching flows.

​
Returning users

Depending on your use case, you may want users to initially connect their payroll accounts through Link, return to your website or application for additional steps, and then return to Link for DDS. To initiate the DDS process for a previously connected account:
  1. Check the Item’s platform supports DDS.
  2. Include a ddsConfig in your Link initialization.
  3. (Optional)
Allocation type selection screen in Link.
If you want the returning user to immediately enter the deposit switch flow, include the accountId of the existing account in your Link initialization:
Account status screen in Link.
If you want the returning user to directly enter the account status screen, where they can decide whether to begin a deposit switch, include the itemId related to the existing account in an items array to your Link initialization:

​
DDS flows — direct deposits

Which DDS flow below you would like to perform determines what to include in your target deposit destination. As mentioned above, target deposit destinations must then be encrypted via the API to protect sensitive banking information before being passed to the ddsConfig Link initialization parameter.

​
Entire paycheck

Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Deposit switching flow for full paycheck and no adjustments.
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
  • Users are able to restore and edit previous bank accounts, where they can then allocate part of their paycheck.
  • Any unallocated remainder will be sent to the bank account specified in the target deposit destination.
Deposit switching flow for full paycheck with adjustments possible.
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
  • Users are able to restore and edit previous bank accounts, where they can then allocate part of their paycheck.
  • Users can switch between dollar amount or percent allocations (when both types are supported by the underlying payroll platform).
  • Any unallocated remainder will be sent to the bank account specified in the target deposit destination.
Deposit switching flow for full paycheck with adjustments and preferred allocations possible.

​
Partial paycheck

We recommend including both percent_allocation and amount_allocation with whole number values in your target deposit destination objects used for partial paychecks. Because some payroll systems only support one format, either amount values or percent values, this maximizes the number of payroll systems that will support a deposit switch with your specifications.
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
If the underlying payroll system supports both amount and percent allocations and both are present in the target deposit destination, adding the following line to your target deposit destination will display an initial screen that allows the user to choose whether they prefer to see and edit their allocations in amounts or percentages:
Deposit switching flow for certain percent or amount ranges.
You can also suggest an exact percentage or an exact amount exclusively, typically used in connection with loan repayments. In these cases, you would include only percent_allocation or only amount_allocation in your target deposit destination, respectively.
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Target deposit destination object before encryption:
After encryption:*example that can be used for testing
Deposit switching flow for exact amounts.

​
DDS flows — reference table

The table below contains the required and optional parameters of target deposit destinations for different types of DDS flows.

​
Adjust existing direct deposits

In some situations, such as when a user’s final loan payment is lower than the previous payments, you may want to adjust the pay allocations for the bank accounts that have already been added to the user’s payroll system:
Users will need to return to Link to confirm updated allocations. User consent is always required when adding, deleting, or adjusting direct deposits.
  1. Include an ach_deposit_account object in your target deposit destination as you normally would, and add the new allocation settings you would like the user to accept.
You can adjust existing direct deposit allocations in Link.

​
Remove a bank account

Using the following steps, users can confirm through Link they would like to remove the designated bank account from their payroll system’s direct deposit settings. The user will be able to adjust in Link how pay is allocated to their remaining bank accounts, as well as handle any multi-factor authentication (MFA) requests their payroll system requires.
A bank account cannot be removed if it is user’s only deposit destination. Have the user add a second bank account and then remove intended bank account.
  1. Use the direct login method to directly connect the user to the relevant account.
  2. Encrypt the following target deposit destination and pass it to the ddsConfig parameter in your Link initialization:
ID’s of each deposit_destination (bank account) can be found using the deposit destinations API endpoint.
You can remove a bank account through Argyle deposit switching.

​
Sandbox testing

You can test your target deposit destinations and customizations with Flows in Console. This allows you to simulate a user’s deposit switch experience and make any adjustments necessary:
  1. Enable Sandbox mode in Console using the toggle.
  2. Select a custom or demo Flow.
  3. Open the Deposit switch setting below the preview screen.
  4. Enable Request deposit switch and select Custom.
  5. Copy and paste the encrypted target deposit destination (ddsConfig) you would like to test.
Deposit switch errors can also be simulated by creating unique error-encoded passwords via the API. See error testing in our Sandbox Testing Guide for more information.
You can test deposit switching in Console Flows.

​
Webhooks

To monitor the progress of deposit switches, we recommend subscribing to our deposit destinations webhooks and direct deposit switches webhooks.

​
Status monitoring

You can view the status of any bank account updates:
  • Via the API, by checking the direct_deposit_switch object of an account.
  • Via Console, by checking the same object using the JSON toggle on the individual user’s page.
As a deposit switch progresses, the status value will progress from scanning to updating to success/error.

​
FAQ

After a user confirms DDS changes in Link, the update process typically takes fifteen to thirty seconds on most payroll systems, and up to two minutes on the slowest payroll systems.
After the deposit_destinations.added webhook is sent, which confirms the new allocation has been added and was detected during the payroll account’s most recent scan, the timing of when the allocation is applied depends on the specific payroll system. Some systems apply the new allocation immediately and will apply it to the current pay cycle, while others will only apply the new allocation starting with the following full pay cycle.
Argyle suggests removing one of the previous bank accounts connected to the user’s payroll system to make room for the new account.If the user’s payroll system only allows for one bank account, Argyle suggests adding the new bank account you provided and removing the previously connected bank account. The user will only have the option to confirm or decline the deposit switch. *The removal and addition will only adjust the user’s payroll system settings after the user submits their confirmation of these suggested changes.*If the user’s payroll system allows two or more bank accounts, Argyle suggests adding the new bank account you provided and removing one of the previously connected bank accounts. If the user wants to restore the removed bank account, they are allowed to swap it for a previously connected bank account that was not removed before confirming or declining the deposit switch. Removals and additions will only adjust the user’s payroll system settings after the user submits their confirmation of their selected changes.
If the user’s income is not enough to satisfy all pay allocations, how the available income is distributed varies from platform to platform. Whenever possible, Argyle prioritize your allocation in the platform’s payout queue.
Argyle only passes bank account and payment settings to the user’s payroll platform. If there is an issue with future payments, the user must contact their payroll provider directly.
No, the pay allocations will not automatically be removed from the payroll system because of account disconnection or revoked access. Argyle cannot update pay allocations on payroll systems that have become disconnected or where the user revoked access, and Argyle does not communicate with banks regarding these pay allocations. Please contact the user directly to update the pay allocations or re-connect the disconnected account.
Some payroll systems will override the bank_name included in your target deposit destination and instead use a bank name they derive from another source, such as the routing number of the account.Argyle retrieves and returns the bank name as it is stored by the payroll system.