Create or update a bank account split

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. See the Guide to the Worker Direct Deposit API for details.

Path Params
string
required

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

integer
enum
required

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

Allowed:
Body Params
string
required

A name for the account, shown to the worker.

string
required
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.

string
required

Exactly 9 digits.

string
enum
required
Allowed:
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
LoadingLoading…
Response
Choose an example:
application/json