Plaid Module
- 09 Dec 2024
- 8 Minutes to read
- Print
- DarkLight
Plaid Module
- Updated on 09 Dec 2024
- 8 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Module Details | |
| Core or Github Module | Decisions.Plaid |
| Restart Required | No |
| Steps Exposed | Yes |
| Step Location | Integrations > Plaid |
| Settings Location | System > Settings > Plaid Settings |
| Prerequisites |
|
The Plaid Module facilitates seamless integration with Plaid services, enabling users to securely authenticate bank accounts, retrieve account details, and perform financial transactions within workflows. Ensure you have the credentials and permissions from Plaid to establish a secure connection and access banking information effectively. For detailed information, refer to Plaid's official documentation or support resources tailored to the use case.
Configuration
Once the Plaid Module is installed, navigate to System > Settings > Plaid Settings and set the Base URL. There are three different Base URL environments: Sandbox, Development, and Production.
Steps Available
Explore Plaid's comprehensive functionality through various steps available in the Module:
| Step Name | Description |
|---|---|
| Get Accounts | Retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — accounts that are not closed and capable of carrying a balance. |
| Get Accounts Balance | Returns the real-time balance for each of an Item's accounts. |
| Get Application | Retrieve information about a specific application within the Plaid integration. |
| List Applications | Retrieve a list of applications available in Plaid. |
| Update Application Scopes | Modify or update the scopes associated with a particular application in the Plaid integration. |
| Create Asset Report | Initiates creating an Asset Report, which can then be retrieved by passing the asset_report_token return value to the /asset_report/get or /asset_report/pdf/get endpoints. |
| Create Asset Report Audit Copy | Create an audit copy of the asset report in Plaid. |
| Filter Asset Report | Apply filters to refine the content of the asset report. |
| Get Asset Report | Retrieves the Asset Report in JSON format. Before calling /asset_report/get, you must first create the Asset Report using /asset_report/create (or filter an Asset Report using /asset_report/filter) and then wait for the PRODUCT_READY webhook to fire, indicating that the Report is ready to be retrieved. |
| Get Asset Report Audit Copy | Retrieve an audit copy of the asset report Plaid. |
| Get Asset Report PDF | Obtain the asset report in PDF format. |
| Refresh Asset Report | Create a new Asset Report based on the old one but with the most recent data available. |
| Remove Asset Report | Remove an Asset Report. Removing an Asset Report invalidates its asset_report_token, meaning you will no longer be able to use it to access Report data or create new Audit Copies. |
| Remove Asset Report Audit Copy | Remove an Audit Copy. Removing an Audit Copy invalidates the audit_copy_token associated with it, meaning you and any third parties holding the token can no longer access Report data. |
| Get Auth Data | Retrieve authentication-related data from Plaid. |
| Cancel Bank Transfer | Cancel a bank transfer transaction. |
| Create Bank Transfer | Initiate the creation of a bank transfer. |
| Get Bank Transfer | Fetches information about the transfer corresponding to the given transfer_id. |
| Get Bank Transfer Balance | Retrieve the balance related to a bank transfer. |
| Get Sweep | Fetches a sweep corresponding to the given sweep_id. |
| List Bank Transfer Events | Get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. |
| List Bank Transfers | See a list of all transfers and their statuses. |
| List Sweeps | Fetches sweeps matching the given filters. |
| Migrate Account into Bank Transfers | Migrate known account and routing numbers to Plaid Items. |
| Sync Bank Transfer Events | Request up to the next 25 Plaid-initiated bank transfer events after a specific event_id. |
| Get Categories | Get detailed information on categories returned by Plaid. This endpoint does not require authentication. |
| Create Deposit Switch | Initiates the process of creating a deposit switch. |
| Create Deposit Switch Token | Generates a token required for creating a deposit switch. |
| Create Non-Plaid Deposit Switch | Similar to the "Create Deposit Switch" step but specifically designed for creating a deposit switch involving non-Plaid entities or systems. |
| Get Deposit Switch | Retrieves information or details about a previously created deposit switch. |
| Find Employer | Information about an employer associated with an account. |
| Get Employment Verification | Returns a list of items with employment information from a user's payroll provider verified by an end user. |
| Get Identity | Retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. |
| Create Income Verification | Create a new Identity Verification for the user specified by the client_user_id field. |
| Get Income Verification (Paystubs) | Gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay-related document. |
| Get Income Verification (Tax forms) | Gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay-related document. |
| Get Income Verification Summary | Retrieve a previously created identity verification. |
| Get Original Documentation | Retrieve original documentation or records associated with a specific transaction, account, or financial action. |
| Income Verification Precheck | |
| Refresh Income Verification | Allow a customer to retry their identity verification. |
| Find Institutions | Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. |
| Get Institution by Id | Returns a JSON response containing details on a specified financial institution currently supported by Plaid. |
| Get Institutions | Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. |
| Get Investment Holdings | Receive user-authorized stock position data for investment-type accounts. |
| Get Investment Transactions | Retrieve up to 24 months of user-authorized transaction data for investment accounts. |
| Create Public Token | Create a valid public_token for an arbitrary institution ID, initial products, and test credentials. |
| Exchange Public Token For access_token | Exchange a Link public_token for an API access_token. Link hands off the public_token client-side via the onSuccess callback once a user has created an Item. The public_token is ephemeral and expires after 30 minutes. An access_token does not expire but can be revoked using the Remove Item step. |
| Get Item | Returns information about the status of an Item. |
| Import Item | |
| Invalidate access_token | Rotate the access_token associated with an Item. The endpoint returns a new access_token and immediately invalidates the previous access_token. |
| Remove Item | Remove an Item. Once removed, the access_token, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. |
| Update Item Webhook | Update the webhook URL associated with an Item. This request triggers a WEBHOOK_UPDATE_ACKNOWLEDGED webhook to the newly specified webhook URL. |
| Get Liabilities | Returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. |
| Create Link Token | Creates a link_token, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a public_token, which can then be exchanged for an access_token |
| Get Link Token | Gets information about a previously-created link_token using the /link/token/create endpoint. |
| Create Payment | After creating a payment recipient, use this step to create a payment to that recipient. |
| Create Payment Recipient | Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country supported by Plaid. For payments in the US, see the Transfer steps. |
| Create Payment Token | |
| Get Payment Details | Check the payment status and receive basic information such as recipient and payment amount. |
| Get Payment Recipient | Get details about a payment recipient previously created. |
| List Payment Recipients | List the payment recipients previously created. |
| List Payments | Retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional count and cursor parameters. |
| Reverse Payment | Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. |
| Create Apex Bank Account Token | Used to create a token suitable for sending to Apex to enable Plaid-Stripe integrations. |
| Create Bank Transfer as Processor | |
| Create Processor Token | Used to create a token suitable for sending to one of Plaid's partners to enable integrations. |
| Create Stripe Bank Account Token | Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. |
| Get Auth Data | Used to get a processor token's product permissions. The products field will be an empty list if the processor can access all available products. |
| Get Balance Data | Returns the real-time balance for each of an Item's accounts. |
| Retrieve Identity Data | Retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. |
| Create Test Item | Create a valid public_token for an arbitrary institution ID, initial products, and test credentials. The created public_token maps to a new Sandbox Item. |
| Create Test Item and Processor Token | Create a valid processor_token for an arbitrary institution ID and test credentials. The created processor_token corresponds to a new Sandbox Item. |
| Fire Test Webhook | Test that the code correctly handles webhooks. |
| Force Sandbox Item into Error State | Forces an Item into an ITEM_LOGIN_REQUIRED state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's update mode flow in the Sandbox environment. |
| Manually Fire Bank Transfer Webhook | Manually trigger a TRANSFER_EVENTS_UPDATE webhook in the Sandbox environment. |
| Manually Fire Income Webhook | Manually trigger a Payroll or Document Income webhook in the Sandbox environment. |
| Save Selected Accounts for Platypus OAuth | |
| Set Verification Status for Sandbox Account | Change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. |
| Simulate Bank Transfer Event in Sandbox | |
| Simulate Transfer Event in Sandbox | Simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and appear, no transactions will occur, and funds will not move between accounts, even within the Sandbox. |
| Evaluate Planned ACH Transaction | Evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. |
| Report ACH Transaction Initiation | Report whether you initiated an ACH transaction. |
| Report ACH Transaction Return | Report a returned transaction previously sent to the Evaluate Planned ACH Transaction endpoint. |
| Get Incremental Transaction Updates on Item | Subscribe to all transactions associated with an Item and get updates synchronously. |
| Get Recurring Transaction Streams | Receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings, or credit card accounts. Additionally, Plaid provides key insights about each recurring stream, including the category, merchant, last amount, and more. |
| Get Transaction Data | Receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student; coverage may be limited). |
| Refresh Transaction Data | Initiates an on-demand extraction to fetch the newest transactions for an Item. |
| Cancel Transfer | Cancel a transfer. A transfer is eligible for cancellation if the cancellable property is true. |
| Create Transfer | Initiate a new transfer. |
| Create Transfer Authorization | Authorize a transfer. This endpoint must be called prior to calling Create Transfer. |
| Get Transfer | Fetches information about the transfer corresponding to the given transfer_id. |
| List Transfer Events | Get a list of transfer events based on specified filter criteria. |
| List Transfers | List of all transfers and their statuses. Results are paginated; the count and offset query parameters retrieve the desired transfers. |
| Sync Transfer Events | Request up to the next 25 transfer events after a specific event_id. |
| Get Webhook Verification Key | Retrieve the verification key used for webhook endpoints. This verification key is used to verify the integrity and origin of the data received via webhooks, enhancing the overall security of your integration by confirming the authenticity of incoming Plaid webhook notifications. |
Was this article helpful?
