This article describes how to configure a client for the Principal Loans Feedback to PrimePay SPAY moov definition used for 360 integration. Each client configuration will vary based on their plan specification and will need to be configured accordingly.
To add a moov to your account, click on moovs on the left hand menu and click the ADD button in the upper right.
Then expand the Retirement - Retirement to Payroll panel, select the moov you wish to adopt and click the USE THIS MOOV button on the right.
Once the Principal Loans Feedback to PrimePay SPAY moov has been added to your account, click on the Principal Loans Feedback to PrimePay SPAY moov in the moovs table.
Importance of the loanid field on the PrimePay SPAY Loan Deduction
When a loan deduction record is included in the feedback file from Principal, the Loan ID is required to map to the loanid field in PrimePay SPAY. This is important when an existing loan deduction is either modified or a request to end the loan is sent from Principal. If the Loan ID does not match the existing loan deduction's loanid field in PrimePay, a new loan deduction will be created instead of modifying or ending the existing loan deduction. If the Loan ID field is blank, it creates a new loan deduction in PrimePay SPAY with a blank loanid on the Loan Deduction.
In the event that no Loan ID is sent on a loan deduction record, the Principal Loans Feedback to PrimePay SPAY moov will validate if the Loan ID sent from Principal exists and generates a notification email.
An example of the validation report generated when a loan deduction has no Loan ID:
This shows that the first record in the deduction feedback file is a 401k Loan and that no Loan ID was found for this record.
To edit the validate file step, click on the cog icon under the Action - Validate Files step on the left. Then toggle the "Use default parameters" off and enter in the email addresses you would like to receive the notification. If you would like to enter multiple email addresses, separate them with a comma. A Reply to email is also required in the event that a recipient of the notification replies to the email.
To save your parameters click on the Save Changes button.
The Principal Deduction Feedback to PrimePay SPAY moov provides a notification once the moov is complete with a summary of the retirement plan and loan changes that were made in PrimePay SPAY. The notification can be sent to any email address you wish and can also be configured to send to multiple email addresses.
To edit the send file step, click on the cog icon under the Action - Send File step on the left. Then toggle the "Use default parameters" off and enter in the email addresses you would like to receive the notification. If you would like to enter multiple email addresses, separate them with a comma. A Reply to email is also required in the event that a recipient of the notification replies to the email.
Note: these settings apply to any client configuration you set up for this specific moov. You also have the ability to configure the send file step for each client configuration if you wish to add or remove email addresses per client.
To save your parameters click on the Save Changes button.
In the moov configuration section, click the Add button to add a new client to the moov.
Client/Entity - either select an existing client or click the + sign to create a new client.
Status - Set to Active
Expected Frequency - the client's payroll frequency
File Name Starts With - Principal files for your client with be in the naming convention of C[Prefix][Contract Number]_LOAN_[CCYYMMDD]. This field should be the C[Prefix][Contract Number] part of the file name
File Name Contains - Enter the value: LOAN
Note: make sure that the File Name Starts with field matches as this can cause issues pulling the Principal deduction feedback file and updating PrimePay SPAY.
To automate the 360 integration, configure the SFTP schedule. Click the SFTP banner under the Trigger - SFTP Pull Data Trigger step and click Add.
On the New SFTP Configuration section on the right, select the SFTP Pull option from the Premier Integration menu. Then select either "Every X weeks" or "On certain days of the month", depending on how often you would like detamoov to check for new feedback files. We recommend that you check for feedback files at least twice a week. In the example below, we have set up a schedule to check for files twice a week on Tuesdays and Fridays.
Click OK once you have created your SFTP configuration.
Skip Step - PrimePay SPAY Retirement 360
Principal will send deduction feedback files even if no deduction changes were made. This will result in a blank deduction feedback file. When this occurs, detamoov can skip the PrimePay SPAY Retirement 360 step. To activate the skip step, locate the Action - PrimePay SPAY Retirement 360 step and select "Skip step if no data to process" from the Skip Step dropdown.
Configure the PrimePay SPAY Retirement 360 Step
To configure the PrimePay SPAY Retirement 360 step for you client, locate the Action - PrimePay SPAY Retirement 360 step, expand the PrimePay SPAY API panel and click ADD.
On the side panel that appears, select your PrimePay SPAY Premier Integration and enter in the following credentials:
Company Code
Username
Password
API Key
Loan Deduction Codes - enter any loan deduction codes for this company, one per line.
You can also enter in one or more email addresses in the Error Messages Email. If left blank, all detamoov users on your account with administrator rights will receive emails if the PrimePay SPAY API import fails.
Click OK to complete the PrimePay SPAY Retirement 360 configuration.
At the beginning of this article you configured the send file step for the moov to send a notification once the moov had completed. You also have the ability to configure the send file step for each client configuration if you wish to add or remove email addresses per client.
To override the send file step, locate the Action - Send File step and toggle the "Use default parameters" off and enter/remove email addresses from Email Address and Reply To fields. If you would like to enter multiple email addresses, separate them with a comma.
Principal will send deduction feedback files even if no deduction changes were made. This will result in a blank deduction feedback file. When this occurs, detamoov can skip the Send File step. To activate the skip step, locate the Action - Send File step and select "Skip step if no data to process" from the Skip Step dropdown.
To complete the configuration for your client, click the Next button at the bottom of the page and then the Save button on the moov summary page.
