Job Errors
Pinwheel runs a login job when a user connects an account. After the connection is established, Pinwheel executes jobs for performing a direct deposit switch or retrieving Core Data.
Looking for a different category of errors?
Pinwheel's system also communicates API Errors and Link SDK Errors.
Sometimes, these jobs fail. You can listen for failure by registering for webhook events or listening to the onError callback on the Link SDK (see Link SDK Errors for more information about this callback).
These error types and codes are enums that are safe for developer use, whereas error messages are liable to change. We may introduce new error types and codes as non-breaking changes, in accordance with our Change Management policy.
There are five different error types:
| Error Type | Description |
|---|---|
systemError | Pinwheel internal server error. |
userActionRequired | User action is required. |
platformError | Payroll platform error. |
invalidAccountsConfiguration | Invalid user account configuration. |
invalidUserInput | User error. |
Specific error codes include:
| type | code | description | message |
|---|---|---|---|
systemError | systemError | An unhandled error when a payroll integration behaves in an unexpected manner. These errors are fixed such that subsequent users do not trigger them | Uh oh, looks like we're having trouble getting you connected. Please try again later. |
userActionRequired | accountLocked | This error is thrown when the user's account has been locked. Users will need to reach out to their HR Admin to proceed. | Uh oh, looks like your account has been locked. Please contact your payroll administrator to proceed. |
userActionRequired | changePasswordRequired | This error indicates that the user must update their password before logging in | Uh oh, you will need to update your password before proceeding. Please login through your payroll provider to continue. |
userActionRequired | accountNotActive | This error is thrown when a user attempts to login to an inactive account, eg. if they've been terminated and have lost access | Uh oh, your account is inactive. Please contact your payroll administrator to continue. |
userActionRequired | accountLoggedIn | This error is thrown if the platform detects that the user is logged in via another mechanism | Uh oh, looks like you're logged in already. Please log out of your account before trying again. |
userActionRequired | mfaSetupRequired | This error is thrown if MFA needs to be set up, eg. on first time login | Uh oh, you'll need to set up multi-factor authentication before proceeding. Please login through your payroll provider to complete setup before trying again. |
userActionRequired | contactHelpDesk | This error is thrown if the user needs to contact their payroll admin in order to continue. | Uh oh, looks like your account has been locked. Please contact your payroll Help Desk to continue. |
userActionRequired | directDepositDisabled | This error is thrown if the account does not support any updates to direct deposit settings, eg. the employer has disabled the ability to update settings within the online portal | Uh oh, your account does not support this action. Please contact your payroll administrator to continue. |
userActionRequired | directDepositAllocationsDisabled | This error is thrown if the account does not support direct deposit switches through the online portal, similar to directDepositDisabled | Uh oh, your account does not support this action. Please contact your payroll administrator to continue. |
userActionRequired | sessionTimeout | This error occurs when the session closes after a period of inactivity, eg. due to lack of user action. | Uh oh, looks like your session has timed out. Please exit and try again. |
platformError | dataNotAvailable | This error occurs only for Income and Employment jobs. It occurs when the user's payroll platform does not surface the data requested. The availability of data varies within platform, employer, and employee combinations. | This error is applicable to any job that is part of the Income and Employment suite (Income, Employment, Identity, Paystubs, Shifts, and Direct Deposit Allocations). Since this error is only viewable asynchronously via the job results endpoint, there is no message shown to the user in the Link modal. |
platformError | dataNotRefreshable | This error occurs only for Income and Employment jobs. It is raised when the user's payroll platform is able to surface the data requested when the user starts a new link session, but not when the job is run via refresh. The availability of data sometimes requires user action, such as an MFA code input, in order retrieve the requested data. | This error is applicable to any job that is part of the Income and Employment suite (Income, Employment, Identity, Paystubs, Shifts, and Direct Deposit Allocations). Since this error is only viewable asynchronously via the job results endpoint, there is no message shown to the user in the Link modal. |
platformError | locationRestricted | This error is thrown if the platform cannot be accessed at the user's current location. Eg, some employers restrict access to corporate networks, or from specific IPs or locations. | Uh oh, looks like your account cannot be accessed from your location. |
platformError | platformError | This error is thrown when there is an issue with the underlying payroll platform. While our connection is behaving as expected, the platform itself is not working as expected. | Uh oh, looks like we’re having trouble getting you connected. Please try again later. |
platformError | platformUnavailable | This error is thrown when the platform is unavailable, eg. some platforms will go offline during routine maintenance | Uh oh, looks like we're having trouble getting you connected. Please try again later. |
platformError | routingNumberRejected | This error is thrown when the routing number provided in the Link token is rejected by the platform's validation logic | Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later. |
platformError | maxFailedAttempts | This error is thrown if the user reaches the maximum number of login attempts | Uh oh, you've reached the maximum number of attempts. Please wait until your account is unlocked before trying again. |
invalidAccountsConfiguration | invalidExistingSplit | This error is thrown when the user's account does not support the requested change, eg. a user attempts to add a fixed amount allocation to an account that has an existing percentage allocation. Validation rules vary from platform to platform | Uh oh, your account does not support this action. Please contact your payroll administrator to continue. |
invalidAccountsConfiguration | changesTemporarilyDisabled | This error is thrown when a change is rejected due to existing changes that are still pending on the account, eg. a direct deposit switch has been submitted and is pending processing | Uh oh, looks like your account has pending changes. Please wait for them to complete before trying again. |
invalidAccountsConfiguration | maxAccounts | This error is thrown when a user has reached the maximum number of direct deposit allocations, such that a new one cannot be added | Uh oh, you've reached the maximum number of accounts. Please remove one via your payroll provider before trying again. |
invalidUserInput | mfaTimeExceeded | This error is thrown when the MFA token expires | Uh oh, the request has timed out. Please try again. Please try again. |
invalidUserInput | invalidCredentials | The user has entered invalid credentials | Uh oh, the credentials you entered are invalid. Please try again. |
invalidUserInput | invalidMfaCode | The MFA code that was entered was invalid | Uh oh, the authentication code you entered is invalid. Please try again. |
invalidUserInput | challengeAnswerIncorrect | The answer provided for the challenge question was invalid, eg. during an MFA step | Uh oh, the verification answer you provided is invalid. Please try again. |
invalidUserInput | validationFailed | This is a catch-all error that is thrown to capture other validation issues (eg. driver's license) | Uh oh, the information you entered is invalid. Please try again. |
invalidUserInput | emailNotRegistered | This error is thrown when the email address provided by the user has not been registered with the payroll platform | Uh oh, the email you are trying to use has not been registered. Please try again with a different email or contact your payroll administrator for help. |
invalidUserInput | passwordsNotEqual | This error is thrown in the password reset flow, when a password and its confirmation do not match | Uh oh, the passwords do not match. Please try again. |
invalidUserInput | invalidInput | This is a catch-all error that is thrown to capture generic input errors | Uh oh, the information you entered is invalid. Please try again. |
invalidUserInput | timedOutWithNoInput | This error is thrown if the Link modal is left up for 15 minutes without user input submitted. | Uh oh, looks like your device has been disconnected. Please exit and try again. |
Please contact [email protected] for access to our Developer Dashboard.
Updated almost 2 years ago