addUserBankAccount

The addUserBankAccount API allows you to add a bank account for an employee.

For more information on employee bank account linking, refer to the Employee Bank Account Linking guide.

Account linking with Plaid

Use the linkType field to specify the account linking method. Supported values are:

• Manual
• Plaid
• CustomProvider

If linkType is set to Plaid, use the plaidOptions field to either:

• Send the Plaid invitation via email
• Return the Plaid link in the API response to surface within your UI

The employee must have an email address on file to receive a Plaid invitation. If the employee was onboarded without an email address, use the updateUser endpoint to add one.

⚠️ Warning: Only one Plaid linking request can be active at a time. The employee must complete account linking using the original Plaid link before additional bank accounts can be added.

Notes

• A bank account is required before employees using Direct Deposit can become active.
• The first bank account is automatically assigned payPercentage: 100.
• Multiple accounts may be added. After adding additional bank accounts, update allocation percentages using the updateUserPayPercentage API.
• If linkType is omitted from the request, it currently defaults to Manual.

Changing an employee’s bank account

• payPercentage is used to deactivate an existing bank account for payment purposes so a new one can be used instead.
• To change payPercentage, add a secondary bank account using addUserBankAccount.
• The secondary bank account can then be set to payPercentage: 100 using the updateUserPayPercentage API.
• This update pattern retains an audit record of which bank accounts have been added or paid out to.