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.
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.
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.
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.
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:
Check the Item’s platform supports DDS.
Include a ddsConfig in your Link initialization.
(Optional)
If you want the returning user to immediately enter the deposit switch flow, include the accountId of the existing account in your Link initialization:
Report incorrect code
Copy
Ask AI
accountId: "<ID of the account>"
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:
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.
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.
Receive an exact amount or percentage — user cannot make adjustments:
Target deposit destination object before encryption:
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:
Report incorrect code
Copy
Ask AI
"allow_changing_allocation_type": true
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.
Suggest an exact percentage — user can make adjustments:
Target deposit destination object before encryption:
{ "ach_deposit_account": { "bank_name": "<Any>", // optional "routing_number": "<9 digit code>", // *required* "account_number": "<8 to 17 digit code>", // *required* "account_type": "checking" or "savings" // *required* }, // One or both "percent_allocation" and "amount_allocation" objects must be present. "percent_allocation": { "value": "<0 to 100>", // *required* "min_value": "<0 to 100>", // optional "max_value": "<0 to 100>" // optional }, "amount_allocation": { "value": "<0 to Any>", // *required* "min_value": "<0 to Any>", // optional "max_value": "<0 to Any>" // optional }, // Both "percent_allocation" and "amount_allocation" are present and supported by the platform. "allow_changing_allocation_type": true // optional}
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.
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.
Report incorrect code
Copy
Ask AI
{ // Enter the bank account details of the existing allocation. "ach_deposit_account": { "bank_name": "YellowHorizon", "routing_number": "084101234", "account_number": "9483746361234", "account_type": "checking" }, // Enter the new allocation values. "amount_allocation": { "value": "200", "min_value": "200", "max_value": "200" }}
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 onlydeposit destination. Have the user add a second bank account and then remove intended bank account.
Use the direct login method to directly connect the user to the relevant account.
Encrypt the following target deposit destination and pass it to the ddsConfig parameter in your Link initialization:
Report incorrect code
Copy
Ask AI
{ "action": "remove-destination", "deposit_destination": "0181d8c4-31ed-3338-1859-05fc7f1ca501" // Example ID.}
ID’s of each deposit_destination (bank account) can be found using the deposit destinations API endpoint.
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:
Enable Sandbox mode in Console using the toggle.
Select a custom or demo Flow.
Open the Deposit switch setting below the preview screen.
Enable Request deposit switch and select Custom.
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.
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.
Will new allocations be applied to the current pay cycle?
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.
What happens if I want a user to add a new bank account to their payroll system to receive partial paychecks, but this would exceed the [max_allocations](/api-reference/items#object-features-direct_deposit_switch) found in the Items endpoint for that payroll system?
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.
What happens if the user's paycheck is less than the amount they chose to allocate during the deposit switch process?
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.
What happens if you do not receive an expected payment from an account the user added to their payroll system?
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.
If a user revokes access to their payroll account, or the payroll account becomes disconnected, does this remove the pay allocations that were added to the payroll account?
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.
Do the allocation settings in my target deposit destination limit which payroll accounts are shown to the user when I have initialized Link for deposit switching?
This is only the case if your initialization includes a Link Flow customization where the setting “Only show Link items that support direct deposit switching” has been enabled.Because every payroll system has different payment setting limitations, the user will only be shown payroll accounts whose payroll system supports the allocation settings in your target deposit destination. This minimizes DDS configuration errors to ensure an optimal user experience.
After a successful deposit switch, [listing](/api-reference/deposit-destinations#list) the account's deposit destinations shows it was correctly added, but why is the bank_name different from the one I used in my target deposit destination?
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.
