Plaid logo
Docs
ALL DOCS

Transactions

  • Introduction to Transactions
  • Add Transactions to your app
  • Transactions webhooks
  • Transaction states
  • Transactions sync migration guide
  • Troubleshooting

Run the Quickstart

A guide to get started building with Plaid

Introduction

You’ll be using both your app’s server and client to add Plaid to your app. Here is an overview of how you’ll be using Plaid.

The Plaid flow begins when your user wants to connect their bank account to your app.
Step  diagram
1Call /link/token/create to create a link_token and pass the temporary token to your app's client.
Step 1 diagram
2Use the link_token to open Link for your user. In the onSuccess callback, Link will provide a temporary public_token.
Step 2 diagram
3Call /item/public_token/exchange to exchange the public_token for a permanent access_token and item_id for the new Item.
Step 3 diagram
4Store the access_token and use it to make product requests for your user's Item.
Step 4 diagram

Run the Quickstart app

Let’s test out running Plaid locally by cloning the Quickstart app. You’ll need API keys, which you can receive by signing up in the Dashboard. If you want to get started adding Plaid to an exsiting codebase, you can jump ahead to Adding Transactions to your app.

You’ll be running the web Quickstart which showcases the server and client-side pieces to a Plaid integration.

Select Language
Copy
1# Note: If on Windows, run
2# git clone -c core.symlinks=true https://github.com/plaid/quickstart
3# instead to ensure correct symlink behavior
4
5git clone https://github.com/plaid/quickstart.git
6cd quickstart/node
7
8# Copy the .env.example file to .env, then fill
9# out PLAID_CLIENT_ID and PLAID_SECRET in .env
10cp .env.example .env
11
12# Install dependencies
13npm install
14
15# Start the backend app
16./start.sh
2. Visit localhost and log in with Sandbox credentials

Now that you have the Quickstart running, you’ll add your first Item in the Sandbox environment. Once you’ve opened the Quickstart app on localhost, open Link and select any institution. Use the Sandbox credentials to simulate a successful login.

Sandbox credentials
1username: user_good
2password: pass_good

Great! Once you’ve successfully added an Item, the Quickstart allows you to simulate product requests. We’ve started the app with transactions, so only the Transactions product requests will work. Try adding other products to the run script with PLAID_PRODUCTS=auth,transactions,balance to test them out.

Congrats! You’re all ready to dive right in to adding Transactions to an existing app.

Next steps

Start building

Add Transactions to your app

View guide
Was this helpful?
Developer community
GitHub
GitHub
Stack Overflow
Stack Overflow
YouTube
YouTube
Twitter
Twitter
Discord
Discord