Plaid
Overview
The Plaid source supports Full Refresh syncs. It currently only supports pulling from the balances endpoint. It will soon support other data streams (e.g. transactions).
Output schema
Output streams:
Features
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental - Append Sync | Coming soon |
| Replicate Incremental Deletes | Coming soon |
| SSL connection | Yes |
| Namespaces | No |
Performance considerations
The Plaid connector should not run into Stripe API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Getting started
Requirements
- Plaid Account (with client_id and API key)
- Access Token
Setup guide for Sandbox
This guide will walk through how to create the credentials you need to run this source in the sandbox of a new plaid account. For production use, consider using the Link functionality that Plaid provides here
-
Create a Plaid account Go to the plaid website and click "Get API Keys". Follow the instructions to create an account.
-
Get Client id and API key Go to the keys page where you will find the client id and your Sandbox API Key (in the UI this key is just called "Sandbox").
-
Create an Access Token First you have to create a public token key and then you can create an access token.
-
Create public key Make this API call described in plaid docs
curl --location --request POST 'https://sandbox.plaid.com/sandbox/public_token/create' \
--header 'Content-Type: application/json;charset=UTF-16' \
--data-raw '{
"client_id": "<your-client-id>",
"secret": "<your-sandbox-api-key>",
"institution_id": "ins_127287",
"initial_products": ["auth", "transactions"]
}' -
Exchange public key for access token Make this API call described in plaid docs. The public token used in this request, is the token returned in the response of the previous request. This request will return an
access_token, which is the last field we need to generate for the config for this source!curl --location --request POST 'https://sandbox.plaid.com/item/public_token/exchange' \
--header 'Content-Type: application/json;charset=UTF-16' \
--data-raw '{
"client_id": "<your-client-id>",
"secret": "<your-sandbox-api-key>",
"public_token": "<public-token-returned-by-previous-request>"
}'
-
-
We should now have everything we need to configure this source in the UI.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.5.1 | 2024-08-16 | 44196 | Bump source-declarative-manifest version |
| 0.5.0 | 2024-08-14 | 44086 | Refactor connector to manifest-only format |
| 0.4.13 | 2024-08-12 | 43861 | Update dependencies |
| 0.4.12 | 2024-08-10 | 43663 | Update dependencies |
| 0.4.11 | 2024-08-03 | 43239 | Update dependencies |
| 0.4.10 | 2024-07-27 | 42686 | Update dependencies |
| 0.4.9 | 2024-07-20 | 42230 | Update dependencies |
| 0.4.8 | 2024-07-13 | 41730 | Update dependencies |
| 0.4.7 | 2024-07-10 | 41412 | Update dependencies |
| 0.4.6 | 2024-07-09 | 41235 | Update dependencies |
| 0.4.5 | 2024-07-06 | 41007 | Update dependencies |
| 0.4.4 | 2024-06-25 | 40379 | Update dependencies |
| 0.4.3 | 2024-06-22 | 40147 | Update dependencies |
| 0.4.2 | 2024-06-04 | 38963 | [autopull] Upgrade base image to v1.2.1 |
| 0.4.1 | 2024-05-31 | 38810 | [autopull] Migrate to base image and poetry |
| 0.4.0 | 2023-08-17 | 29127 | Rewrote connector to no-code SDK |
| 0.3.2 | 2022-08-02 | 15231 | Added min_last_updated_datetime support for Capital One items |
| 0.3.1 | 2022-03-31 | 11104 | Fix 100 record limit and added start_date |
| 0.3.0 | 2022-01-05 | 7977 | Migrate to Python CDK + add transaction stream |