---
title: "Worker Direct Deposits"
method: PATCH
path: "/workers/{workerId}/directdeposits"
tags: ["Worker"]
---

# Worker Direct Deposits

`PATCH /workers/{workerId}/directdeposits`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/workers/{workerId}/directdeposits`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/workers/:workerId/directdeposits/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update multiple direct deposits for an "Active" or "In-Progress" worker at a time. "In-Progress" workers cannot be PATCHED using Content Type "application/json-patch+json"

## Path parameters

- `workerId` string, required

## Query parameters

- `effectivitydate` string

## Request body

- DirectDepositResourceV2[]
  - `directDepositId` string: The ID for the direct deposit item.
  - `startDate` string, date-time: The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED.
  - `paymentType` 'FLAT_DOLLAR_AMOUNT' | 'PERCENTAGE' | 'REMAINDER': A type of payment for the direct deposit.
  - `accountType` 'CHECKING' | 'SAVINGS': Financial institutions account type. This data field cannot be PATCHED.
  - `value` number: The amount to be applied to this direct deposit.
  - `routingNumber` string: The financial institutions routing number.This data field cannot be PATCHED.
  - `accountNumber` string: The financial institutions account number.This data field cannot be PATCHED.
  - `priority` string: The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can't be modified.This data field cannot be PATCHED.
  - `_links` Links

## Response `200`

This is successful

- object
  - `content` DirectDepositResourceV2: Worker direct deposit
    - `directDepositId` string: The ID for the direct deposit item.
    - `startDate` string, date-time: The date that this direct deposit will be applied to future pay periods. This data field cannot be PATCHED.
    - `paymentType` 'FLAT_DOLLAR_AMOUNT' | 'PERCENTAGE' | 'REMAINDER': A type of payment for the direct deposit.
    - `accountType` 'CHECKING' | 'SAVINGS': Financial institutions account type. This data field cannot be PATCHED.
    - `value` number: The amount to be applied to this direct deposit.
    - `routingNumber` string: The financial institutions routing number.This data field cannot be PATCHED.
    - `accountNumber` string: The financial institutions account number.This data field cannot be PATCHED.
    - `priority` string: The priority order for which the direct deposits will be performed in. When a new direct deposit is added the priority will be assigned. The priority can be modified only by swapping with a different direct deposit using the bulk PATCH. A paymentType of REMAINDER will show a priority of 99 and can't be modified.This data field cannot be PATCHED.
    - `_links` Links
  - `links` Link1[]
    - `href` string
    - `hreflang` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string
    - `templated` boolean

## Other responses

- `400`: The request cannot be performed since the worker is in a state which does not allow this action(API-19)
- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)