Skip to content

Working with Employee Direct Deposits

[Overview] [Operation details] [Sample configuration]

Overview

The following operations allow you to retrieve direct deposit information of an employee

Operation Description
GET Employee Direct Deposits Retrieve an employee's direct deposit information.

Operation details

This section provides more details on each of the operations.

Retrieving Employee Direct Deposit

We can use GET Employee Direct Deposits operation with required parameters to search and find the required employee's direct deposit information.

GET Employee Direct Deposits

<ceridiandayforce.getEmployeeDirectDeposits>
    <xRefCode>{$ctx:xRefCode}</xRefCode>
</ceridiandayforce.getEmployeeDirectDeposits>

Properties

  • xRefCode (Mandatory): The unique identifier (external reference code) of the employee whose data will be retrieved. The value provided must be the exact match for an employee; otherwise, a bad request (400) error will be returned.

Sample request

Following is a sample request that can be handled by this operation.

{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199",
  "contextDateRangeFrom": "2017-01-01T13:24:56"
}

Sample response

Given below is a sample response for this operation.

{
    "Data": [
        {
            "AccountNumber": "664648651",
            "BankName": "1ST UNITED SERVICES CU",
            "DepositNumber": 1,
            "PayMethod": {
                "XRefCode": "CHECKING",
                "ShortName": "Checking",
                "LongName": "Checking"
            },
            "IsDeleted": false,
            "IsPercentage": false,
            "IsRemainder": true,
            "RequiresPreNote": false,
            "RoutingTransitNumber": "321174000"
        }
    ]
}

Related Dayforce documentation

https://developers.dayforce.com/Build/API-Explorer/Employee-Personal-Information/Employee-Direct-Deposits/GET-Employee-Direct-Deposits.aspx

Sample configuration

Following example illustrates how to connect to Dayforce with the init operation and query operation.

1.Create a sample proxy as below :

<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="query"
       startOnLoad="true"
       statistics="disable"
       trace="disable"
       transports="http,https">
   <target>
      <inSequence>
         <log level="full" separator=","/>
         <property expression="json-eval($.username)" name="username"/>
         <property expression="json-eval($.password)" name="password"/>
         <property expression="json-eval($.clientNamespace)" name="clientNamespace"/>
         <property expression="json-eval($.apiVersion)" name="apiVersion"/>
         <property expression="json-eval($.xRefCode)" name="xRefCode"/>
         <ceridiandayforce.init>
            <username>{$ctx:username}</username>
            <password>{$ctx:password}</password>
            <clientNamespace>{$ctx:clientNamespace}</clientNamespace>
            <apiVersion>{$ctx:apiVersion}</apiVersion>
         </ceridiandayforce.init>
         <ceridiandayforce.getEmployeeDirectDeposits>
            <xRefCode>{$ctx:xRefCode}</xRefCode>
         </ceridiandayforce.getEmployeeDirectDeposits>
         <send/>
      </inSequence>
   </target>
   <description/>
</proxy>

2.Create a json file named query.json and copy the configurations given below to it:

{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199",
  "contextDateRangeFrom": "2017-01-01T13:24:56"
}
3.Replace the credentials with your values.

4.Execute the following curl command:

curl http://localhost:8280/services/query -H "Content-Type: application/json" -d @query.json
5.Dayforce returns HTTP Code 200 and the following reponse

{
    "Data": [
        {
            "AccountNumber": "664648651",
            "BankName": "1ST UNITED SERVICES CU",
            "DepositNumber": 1,
            "PayMethod": {
                "XRefCode": "CHECKING",
                "ShortName": "Checking",
                "LongName": "Checking"
            },
            "IsDeleted": false,
            "IsPercentage": false,
            "IsRemainder": true,
            "RequiresPreNote": false,
            "RoutingTransitNumber": "321174000"
        }
    ]
}
Top