Switching between Plaid environments

When you've set up Plaid in UAT, and confirmed that you can connect and pull data from Plaid's sandbox, you might want to connect to Plaid Development or Production to complete your testing.

About Plaid Development

Plaid's development environment gives you free access to live bank accounts for testing.

Instant access to the development environment is available on request from Plaid.

About Plaid Production

Plaid's production environment gives you access to the live products and services that you've subscribed to. You might switch Codat's UAT environment to point to Plaid's production environment for final testing before go live.

Access to the production environment is available on request from Plaid.

Switch between environments

🚧

Creating new companies after switching environments

To avoid data inconsistencies, we recommend that you create new companies when you change environments. Any companies originally created in another environment are deauthorised and require reauthorisation.

Switch environments using the Codat portal

This is the easiest way to switch between Plaid's sandbox, development, and production environments.

  1. Open the Codat portal in UAT and log in.
  2. In the left pane, select Integrations > Banking.
  3. Find Plaid and select Manage next to it.
  4. From the Environment list, select the Plaid environment that you want to connect to.
  5. Select Save.

Switch environments using the Codat API

The following example shows how to switch Codat's UAT to point to Plaid Development instead of the sandbox from the API. You can use the same method to switch Plaid environments for Codat's UAT or Production environments.

Get your existing environment credentials.

  1. Open the GET /integrations/credentials/{platformKey} endpoint.
  2. Replace {platformKey} with plaid and send your request to return your current credentials. Save the JSON, you'll need it later.
{
    "publicKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXabdd", // For integrations set up before Aug 20, 2020
    "clientId": "XXXXXXXXXXXXXXXXXXXX2a6b",
    "clientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXX1ad1"
}

Find the secret for Plaid's development environment.

  1. Go to https://plaid.com and log in.
  2. From the top menu bar, select Team Settings > Keys and copy the Development secret.

Update your environment credentials.

  1. Open the
    PUT /integrations/credentials/{platformKey}
    endpoint.
  2. Replace {platformKey} with plaid and send the following details:
    • The existing environment credentials you fetched earlier, replacing the original clientSecret with the secret for the development environment.
    • The name of the environment that you want to switch to. In this case, development.
{
    "publicKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXabdd", // For integrations set up before Aug 20, 2020
    "clientId": "XXXXXXXXXXXXXXXXXXXX2a6b",
    "clientSecret": "999a3ac412bf7e3ea93dd1fcb14931",
    "environment": "development" // Environment names are "sandbox", "development" and "production"
    
}
  1. Send your request.
  2. Create new companies in the Codat UAT portal for testing.

Did this page help you?