/quickstart

Get up and running with Plaid Link and the API in minutes

Primary LanguageHTML

Plaid quickstart

This repository accompanies Plaid's quickstart guide.

Here you'll find full example integration apps using our client libraries:

If docker is available to you, you can quickly spin up an example using: % make QUICKSTART=go up. Be sure to have PLAID_CLIENT_ID and PLAID_SECRET defined in your environment or replace the respective ${VARIABLES} in the x-environment section in docker-compose.yml directly.

To further adjust the quickstart to your use-case, you can define PLAID_PRODUCTS, PLAID_COUNTRY_CODES, PLAID_REDIRECT_URI in your environment or set the respective ${VARIABLES} in in the x-environment section in docker-compose.yml directly.

Note - If you are attempting to test out the OAuth flow, you will need to register your PLAID_REDIRECT_URI in the Plaid dashboard. Additionally, if you want to use the Payment Initiation product, you will need to contact Sales to get this product enabled.

To see the log output of the quickstart run: % make QUICKSTART=go logs (when done, quit using CTRL-C).

To stop the quickstart use: % make QUICKSTART=go stop

Replace go in the command examples above with the name of the quickstart you want to start, e.g. python.

Plaid quickstart app