• Installs:
  • Today: 0
  • This Week: 0
  • This Month: 0
  • All Time: 131
Developer:userraygorodskij

Plaid API Package

Access high-quality transaction data, validate account ownership, and mitigate risks in a user-friendly way.

List of Endpoints
This is the list of endpoints this API includes. To add of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

Plaid

Plaid Package

Our technology makes it easy to access high-quality transaction data, validate account ownership, and mitigate risks in a user-friendly way.

  • Domain: plaid.com
  • Credentials: clientId,publicKey,secret

How to get credentials:

  1. Register on plaid.com.
  2. After creation your account you will see api clientId,api publicKey and secret.
  3. To get the publicToken you need to create Plaid link with your api publicKey.
  4. After authorization, your publicToken will be visible in the GET parameters.

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Plaid.getAccessToken

Exchange a Link publicToken for an API accessToken.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
publicTokenStringShort-lived API token.

Plaid.getSingleItem

The getSingleItem endpoint returns information about the status of an Item: Available products; Billed products; Error status; Institution ID ;Item ID; Webhook;

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.

Plaid.getAuth

The getAuth endpoint allows you to retrieve the bank account and routing numbers associated with an Item’s checking and savings accounts, along with high-level account data and balances.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.
accountIdsListA list of accountIds to retrieve for the Item.Note: An error will be returned if a provided accountId is not associated with the Item.

Plaid.getAccountsBalance

The getAccountsBalance endpoint returns the real-time balance for each of an Item’s accounts.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.
accountIdsListA list of accountIds to retrieve for the Item.Note: An error will be returned if a provided accountId is not associated with the Item.

Plaid.getAllInstitutions

Returns response containing details on all financial institutions currently supported by Plaid.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.
countNumberThe total number of Institutions to return. The minimum is 0 and the maximum is 500.
offsetNumberThe number of Institutions to skip before returning results. The minimum is 1. There is no maximum.
ProductsTypeListA list of accountIds to retrieve for the Item.Note: An error will be returned if a provided accountId is not associated with the Item.

Plaid.getSingleInstitution

Returns response containing details on a specified financial institution currently supported by Plaid.

FieldTypeDescription
publicKeycredentialsPublic API key from user dashboard.
institutionIdStringSingle institution id.

Plaid.getCategories

Send a request to the getCategories endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.

No arguments.

Plaid.searchInstitution

Returns response containing details on a specified financial institution currently supported by Plaid.

FieldTypeDescription
publicKeycredentialsPublic API key from user dashboard.
productsTypeListFilter the Institutions based on whether they support all products listed in products.
querySearchStringThe search query.Institutions with names matching the query are returned.

Plaid.createWebhook

The createWebhook allows you to create the webhook associated with an Item.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.
webhookUrlStringThe new webhookUrl to associate with the Item.

Plaid.updateWebhook

The updateWebhook allows you to update the webhook associated with an Item.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.
webhookUrlStringThe new webhookUrl to associate with the Item.

Plaid.getAccounts

The getAccounts endpoint returns information about accounts.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.

Plaid.getPublicToken

If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the getAccounts.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.

Plaid.getAccountsTransactions

The getAccountsTransactions endpoint allows developers to receive user-authorized transaction data for credit and depository-type Accounts.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.
startDateDatePickerStarting date of transaction processing.
endDateDatePickerEnding date of transaction processing.
countNumberThe total number of transactions to return.
offsetNumberThe number of transaction to skip before returning results.

Plaid.rotateAccessToken

You can use the rotateAccessToken endpoint to rotate the accessToken associated with an Item.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.

Plaid.getIncome

The getIncome endpoint allows you to retrieve information pertaining to a Item’s income.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.

Plaid.getIdentity

The getIdentity endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.

Plaid.deleteItem

The deleteItem endpoint allows you to delete an Item

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.

Plaid.resetItemLogin

The resetItemLogin endpoint allows you put an Item in an ITEM_LOGIN_REQUIRED error state.

FieldTypeDescription
clientIdcredentialsPrivate API key from user dashboard.
secretcredentialsPrivate API key from user dashboard.
accessTokenStringA rotatable API token unique to a single Item.
x
circle
Plaid
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Connect your app to APIs via RapidAPI

Consume and monitor multiple APIs through the RapidAPI SDK.
Click start to set up your app and connect to your first API.

START

Give your app a name

This app will be used in RapidAPI to collect and connect all the APIs you need.

NEXT

Connect your project

Choose your backend language and then install & require the RapidAPI SDK.

  • node
    NodeJS
  • php
    PHP
  • python
    Python
  • objc
    Obj-C
  • android
    Android
  • go
    GO
  • ruby
    Ruby
  • csharp
    C#

Install SDK

Run the following command to install the SDK:

npm install rapidapi-connect --save

Require SDK

In your code, add the following code to require the RapidAPI SDK:

NEXT

Hooray! You are connected

Use the following code to try it out by getting all the APIs that are on RapidAPI.

rapid.call('RapidAPI', 'getAll', {'{}'});
FINISH
esccloses this view
x

Login to RapidAPI

Create endpoints based on popular APIs and share with others.
Follow popular APIs and get updated. Stand out in the community of developers.

Login with Github
Login with Facebook
Login with Google
Or
Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view