Before you can integrate with the PrimePay SPay Premier Service, you will first need to have the PrimePay SPay Premier Integration set up on your account. If you have not set up the Premier Integration, please Contact Us.
Once the Premier Service has been set up, adopt and configure the moov Definition for the retirement provider using the How to Configure a moov - Payroll to Retirement list.
After adopting and configuring your client for a moov definition, click on the client row in the moov configuration section on the right.
Configuring a Premier Service Integration for an SPay client
On the ID and source section click Next in the lower right hand side of the screen.
On the moov steps section, under 1 Trigger - Data File received, expand the PrimePay API option and then click the ADD button.
In the Premier Integration dropdown menu, select your PrimePay API integration.
Then enter in your client's plan information in fields that appear.
- Plan ID - Enter your client's plan ID with retirement provider
- Company Code - Enter your client's Company Code from SPay
- Company EIN - Enter your client's Company EIN in ##-####### format
- Username - Enter the client's PrimePay SPay API username
- Password - Enter the client's PrimePay SPay API password
- API Key - Enter the client's PrimePay SPay API key
- Pay Process Status List - Select both Complete and Final Pay Process status options
Scheduling a Premier Service Integration for an Spay client
Next, a Premier service needs to be scheduled to run either every 'x' weeks, or on certain days of the month. Our recommendation, no matter the client's pay frequency, is to select Every 'x' weeks and have the integration run multiple days of the week.
Every "x" weeks
- Next Execution Date - the date that the integration will run next. Once a date is entered, that day of the week will be auto selected on the next step.
- Days of the week for the integration to repeat - days of the week the integration will execute.
- Time - the time that the integration will run on the days of the week for every 'x' weeks selected.
- Time Zone - the time zone related to the time specified for the integration to run (default is your current location's time zone).
- Repeat every 'x' weeks - the weekly frequency the integration should be executed.
On certain days of the month
- Select the days of the month to execute this moov - these are the actual days of the month that the schedule will run for the specific Premier Integration
- If a selected day falls outside the last day of the month for a specific calendar month, the last day of the month will be used instead
- If the current date (today) falls outside the the last selected date, the first date selected will be the initial date of the first run of the Premier Integration
- example: if the selected days are the 1st and the 15th, but today is the 16th, the Premier Integration's first run will be the 1st of the next month
- Use the last day of the month - check this option if you would like detamoov to check for pay processes on the last day of the month. This is useful when the current month does not have the day selected. detamoov will use the last day of the month instead. This option is automatically checked when you select the 29th, 30th and/or 31st day of the month.
- Time - the time that the integration will run on the selected day(s) of the month
- Time Zone - the time zone related to the time specified for the integration to run (default is your current location's time zone).
To complete the PrimePay Spay premier integration, click the OK button, scroll down and click NEXT and then click Save on the Summary page.
