addUserBankAccount

The addUserBankAccount API allows a bank account to be added for an employee.

For more information about user bank account linking please refer to the Employee Bank Account Linking guide.

When to use:

• When an employee’s wage is configured as Direct Deposit
• To add a second or third bank account for payment splitting

Account Linking with Plaid

• Use the linkType field to determine the linking method for the account. Supported options are Manual, Plaid and CustomProvider.
• If linkType is Plaid, you must choose between sending the link via email or returning the link via API to surface in your UI using the plaidOptions field.
• The employee must have a stored email to receive a Plaid invite. If the employee was onboarded without an email, please use the updateUser endpoint.

⚠️ Warning: Only one plaid link can be requested at a time. The employee must complete acocunt linking using the original link before adding subsequent bank accounts.

Notes:

• A bank account is required for Direct Deposit employees to become active.
• payPercentage determines the amount that will be deposited into the account. For the first account, this should be 100%.
• If linking through Plaid, payPercentage can only be set after the account is fully linked using the updateUserPayPercentage API, and userPayAccountEntityId must be retrieved form the bank account webhook or getUser.
• LinkType currently defaults to Manual if not included in the request.