Direct Deposit

Endpoint: https://api.paychex.com/workers/{workerId}/directdeposits

Verbs supported: GET & POST & PATCH

GET: Array of direct deposits on the worker.

POST: Add a direct deposit to a worker.

PATCH: Update multiple direct deposits at a time.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.

Response:

VerbProfileDescription
GEThttp://api.paychex.com/profiles/payroll/directdeposits/v1Default direct deposit profile.
POSThttp://api.paychex.com/profiles/payroll/directdeposits/v1Default direct deposit profile.
PATCH-Default direct deposit profile.

Endpoint: https://api.paychex.com/workers/{workerId}/directdeposits/{directDepositId}

Verbs supported: GET & PATCH & DELETE

GET: Single direct deposit for a worker.

PATCH: Update a single direct deposit for a worker.

DELETE: Remove a single direct deposit for a worker.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.
directDepositIdstringThe id assigned to the direct deposit for this worker.

Response:

VerbProfileDescription
GEThttp://api.paychex.com/profiles/payroll/directdeposit/v1Default direct deposit profile.
PATCH-Default direct deposit profile.
DELETE-Status of the request.

Response

Profile: Direct Deposit

The representational state of the a workers direct deposit.
Element NameTypeDescriptionSupports PATCH
directDepositIdstringThe ID for the direct deposit item. 
startDatedateThe date that this direct deposit will be applied to future pay periods. 
endDatedateThe date that this direct deposit stop being applied to pay periods.x - Locked if set
paymentTypestringA type of payment for the direct deposit.
  • FLAT_DOLLAR_AMOUNT
  • PERCENTAGE
  • REMAINDER
x
accountTypestringFinancial institutions account type.
  • CHECKING
  • SAVINGS
  • CREDIT_CARD
 
valuenumberThe amount to be applied to this direct deposit.x
routingNumberstringThe financial institutions routing number. 
accountNumberstringThe financial institutions account number. 
prioritystringThe 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.x

 

{
    "content": [
        {
            "directDepositId": "1020026420675252",
            "startDate": "2017-09-11T00:00:00Z",
            "paymentType": "PERCENTAGE",
            "accountType": "CHECKING",
            "value": 75,
            "routingNumber": "222371863",
            "accountNumber": "123456",
            "priority": "1",
            "links": [
                {
                    "rel": "self",
                    "href": "https://paychex.com/workers/004UWBZQJ7GEB9TVWFR9/directdeposits/1020026420675252"
                }
            ]
        },
        {
            "directDepositId": "1020026420675254",
            "startDate": "2017-09-11T00:00:00Z",
            "paymentType": "REMAINDER",
            "accountType": "CHECKING",
            "routingNumber": "222371863",
            "accountNumber": "234567",
            "priority": "99",
            "links": [
                {
                    "rel": "self",
                    "href": "https://paychex.com/workers/004UWBZQJ7GEB9TVWFR9/directdeposits/1020026420675254"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://paychex.com/workers/004UWBZQJ7GEB9TVWFR9/directdeposits"
        }
    ]
}