Create or update a bank account split

put

https://api.everee.com/integration/v1/workers/{id}/bank-accounts/split/{splitNumber}

Create or update split 1 or split 2 of a worker's direct deposit. If the bank account split exists it's updated in place, otherwise it's created. Bank account splits must be created in order, so split 2 requires split 1.

Send the full accountNumber when creating a bank account split. When updating, omit it to keep the stored account number. percentPerPayment is a whole number from 1 to 100.

Don't send a bank name. Everee determines it from routingNumber, which must be a routing number in the Federal Reserve directory. In a sandbox company you can use reserved test routing numbers to get a predictable result. See the Guide to the Worker Direct Deposit API for details, including the sections on routing numbers and bank names and testing in the sandbox.

Path Params

string

required

The worker's ID (your external worker ID, or the Everee worker ID).

splitNumber

integer

enum

required

The bank account split's position: 1 or 2. The default account is not a bank account split.

Allowed:

Body Params

displayName

string

required

A name for the account, shown to the worker.

accountNumber

string

The full account number, digits only. Required when creating a bank account split. Optional when updating one: omit it (or send an empty value) to keep the stored account number.

routingNumber

string

required

Exactly 9 digits. Must be a routing number in the Federal Reserve routing directory; unknown or retired numbers are rejected. Sandbox companies accept any 9 digits, plus reserved test numbers (see the Guide to the Worker Direct Deposit API).

accountType

string

enum

required

Allowed:

percentPerPayment

string

required

Whole-number percent of each payment to deposit to this account, from 1 to 100. A string or a number is accepted.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200The saved bank account split.

400The request couldn't be applied. For example: the split number isn't 1 or 2, an earlier bank account split doesn't exist yet, percentPerPayment isn't a whole number from 1 to 100, accountNumber is missing on create, or the account matches one the worker already has.

404The worker has no default bank account.

422The request body was invalid. For example: a required field is missing or blank, routingNumber isn't exactly 9 digits, or accountNumber contains non-digits.