UKG Wallet and UKG Pro Integration

UKG Wallet Integration

The following prerequisites are required for integration:

  1. Create a Service Account
  2. Service Account user name
  3. Service Account password
  4. User API key
  5. Customer (Client) key
  6. Base URL
  7. Deduction code setup
  8. Permissions to access data

Disclaimer

The information in this guide is based on a standard production environment.

Environments that are configured differently may require additional adjustments. Payactiv handles support for UKG Wallet but may require UKG support resources, based on the configuration requirements. If you have questions regarding your UKG solution integration with Wallet (for example, API access), you can create a case and reference knowledge articles 000160051 and 000182208.

Create a Service Account

Complete the steps to create a service account.

Navigation:Menu > System Configuration > Security > Service Account Administration

  1. From the Service Account Administration page, select Add.
  2. From the Add/Change Service Account page, enter a user name for the account, using your ARNumber as a prefix.
    Note The user name must be unique and cannot be an existing user account name used to access the portal.
  3. Enter an email address for the service account.
    Important The Generate New Password check box is selected automatically when adding a new service account. After entering the remaining required information and selecting Save, a New Password dialog box displays with the randomly generated password. Copy the password and save it in a secure location. You will not be able to see this password again after closing the New Password page. If the password is lost or forgotten, a new one will need to be generated.
  4. Select Save.
  5. From the New Password dialog box, copy the password and save it to a secure location. Select OK.
    Important Share the generated password and service account user name with Payactiv.

Configure Web Service Access Permissions for UKG Wallet

Assign the required permissions to access the data for the service account you created.

Navigation:Menu > System Configuration > Security > Service Account Administration

  1. From the Service Account Administration page, select the service account you created for UKG Wallet.
  2. Select the View check box for the following web services:
    • Company Configuration Integration
    • Benefit Administration System Service
    • Payroll Integration
    • Employee Pay Statement
    • Employee Direct Deposit
  3. Select the View and Add check boxes for Personnel Integration.
    Note If the Benefit Administration System Service is not available, log a support case for UKG support and include knowledge article IDs 000160051 and 000182208 along with other necessary information for quick resolution.

Retrieve the User API and Client Keys

Complete the following steps to retrieve the API Key and Client Key.

Navigation:Menu > System Configuration > Security > Service Account Administration

  1. From the Service Account Administration page, note the Customer API Key shown at the top of the page.
  2. Find the service account in the list and note the User API Key.
    Shows the Service Account Administration page with Customer and User API Keys highlighted
  3. Share the Customer (Client) API Key and User API Keys with Payactiv.

Retrieve the Base URL

Complete the following steps to Retrieve the Base URL to provide to Payactiv.

Navigation:Menu > System Configuration > Security > Web Services

  1. From the Web Services page, make note of the URL through ".com."
    Example of a highlighted base URL
  2. Share the Base URL with Payactiv.

Configure Deduction Codes for UKG Wallet Integration

Create a deduction code and add the code to an employee benefits group for UKG Wallet integration.

Navigation:System Configuration > Business Rules > Business Rules

  1. From the Business Rules page, select Deduction/Benefits Plans.
  2. From the Deduction/Benefits plan page, select Add Deductions/Benefits Plan to create a new deduction code.
  3. In the Add Deduction/Benefit Plan dialog, enter an Effective Date, as needed.
  4. Select Next.
  5. From the Deduction Setup work event, in the Main tab, enter the required information. In addition, under General Information pane, ensure the following values are selected:
    • In the Deduction Type list, as a best practice, select either Additional or Miscellaneous.
      Note Selecting the Additional for Deduction type requires additional configuration after you save the new deduction code.
    • You must ensure the Benefit Plan check box is selected. If the Additional or Miscellaneous deduction types do not have the Benefit Plan check box selected, choose a different type that is configured as a Benefit Plan.
  6. Select Next.
  7. On the Calculations tab, ensure the following settings are selected under Employee and Employer:
    • Select the Use rate at employee level check box.
    • In the Amount field, select Flat amount.
    • Ensure the values are 0.Shows an example calculation set up for Payactiv configuration
  8. Select Next.
  9. From the Payroll tab, select all check boxes in the Scheduled Pay Periods by Default section.
  10. Select Save.

Available Deduction Type Additional Configuration

When you select the Available Deduction Type in the Deduction Code setup process, the following configuration is required.

Navigation:Menu > System Configuration > Business Rules > Business Rules

  1. From the Business Rules page, select Deduction/Benefits Type.
  2. Select the Available Deduction Type code you configured for Payactiv integration.
  3. From the Deduction/Benefit Type Detail page, complete the following:
    • Deselect the Is available for open enrollment check box.
    • Select the Allow Multiple Deductions check box.
    Deduction Type additional configuration
  4. Select Save.

Add a Deduction Code to an Employee Benefits Group

Link the created deduction code with the appropriate employees.

Navigation:Menu > System Configuration > Business Rules > Business Rules > select Deductions/Benefit Groups

  1. From the Deduction/Benefit Groups page, select the applicable group.
  2. From the Add/Change Deduction/Benefit Group page, select Add in the Plans grid.
  3. In the Add Record dialog, select the deduction code created for UKG Wallet and update the details, as needed.
  4. Select Add and then Save.
    Shows an example of the Add Record dialog
  5. Repeat the process for all applicable employee deduction groups.

UKG Pro Endpoints Leveraged by Payactiv

Below is the list of endpoints utilized by Payactiv:

  • {{BaseURL}}/api/personnel/v1/employee-demographic-details
  • {BaseURL}}/api/personnel/v1/employee-employment-details
  • {{BaseURL}}/api/configuration/v1/integration-company-details
  • {{BaseURL}}/api/configuration/v1/locations
  • {{BaseURL}}/services/LoginService
  • {{BaseURL}}/benefits/v3/payCalendars/years/{{Year}}
  • {{BaseURL}}/benefits/v3/deductions/effectivedates/{date}
  • {{BaseURL}}/benefits/v3/deductions/lumpsums/effectivedates/{date}
  • {{BaseURL}}/payroll/v1/payroll-deductions-history/?{paydate}&{deductioncode}
  • {{BaseURL}}/services/employeepaystatement
  • {{BaseURL}}/payroll/v1/direct-deposit?{employeeID}
  • {{BaseURL}}//api/personnel/v1/import-tool/
  • {{BaseURL}}///personnel/v1/import-tool/status/{stagingID}
  • {{BaseURL}}/services/payroll/v2/payroll-pending-items/earnings

  • {{BaseURL}}//services/payroll/v2/payroll-pending-items/deductions