Plaid

Plaid API

Link a Sandbox bank account, exchange tokens, then read accounts, balances, Auth numbers, identity and synced transactions.

Finance & bankingGuided#open-banking#bank-accounts#transactions#ach#sandbox

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Plaid connects apps to their users' bank accounts. A user links an account through Plaid Link (a front-end widget); your server swaps the resulting public_token for an access_token and then calls product endpoints: Auth (account and routing numbers), Balance, Identity (account-holder names, emails, addresses) and Transactions (incremental sync). This guided collection runs the whole flow in Plaid's Sandbox without a browser, by creating test Items directly with a Sandbox-only endpoint.

Get credentials

  1. Sign up for a free Plaid Dashboard account at https://dashboard.plaid.com/signup.
  2. Open Developers > Keys in the Dashboard (https://dashboard.plaid.com/developers/keys) and copy your client_id and the Sandbox secret. Production secrets need a production access request and are different values.
  3. Paste them into clientId and secret (both marked secret). Nothing else is required to run this collection.

Authentication

There is no Authorization header. Every request is a POST with a JSON body that carries client_id and secret (the collection fills them from variables). Plaid also accepts them as the headers PLAID-CLIENT-ID and PLAID-SECRET instead. Requests about a linked account add the Item's access_token in the body. Each request also sends Plaid-Version: 2020-09-14, the current API version, so responses do not change if the Dashboard default is changed.

Base URLs

EnvironmentBase URL
Sandbox (test data, free)https://sandbox.plaid.com
Production (real banks)https://production.plaid.com

Items and tokens cannot move between environments: a sandbox access_token only works on the sandbox host.

Variables and run order

  1. 1. Start here: create a Link token (what your front end would open) and look up the test bank First Platypus Bank (ins_109508).
  2. 2. Create a test Item: /sandbox/public_token/create returns a public_token (saved), and /item/public_token/exchange saves accessToken and itemId.
  3. 3. Account data, 4. Transactions and 5. Item lifecycle then use accessToken. Run /item/remove last.

Sandbox logins: user_good / pass_good for most products; user_transactions_dynamic (any password) gives transaction data that changes when you call /transactions/refresh. See https://plaid.com/docs/sandbox/test-credentials/

Limits and pricing

Sandbox is free. Production is billed per product (per Item, per call or monthly, depending on the product) and endpoints are rate limited per Item and per client; exceeding them returns RATE_LIMIT_EXCEEDED. See https://plaid.com/pricing/ and https://plaid.com/docs/errors/rate-limit-exceeded/

Common errors

Errors come back as JSON with error_type, error_code, error_message, display_message and request_id. Branch on error_code, not the HTTP status.

error_codeMeaningWhat to do
INVALID_API_KEYSWrong client_id/secret, or a secret for another environmentUse the Sandbox secret with the sandbox host.
INVALID_ACCESS_TOKENToken malformed, removed, or from another environmentRe-run the exchange request.
ITEM_LOGIN_REQUIREDThe bank login or consent expiredSend the user through Link update mode (folder 5).
PRODUCT_NOT_READYPlaid is still pulling the dataWait for the webhook or retry shortly.
RATE_LIMIT_EXCEEDEDToo many requestsBack off and retry later.

Links

  • API reference: https://plaid.com/docs/api/
  • Sandbox guide: https://plaid.com/docs/sandbox/
  • Link: https://plaid.com/docs/link/
  • Transactions sync: https://plaid.com/docs/api/products/transactions/
  • Errors: https://plaid.com/docs/errors/
  • OpenAPI file: https://github.com/plaid/plaid-openapi

Endpoints 19

1. Start here

  • POSTCreate a Link token/link/token/createCreates a short-lived link_token that your front end passes to Plaid Link so the user can pick a bank and log in. Required: client_name (up to 30 characters),…
  • POSTGet an institution by ID/institutions/get_by_idReads one bank's record: name, supported products, country_codes and whether it uses OAuth. ins_109508 is First Platypus Bank, a Sandbox test bank that does…
  • POSTSearch institutions/institutions/searchFinds banks whose names match query, optionally only those that support all the listed products. Useful for building your own bank picker or checking coverage…

2. Create a test Item

  • POSTCreate a sandbox public token/sandbox/public_token/createSandbox only. Creates a test Item at institution_id with the initial_products you list and returns a public_token, exactly what Link's onSuccess would hand…
  • POSTExchange the public token/item/public_token/exchangeSwaps the one-time public_token for a permanent access_token and the item_id. Do this on your server and store both: the access token is the key to every…
  • POSTGet the Item/item/getReads the Item: its institution, the products billed and available, the webhook URL, consent expiry and any current error (for example ITEM_LOGIN_REQUIRED).…

3. Account data

  • POSTGet accounts/accounts/getLists the Item's accounts with account_id, name, mask (last digits), type/subtype and cached balances. The balances may be hours old; use the Balance request…
  • POSTGet live balances/accounts/balance/getFetches balances in real time from the bank, so it is slower than Get accounts and billed per call in Production. available is what can be spent now; current…
  • POSTGet account and routing numbers (Auth)/auth/getReturns the bank details needed to pay or debit the account: numbers.ach (US account and routing numbers), plus eft, international and bacs arrays for other…
  • POSTGet account holder identity (Identity)/identity/getReturns the bank's records of who owns each account: owners[] with names, emails, phone_numbers and addresses. Use it to match the linked account to the…

4. Transactions

  • POSTSync transactions (first page)/transactions/syncGets transaction changes since the last call. The first call has no cursor and returns the history; every response returns next_cursor, which you store and…
  • POSTSync transactions (next page)/transactions/syncSame call with cursor set to the saved next_cursor. Repeat while has_more is true; when it is false you are up to date, so keep the cursor until the next…
  • POSTRefresh transactions/transactions/refreshAsks Plaid to check the bank for new transactions now instead of waiting for the next scheduled update. It returns at once; new data arrives later and…
  • POSTGet recurring transactions/transactions/recurring/getGroups transactions into recurring streams such as salary or subscriptions, split into inflow_streams and outflow_streams, each with frequency, average and…

5. Item lifecycle and webhooks

  • POSTUpdate the Item's webhook/item/webhook/updateSets or changes the URL Plaid POSTs webhooks to for this Item (transactions updates, errors, consent expiry). Use an HTTPS endpoint on your server; set it to…
  • POSTFire a test webhook (Sandbox)/sandbox/item/fire_webhookSandbox only. Makes Plaid send a webhook to the Item's URL so you can test your handler. Pick webhook_type (for example TRANSACTIONS or ITEM) and a…
  • POSTBreak the login (Sandbox)/sandbox/item/reset_loginSandbox only. Puts the Item into the ITEM_LOGIN_REQUIRED state, as if the user changed their bank password. Data calls then fail with that error until the…
  • POSTCreate a Link token for update mode/link/token/createCreates a Link token tied to an existing Item by passing its access_token and leaving products out. Opening Link with it lets the user log in again and…
  • POSTRemove the Item/item/removeDeletes the Item and invalidates its access_token, ending billing for subscription products. Call it when a user disconnects their bank or closes their…

API details

Base URL
https://sandbox.plaid.com
https://production.plaid.com
Authentication
An API key in the PLAID-CLIENT-ID header
An API key in the PLAID-SECRET header
Operations
19 operations on 19 pathsPOST 19
Main resources
1. Start here 32. Create a test Item 33. Account data 44. Transactions 45. Item lifecycle and webhooks 5
Description format
Swastik Codes guided collection, API version checked against the docs on 2026-11-18

How to test the Plaid API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Plaid API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the PLAID-CLIENT-ID header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create a Link token” (POST /link/token/create), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Plaid API?

Link a Sandbox bank account, exchange tokens, then read accounts, balances, Auth numbers, identity and synced transactions. It is listed under Finance & banking and has 19 endpoints.

Who publishes the Plaid API?

It is listed from Plaid's public API description (an OpenAPI document), not published by Plaid on Swastik Codes. Anyone who controls plaid.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Plaid API?

Its description lists 2 base URLs: https://sandbox.plaid.com, https://production.plaid.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Plaid API?

It accepts 2 methods: an API key in the PLAID-CLIENT-ID header; an API key in the PLAID-SECRET header.

How many endpoints does the Plaid API have?

19 operations on 19 paths (19 POST). The largest groups are 1. Start here, 2. Create a test Item, 3. Account data, 4. Transactions.

Is forking the Plaid API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.