GuidesAPI ReferenceChangelog
Log In

Link SDK Errors

Link SDKs offer an onError callback so you can handle different error states of the Link Modal. Alternatively, the onEvent callback also fires error events as well.

๐Ÿ“˜

Looking for a different category of errors?

Pinwheel's system also communicates API Errors and Job Errors.

The onError callback will be triggered for Link Modal errors and Job Errors. If an error occurred before closing the modal, Link's onExit callback is called with an error object as well.

๐Ÿšง

Users may be able to proceed after error events

Errors surfaced via the error event do not necessarily mean the user can no longer continue to successfully complete the flow. For example, the error with code invalidCredentials fires when a user inputs invalid credentials, however, the user can proceed despite this error.

Link error types and codes are safe for developer use, whereas error messages are liable to change.

Error Types

There are three different types of link error:

Error TypeDescription
networkErrorThe user's device is offline.
clientErrorThere is a problem with the SDK integration.
invalidLinkTokenThe Link token is invalid.

Error codes for networkError error type

typecodedescriptionmessage
networkErrornetworkErrorThrown when the user's device is offline, or there is an issue communicating with the server.Uh oh, looks like your device is offline. Please try again later.

Error codes for clientError error type

typecodedescriptionmessage
clientErrorclientErrorThis error is thrown when the client modal is in an erroneous stateUh oh, looks like we're having trouble getting you connected. Please try again later.
clientErrorconnectionRateLimitedThis error is thrown when a client is rate-limited.Uh oh, looks like we're having trouble getting you connected. Please try again later.
systemErrorsystemErrorAn unhandled error occurs when a payroll integration behaves unexpectedly. These errors are fixed such that subsequent users do not trigger themUh oh, looks like we're having trouble getting you connected. Please try again later.

Error codes for networkError type

typecodedescriptionmessage
invalidLinkTokenexpiredLinkTokenThe link token has expired.Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later.
invalidLinkTokeninvalidLinkTokenThe link token is invalid.Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later.
invalidLinkTokeninvalidLinkTokenSignatureThe Link token signature is invalid.Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later.
invalidLinkTokenusedLinkTokenThe link token has already been used.Uh oh, something unexpected happened. We are trying to fix this as quickly as possible, so please try again later.

Please contact [email protected] for access to our Developer Dashboard.