Bank accounts and direct deposit splits

Attributes

AttributeRequired?Default
account_typeYes
account_numberYes
routing_numberYes
typeYes—must be "Direct Deposit"
split_byYes—must be either "Amount" (meaning: Cents) or "Percentage"
split_amountYes
name

Examples

See the following examples to explore different scenarios:

Check here to see how this looks in the context of a full batch example.

Example with one bank account

One bank account with 100% direct deposit.

{
  "idempotency_key": "bcfc9744-0ab3-4ef3-ab0d-e728255d659c",
  "batch_action" : "create",
  "batch": [
    {
      "entity_type": "employee",

      "person": {
        "external_id": "employee-abc-123",
        "first_name": "Alice",
        "last_name": "Smith"
      },
      "bank_accounts": [
        {
          "account_type": "Checking",
          "account_number": "1234567890",
          "routing_number": "000234234223",
          "type": "Direct Deposit",
          "name": "Etrade Checking",
          "split_by": "Percentage",
          "split_amount": "100.0"
        }
      ]
    }
  ]
}

Example with multiple bank accounts and split by percentage

Two bank accounts with percentage split between direct deposits.

Percentages have to add up to 100.0%

{
  "idempotency_key": "bcfc9744-0ab3-4ef3-ab0d-e728255d659c",
  "batch_action" : "create",
  "batch": [
    {
      "entity_type": "employee",

      "person": {
        "external_id": "employee-abc-123",
        "first_name": "Alice",
        "last_name": "Smith"
      },
      "bank_accounts": [
        {
          "name": "Etrade Checking",
          "account_type": "Checking",
          "account_number": "1234567890",
          "routing_number": "000234234223",
          "type": "Direct Deposit",
          "split_by": "Percentage",
          "split_amount": "80.0"
        },
        {
          "name": "Etrade Savings",
          "account_type": "Savings",
          "account_number": "1234567890",
          "routing_number": "0987693293",
			    "type": "Direct Deposit",
          "split_by": "Percentage",
          "split_amount": "20.0"
        }
      ]
    }
  ]
}

Example with multiple bank accounts and split by amount in cents

Two bank accounts with a split based on amounts in Cents between direct deposits.

The amount for the last account has to be given as null in order to receive the remainder.

{
  "idempotency_key": "bcfc9744-0ab3-4ef3-ab0d-e728255d659c",
  "batch_action" : "create",
  "batch": [
    {
      "entity_type": "employee",

      "person": {
        "external_id": "employee-abc-123",
        "first_name": "Alice",
        "last_name": "Smith"
      },
      "bank_accounts": [
        {
          "name": "BofA Checking",
          "account_type": "Checking",
          "routing_number": "266905059",
          "account_number": "5809431207",
          "type": "Direct Deposit",
          "split_by": "Amount",
          "split_amount": "450000"
        },
        {
          "name": "Etrade Savings",
          "account_type": "Savings",
          "account_number": "1234567890",
          "routing_number": "0987654543",
          "type": "Direct Deposit",
          "split_by": "Amount",
          "split_amount": null
        }
      ]

    }
  ]
}