Link errors

This page provides common causes and troubleshooting suggestions for Link errors.

All errors (except generic) occur due to invalid Link configuration and are not expected to reach the production environment.

Link errors are returned with onError callback function.

The function will be passed the type of the error that occurred.

📘
Some error messages shown to the user have placeholders for [Link item name] and [Company name]. In such cases, for the screens samples below, they were replaced by Starbox and GoodLoans, respectively.

`callback_undefined`

Message to the users

This page does not exist. Reach out to $company for help.

Error details

Reason: callback undefined ($callback)

Common causes

Callback triggering was selected for the ‘If no results’ experience, but the onCantFindLinkItemClicked callback function is not defined.

Troubleshooting steps

Define the onCantFindLinkItemClicked callback in your implementation.

`card_issuer_unavailable`

Message to the users

The service is experiencing connection problems. Please try again later.

Error details

Reason: Partner system is currently unavailable.

Common causes

Third party system (Unit) failed to respond when retrieving card details required for a deposit update.

Troubleshooting steps

Reach out to Unit for help.

`expired_user_token`

Message to the users

The service is experiencing connection problems. Please try again later.

Error details

User ID: {userId}
Reason: expired userToken.

Common causes

userToken is a temporary access token that contains an expiration date. This error occurs when Link is initialized for a user with an expired userToken.

Troubleshooting steps

Generate a new userToken every time Link is initialized for a user.

`generic`

Message to the users

The service is experiencing connection problems. Please try again later.

Error details

N/A

Common causes

Something unexpected happened. Argyle is investigating.

Troubleshooting steps

Contact Argyle's support team for more details.

`invalid_link_items`

Message to the users

This page does not exist. Reach out to [Company name] for help.

Error details

N/A

Common causes

The user was deep linked to a Link item that does not exist. See Deep linking for additional information.
A constrained list of Link items was provided in the Link configuration, but all of the provided Link items do not exist.

Troubleshooting steps

Check if the Link item is available by calling GET /link-items/:id endpoint each time before initializing Link when deep linking or constraining a Link item list. In the case where you are keeping a map of available Link items on the backend, occasionally call GET /link-items endpoint to sync the newest updates.

`invalid_link_key`

Message to the users

Please make sure your linkKey is correct.

Error details

N/A

Common causes

The Link key used when initializing Link is invalid.

Troubleshooting steps

Check if you are using an appropriate Link key for the selected environment. There are separate Link keys for the sandbox and production environment. Link keys can be found in the API keys section of the Argyle Console.

`invalid_pd_config`

Message to the users

The service is experiencing connection problems. Please try again later.

Error details

Reason: invalid PD config.

Common causes

The payDistributionConfig provided when initializing Link is invalid.

Troubleshooting steps

Check the configuration parameters of the provided payDistributionConfig. See DDS configurations for additional information.
Check that the payDistributionConfig is encrypted correctly using the Argyle encryption endpoint. See our direct deposit switching guide for additional information.

`invalid_user_token`

Message to the users

The service is experiencing connection problems. Please try again later.

Error details

Reason: invalid userToken.

Common causes

User token provided during Link initialization is not a valid JTW token and could not be decoded.

Troubleshooting steps

Check if the used userToken is the same provided by /user-tokens endpoint.
Check if the user token is not modified (for example, additionally encoded) before being passed to Argyle during Link initialization.

`unsupported_android_version`

Message to the users

The page does not exist. Reach out to $company for help.

Error details

Reason: unsupported Android version. Forms are supported from Android SDK 26 (Oreo) and above.

Common causes

Upgrade your Android version to Android SDK 26 (Oreo) or higher.

Troubleshooting steps

Contact Argyle's support team for more details.