Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 7.59 KB

README.md

File metadata and controls

88 lines (66 loc) · 7.59 KB
Raw

Plaid Postman Collections

Welcome to the Postman Collections Quickstart Guide! If you're looking for a quick and easy way to get started with the Plaid API with no additional code, this is the place for you. Postman is a great tool that allows users explore API functionality by manually sending API requests and receiving responses. We have created a collection of pre-populated HTTP requests that can be sent to the Plaid API. This quickstart is a step-by-step guide that will get you up and running with Postman and the Plaid’s Postman collection to enable you for ad-hoc exploration and testing.

If you are looking for a more in-depth guide and reference for the Plaid API, please refer to the Plaid API documentation.

plaid-postman-overview

Getting started

Follow these steps to quickly get started with the Plaid API:

  1. Sign up with Plaid to get a set of API keys that are required for interacting with the API. Here is some documentation explaining what these keys are.
  2. Download and install the Postman app
  3. Install the Plaid Postman Collection. Click the "Run with Postman" button below to install the Plaid collection! Run in Postman
  4. Once both the collection and the environment variables are imported into Postman, see the Configuration section on how to correctly configure API keys with the collection.

Configuration

The Plaid Postman collection uses Postman environment variables to simplify each API request. More information on managing Postman environments can be found at Setting up an environment with variables.

plaid-postman-configuration

  1. Select the Sandbox Public environment in the top right corner
  2. Click the eye icon to open the environment settings
  3. Copy in your Plaid API keys from your Plaid Dashboard, into each field:
  • client_id
  • public_key
  • secret
  1. Save your changes and start making Plaid API requests!

Collection endpoints

The following collection is a fully-featured set of pre-filled requests that allow you to test the Plaid API, and visualize the responses in a friendly format.

  • Items

    • Create Item [Sandbox Only] - Creates an Item by generating a public token. This endpoint only works in the Sandbox environment. Items can only be created through Plaid Link in the development and production environments.
    • Exchange Token - Exchanges a public token for an access token.
    • Retrieve Item - Retrieves information about an Item.
    • Retrieve an Item's Accounts - Retrieves all available accounts for an Item.
    • Create a public_token - Generates a public_token for an existing Item for use in Plaid Link's update mode.
    • Rotate Access Token - Returns a new access token and invalidates the old one.
    • Update an Item's Webhook - Updates an Item's webhook url.
    • Simulate ITEM_LOGIN_REQUIRED [Sandbox Only] - Sets an Item in an ITEM_LOGIN_REQUIRED state. Check our Errors section in our docs for more information.
    • Remove Item - Deletes an Item using its access token.

  • Auth

    • Retrieve Auth - Retrieves the bank account and routing numbers associated with an Item’s checking and savings accounts, along with high-level account data and balances.

  • Transactions

    • Retrieve Transactions - Retrieves user-authorized transaction data for credit and depository-type Accounts. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available.

  • Balance

    • Retrieve Balance - Retrieves the real-time balance for each of an Item’s accounts.

  • Identity

    • Retrieve Identity - Retrieves various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

  • Income

    • Retrieve Income - Retrieves information pertaining to an Item’s income. In addition to the annual income, detailed information will be provided for each contributing income stream (or job).

  • Liabilities

    • Retrieve Liabilities - Retrieves information pertaining to an Item's liabilities.

  • Investments

    • Retrieve Investments Holdings - Retrieves information pertaining to an Item's Holdings for the Investments product.
    • Retrieve Investments Transactions - Retrieves information pertaining to an Item's Transactions for the Investments product.

  • Assets

    • Create Asset Report - Creates an Asset Report.
    • Retrieve an Asset Report (JSON) - Retrieves an Asset Report in JSON.
    • Retrieve an Asset Report (PDF) - Retrieves an Asset Report in PDF.
    • Create Audit Copy - Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. This endpoint creates that Audit Copy.
    • Remove Asset Report - Removes an Asset Report.
    • Remove Audit Copy - Removes an Audit Copy.
    • Refresh Asset Report - Create a new Asset Report based on the old one, but with the most recent data available from the financial institution(s).

  • Institutions

    • Search Institution by Name - Retrieves information about a specific institution by name.
    • Search Institution by ID - Retrieves information about a specific institution by ID.
    • Retrieve Institution List - Retrieves a list of all supported institutions.

  • Categories

    • Retrieve Categories - Retrieves detailed information on categories returned by Plaid. This endpoint does not require authentication.

Useful Tools

Webhook Tester is a great tool for receiving webhook calls. Generate a webhook url on this site and use that url for any Postman requests that require you to specify a webhook url. You can go on Webhook Tester to see a list of all requests being made to that url.

Important Note

The /public_token/create endpoint is only available in the sandbox environment. It exists only for testing purposes and simulates an Item Creation via the Plaid Link module. Items cannot be created directly via an endpoint for the development and production environments and can only be created through Plaid Link.