-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
97b82bf
commit 8fab230
Showing
1 changed file
with
6 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,15 @@ | ||
# Overview | ||
This repo contains JSON files specifying custom users suitable for testing Plaid integrations on Sandbox, to test scenarios more complex than those provided by the basic `user_good` / `pass_good` Sandbox test user. 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. | ||
|
||
This repo contains JSON files specifying custom users suitable for testing Plaid integrations on Sandbox, to test scenarios more complex than those provided by the basic `user_good` / `pass_good` Sandbox test user. 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. | ||
|
||
# How to use these files | ||
|
||
You can add these users to the Sandbox environment via the [Test Users page in the Plaid Dashboard](https://dashboard.plaid.com/developers/sandbox?tab=testUsers). For more details, see [Configuring the custom user account](https://plaid.com/docs/sandbox/user-custom/#configuring-the-custom-user-account) in the Plaid documentation. | ||
|
||
Before loading the files into Sandbox, you may need to update the dates in the test files. For example, Income transactions and data should be updated to be within the past 90 days, and transactions for other products should be within the last 2 years. | ||
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](https://plaid.com/docs/sandbox/user-custom/#configuration-object-schema) for detailed documentation on available options and fields. | ||
|
||
# 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). | ||
|
||
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). |