Plaid Setup

​

1. Obtain Your Plaid Credentials

1. Log in to your Plaid Dashboard.
2. Navigate to Developers > Keys or go directly to Account Keys.
3. Copy your Client ID and Secret for the environment you wish to use (Sandbox, Development, or Production).

​

2. Configure Environment Variables

# The Plaid environment to use ('sandbox', 'development', or 'production').
# See: https://plaid.com/docs/#api-host
PLAID_ENV=sandbox

# Your Plaid keys, which can be found in the Plaid Dashboard.
# https://dashboard.plaid.com/account/keys
PLAID_CLIENT_ID=your_client_id_here
PLAID_SECRET=your_secret_here

# (Optional) Webhook URL for Plaid Link events.
PLAID_LINK_WEBHOOK=https://your-domain.com/api/banking/plaid/webhooks

​

Variable Descriptions

• PLAID_ENV: The Plaid environment to use. Use sandbox for testing, development for real data with limited access, or production for live data.
• PLAID_CLIENT_ID: Your unique Plaid client ID from the dashboard.
• PLAID_SECRET: Your Plaid secret key from the dashboard.
• PLAID_LINK_WEBHOOK: (Optional) The URL where Plaid will send webhook events. This should be publicly accessible if you want to receive real-time updates from Plaid.

​

4. Setting Up the Webhook (Optional)

1. Deploy your API endpoint to a publicly accessible URL (e.g., using ngrok for local development).
2. Set the PLAID_LINK_WEBHOOK variable to your endpoint URL.
3. Ensure your endpoint is configured to handle Plaid webhook events. See Plaid Webhooks Documentation - To configure your webhook URL in the Plaid Dashboard.
   • From Plaid Dashboard. Go to Developers > Webhook URLs.
   • Click Add webhook URL (or edit an existing one).
   • Enter your endpoint URL (the same as PLAID_LINK_WEBHOOK).
   • Save your changes. For more details, see the Plaid Webhook Configuration Guide.

​

5. Enable Bank Feeds Feature

BANK_FEED_ENABLED=true

​

Additional Resources

• Plaid API Documentation
• Plaid Dashboard
• Plaid Webhooks