Skip to content

JSON files specifying custom users suitable for testing Plaid integrations on Sandbox

License

Notifications You must be signed in to change notification settings

plaid/sandbox-custom-users

Repository files navigation

Overview

This repo contains JSON files specifying custom users suitable for testing Plaid integrations on Sandbox, to test complex or custom scenarios. These files are a starting place for testing -- you can also edit these files before adding them to Sandbox, in order to further customize the test data to your needs.

Tip

Also check out Plaid's selection of pre-populated Sandbox test users. These users are easier to work with than custom Sandbox users and allow you to test some common scenarios that custom Sandbox users don't support, like dynamically updating data (Transactions), or micro-deposit flows (Auth).

How to use these files

You can add these users to the Sandbox environment via the Test Users page in the Plaid Dashboard. For more details, see Configuring the custom user account in the Plaid documentation.

The dates in these test files are automatically updated daily such that the most recent date will be set to today, and then all other dates are adjusted proportionately. After loading these files into Sandbox, you may need to occasionally updates them so that Income transactions and data are within the past 90 days, and transactions for other products are within the last 2 years. You can do this by re-fetching these files from Github, or running the update_dates.py script.

If you want to customize these files further, see the Custom User configuration object schema for detailed documentation on available options and fields.

Warning

At OAuth institutions, certain less frequently used customized fields may be overridden by the default values after the Link flow has completed. If this occurs, retry the configuration using a non-OAuth institution.

Contributing

We encourage contributions to this repo. Feel free to submit and add your own test users. Important: never contribute real user data, even if it has been anonymized, unless it is your own, personal data that you have the right to share (i.e., not data belonging to a customer of your service).

About

JSON files specifying custom users suitable for testing Plaid integrations on Sandbox

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages