Plaid

The Plaid API

The Plaid REST API. Please see https://plaid.com/docs/api for more details.

Finance & banking#openapi#financial

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

The Plaid REST API. Please see https://plaid.com/docs/api for more details.

Endpoints 198

plaid

  • POSTRetrieve real-time balance data/accounts/balance/getThe /accounts/balance/get endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only…
  • POSTRetrieve accounts/accounts/getThe /accounts/get endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is,…
  • POSTRetrieve information about a Plaid application/application/getAllows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
  • POSTCreate Asset Report Audit Copy/asset_report/audit_copy/createPlaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy…
  • POSTRetrieve an Asset Report Audit Copy/asset_report/audit_copy/get/asset_report/audit_copy/get allows auditors to get a copy of an Asset Report that was previously shared via the /asset_report/audit_copy/create endpoint. The…
  • POSTRemove Asset Report Audit Copy/asset_report/audit_copy/removeThe /asset_report/audit_copy/remove endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the audit_copy_token associated with it,…
  • POSTCreate an Asset Report/asset_report/createThe /asset_report/create endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the asset_report_token return…
  • POSTFilter Asset Report/asset_report/filterBy default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For…
  • POSTRetrieve an Asset Report/asset_report/getThe /asset_report/get endpoint retrieves the Asset Report in JSON format. Before calling /asset_report/get, you must first create the Asset Report using…
  • POSTRetrieve a PDF Asset Report/asset_report/pdf/getThe /asset_report/pdf/get endpoint retrieves the Asset Report in PDF format. Before calling /asset_report/pdf/get, you must first create the Asset Report…
  • POSTRefresh an Asset Report/asset_report/refreshAn Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the…
  • POSTDelete an Asset Report/asset_report/removeThe /item/remove endpoint allows you to invalidate an access_token, meaning you will not be able to create new Asset Reports with it. Removing an Item does…
  • POSTRetrieve auth data/auth/getThe /auth/get endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking…
  • POSTGet balance of your Bank Transfer account/bank_transfer/balance/getUse the /bank_transfer/balance/get endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their…
  • POSTCancel a bank transfer/bank_transfer/cancelUse the /bank_transfer/cancel endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the cancellable property returned by…
  • POSTCreate a bank transfer/bank_transfer/createUse the /bank_transfer/create endpoint to initiate a new bank transfer.
  • POSTList bank transfer events/bank_transfer/event/listUse the /bank_transfer/event/list endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth…
  • POSTSync bank transfer events/bank_transfer/event/sync/bank_transfer/event/sync allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific event_id. When using…
  • POSTRetrieve a bank transfer/bank_transfer/getThe /bank_transfer/get fetches information about the bank transfer corresponding to the given bank_transfer_id.
  • POSTList bank transfers/bank_transfer/listUse the /bank_transfer/list endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the count and offset query…
  • POSTMigrate account into Bank Transfers/bank_transfer/migrate_accountAs an alternative to adding Items via Link, you can also use the /bank_transfer/migrate_account endpoint to migrate known account and routing numbers to Plaid…
  • POSTRetrieve a sweep/bank_transfer/sweep/getThe /bank_transfer/sweep/get endpoint fetches information about the sweep corresponding to the given sweep_id.
  • POSTList sweeps/bank_transfer/sweep/listThe /bank_transfer/sweep/list endpoint fetches information about the sweeps matching the given filters.
  • POSTRetrieve information from the bank accounts used for employment verification/beta/credit/v1/bank_employment/get/credit/bank_employment/get returns the employment report(s) derived from bank transaction data for a specified user.
  • POSTCreate transaction category rule/beta/transactions/rules/v1/createThe /transactions/rules/v1/create endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in…
  • POSTReturn a list of rules created for the Item associated with the access token./beta/transactions/rules/v1/listThe /transactions/rules/v1/list returns a list of transaction rules created for the Item associated with the access token.
  • POSTRemove transaction rule/beta/transactions/rules/v1/removeThe /transactions/rules/v1/remove endpoint is used to remove a transaction rule.
  • POSTenhance locally-held transaction data/beta/transactions/v1/enhanceThe /beta/transactions/v1/enhance endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
  • POSTGet Categories/categories/getSend a request to the /categories/get endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
  • POSTRetrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint./credit/asset_report/freddie_mac/getThe credit/asset_report/freddie_mac/get endpoint retrieves the Asset Report in Freddie Mac's JSON format.
  • POSTCreate Asset or Income Report Audit Copy Token/credit/audit_copy_token/createPlaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate…
  • POSTRemove an Audit Copy token/credit/audit_copy_token/removeThe /credit/audit_copy_token/remove endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the audit_copy_token associated with it,…
  • POSTUpdate an Audit Copy Token/credit/audit_copy_token/updateThe /credit/audit_copy_token/update endpoint updates the Audit Copy Token by adding the report tokens in the report_tokens field to the audit_copy_token. If…
  • POSTRetrieve information from the bank accounts used for income verification/credit/bank_income/get/credit/bank_income/get returns the bank income report(s) for a specified user.
  • POSTRetrieve information from the bank accounts used for income verification in PDF format/credit/bank_income/pdf/get/credit/bank_income/pdf/get returns the most recent bank income report for a specified user in PDF format.
  • POSTRefresh a user's bank income information/credit/bank_income/refresh/credit/bank_income/refresh refreshes the bank income report data for a specific user.
  • POSTRetrieve a summary of an individual's employment information/credit/employment/get/credit/employment/get returns a list of items with employment information from a user's payroll provider that was verified by an end user.
  • POSTRetrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint./credit/freddie_mac/reports/getThe credit/asset_report/freddie_mac/get endpoint retrieves the Verification of Assets and Verification of Employment reports.
  • POSTRetrieve a user's payroll information/credit/payroll_income/getThis endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay…
  • POSTCheck income verification eligibility and optimize conversion/credit/payroll_income/precheck/credit/payroll_income/precheck is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a…
  • POSTRefresh a digital payroll income verification/credit/payroll_income/refresh/credit/payroll_income/refresh refreshes a given digital payroll income verification.
  • POSTCreate a relay token to share an Asset Report with a partner client (beta)/credit/relay/createPlaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally…
  • POSTRetrieve the reports associated with a relay token that was shared with you (beta)/credit/relay/get/credit/relay/get allows third parties to receive a report that was shared with them, using a relay_token that was created by the report owner.
  • POSTRefresh a report of a relay token (beta)/credit/relay/refreshThe /credit/relay/refresh endpoint allows third parties to refresh a report that was relayed to them, using a relay_token that was created by the report…
  • POSTRemove relay token (beta)/credit/relay/removeThe /credit/relay/remove endpoint allows you to invalidate a relay_token. The third party holding the token will no longer be able to access or refresh the…
  • POSTRetrieve Link sessions for your user/credit/sessions/getThis endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where…
  • POSTRetrieve a dashboard user/dashboard_user/getRetrieve information about a dashboard user.
  • POSTList dashboard users/dashboard_user/listList all dashboard users associated with your account.
  • POSTCreate a deposit switch without using Plaid Exchange/deposit_switch/alt/createThis endpoint provides an alternative to /deposit_switch/create for customers who have not yet fully integrated with Plaid Exchange. Like…
  • POSTCreate a deposit switch/deposit_switch/createThis endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
  • POSTRetrieve a deposit switch/deposit_switch/getThis endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to…
  • POSTCreate a deposit switch token/deposit_switch/token/createIn order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It…
  • POSTSearch employer database/employers/search/employers/search allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a…
  • POST(Deprecated) Retrieve a summary of an individual's employment information/employment/verification/getDeprecated. /employment/verification/get returns a list of employments through a user payroll that was verified by an end user. This endpoint has been…
  • POSTWebhook receiver for fdx notifications/fdx/notificationsA generic webhook receiver endpoint for FDX Event Notifications
  • POSTRetrieve identity data/identity/getThe /identity/get endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone…
  • POSTRetrieve identity match score/identity/matchThe /identity/match endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the…
  • POSTCreate a new identity verification/identity_verification/createCreate a new Identity Verification for the user specified by the client_user_id field. The requirements and behavior of the verification are determined by the…
  • POSTRetrieve Identity Verification/identity_verification/getRetrieve a previously created identity verification.
  • POSTList Identity Verifications/identity_verification/listFilter and list Identity Verifications created by your account
  • POSTRetry an Identity Verification/identity_verification/retryAllow a customer to retry their identity verification
  • POST(Deprecated) Create an income verification instance/income/verification/createDeprecated. /income/verification/create begins the income verification process by returning an income_verification_id. You can then provide the…
  • POST(Deprecated) Download the original documents used for income verification/income/verification/documents/downloadDeprecated. /income/verification/documents/download provides the ability to download the source documents associated with the verification. If Document Income…
  • POST(Deprecated) Retrieve information from the paystubs used for income verification/income/verification/paystubs/getDeprecated. /income/verification/paystubs/get returns the information collected from the paystubs that were used to verify an end user's income. It can be…
  • POST(Deprecated) Check digital income verification eligibility and optimize conversion/income/verification/precheckDeprecated. /income/verification/precheck is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates…
  • POST(Deprecated) Retrieve information from the tax documents used for income verification/income/verification/taxforms/getDeprecated. /income/verification/taxforms/get returns the information collected from forms that were used to verify an end user''s income. It can be called…
  • POSTGet details of all supported institutions/institutions/getReturns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions,…
  • POSTGet details of an institution/institutions/get_by_idReturns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and…
  • POSTSearch institutions/institutions/searchReturns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note:…
  • POSTGet Investment holdings/investments/holdings/getThe /investments/holdings/get endpoint allows developers to receive user-authorized stock position data for investment-type accounts.
  • POSTGet investment transactions/investments/transactions/getThe /investments/transactions/get endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts.…
  • POSTInvalidate access_token/item/access_token/invalidateBy default, the access_token associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the…
  • POSTList a historical log of user consent events/item/activity/listList a historical log of user consent events
  • POSTList a user’s connected applications/item/application/listList a user’s connected applications
  • POSTUpdate the scopes of access for a particular application/item/application/scopes/updateEnable consumers to update product access on selected accounts for an application.
  • POSTRetrieve an Item/item/getReturns information about the status of an Item.
  • POSTImport Item/item/import/item/import creates an Item via your Plaid Exchange Integration and returns an access_token. As part of an /item/import request, you will include a User ID…
  • POSTCreate public token/item/public_token/createNote: As of July 2020, the /item/public_token/create endpoint is deprecated. Instead, use /link/token/create with an access_token to create a Link token for…
  • POSTExchange public token for an access token/item/public_token/exchangeExchange 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 successfully…
  • POSTRemove an Item/item/removeThe /item/remove endpoint allows you to remove an Item. Once removed, the access_token, as well as any processor tokens or bank account tokens associated with…
  • POSTUpdate Webhook URL/item/webhook/updateThe POST /item/webhook/update allows you to update the webhook URL associated with an Item. This request triggers a WEBHOOK_UPDATE_ACKNOWLEDGED webhook to the…
  • POSTRetrieve Liabilities data/liabilities/getThe /liabilities/get endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial…
  • POSTExchange the Link Correlation Id for a Link Token/link/oauth/correlation_id/exchangeExchange an OAuth link_correlation_id for the corresponding link_token. The link_correlation_id is only available for 'payment_initiation' products and is…
  • POSTCreate Link Token/link/token/createThe /link/token/create endpoint creates a link_token, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a…
  • POSTGet Link Token/link/token/getThe /link/token/get endpoint gets information about a previously-created link_token using the /link/token/create endpoint. It can be useful for debugging…
  • POSTCreate Link Delivery session/link_delivery/createUse the /link_delivery/create endpoint to create a Link Delivery session.
  • POSTGet Link Delivery session/link_delivery/getUse the /link_delivery/get endpoint to get the status of a Link Delivery session.
  • POSTCreates a new end customer for a Plaid reseller./partner/customer/createThe /partner/customer/create endpoint is used by reseller partners to create end customers.
  • POSTEnables a Plaid reseller's end customer in the Production environment./partner/customer/enableThe /partner/customer/enable endpoint is used by reseller partners to enable an end customer in the Production environment.
  • POSTReturns a Plaid reseller's end customer./partner/customer/getThe /partner/customer/get endpoint is used by reseller partners to retrieve data about a single end customer.
  • POSTReturns OAuth-institution registration information for a given end customer./partner/customer/oauth_institutions/getThe /partner/customer/oauth_institutions/get endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end…
  • POSTRemoves a Plaid reseller's end customer./partner/customer/removeThe /partner/customer/remove endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid…
  • POSTCreate payment consent/payment_initiation/consent/createThe /payment_initiation/consent/create endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment…
  • POSTGet payment consent/payment_initiation/consent/getThe /payment_initiation/consent/get endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient…
  • POSTExecute a single payment using consent/payment_initiation/consent/payment/executeThe /payment_initiation/consent/payment/execute endpoint can be used to execute payments using payment consent.
  • POSTRevoke payment consent/payment_initiation/consent/revokeThe /payment_initiation/consent/revoke endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate…
  • POSTCreate a payment/payment_initiation/payment/createAfter creating a payment recipient, you can use the /payment_initiation/payment/create endpoint to create a payment to that recipient. Payments can be…
  • POSTGet payment details/payment_initiation/payment/getThe /payment_initiation/payment/get endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and…
  • POSTList payments/payment_initiation/payment/listThe /payment_initiation/payment/list endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can…
  • POSTReverse an existing payment/payment_initiation/payment/reverseReverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the…
  • POSTCreate payment token/payment_initiation/payment/token/createDeprecated. The /payment_initiation/payment/token/create endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing…
  • POSTCreate payment recipient/payment_initiation/recipient/createCreate 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)…
  • POSTGet payment recipient/payment_initiation/recipient/getGet details about a payment recipient you have previously created.
  • POSTList payment recipients/payment_initiation/recipient/listThe /payment_initiation/recipient/list endpoint list the payment recipients that you have previously created.
  • POSTCreate payment profile/payment_profile/createUse /payment_profile/create endpoint to create a new payment profile. To initiate the account linking experience, call /link/token/create and provide the…
  • POSTGet payment profile/payment_profile/getUse /payment_profile/get endpoint to get the status of a given Payment Profile.
  • POSTRemove payment profile/payment_profile/removeUse the /payment_profile/remove endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.
  • POSTCreate Apex bank account token/processor/apex/processor_token/createUsed to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
  • POSTRetrieve Auth data/processor/auth/getThe /processor/auth/get endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or…
  • POSTRetrieve Balance data/processor/balance/getThe /processor/balance/get endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only…
  • POSTCreate a bank transfer as a processor/processor/bank_transfer/createUse the /processor/bank_transfer/create endpoint to initiate a new bank transfer as a processor
  • POSTRetrieve Identity data/processor/identity/getThe /processor/identity/get endpoint allows you to retrieve various account holder information on file with the financial institution, including names,…
  • POSTReport whether you initiated an ACH transaction/processor/signal/decision/reportAfter calling /processor/signal/evaluate, call /processor/signal/decision/report to report whether the transaction was initiated. This endpoint will return an…
  • POSTEvaluate a planned ACH transaction/processor/signal/evaluateUse /processor/signal/evaluate to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and…
  • POSTReport a return for an ACH transaction/processor/signal/return/reportCall the /processor/signal/return/report endpoint to report a returned transaction that was previously sent to the /processor/signal/evaluate endpoint. Your…
  • POSTCreate Stripe bank account token/processor/stripe/bank_account_token/createUsed to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see Add Stripe to your…
  • POSTCreate processor token/processor/token/createUsed to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead;…
  • POSTManually fire a Bank Transfer webhook/sandbox/bank_transfer/fire_webhookUse the /sandbox/bank_transfer/fire_webhook endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
  • POSTSimulate a bank transfer event in Sandbox/sandbox/bank_transfer/simulateUse the /sandbox/bank_transfer/simulate endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and…
  • POSTManually fire an Income webhook/sandbox/income/fire_webhookUse the /sandbox/income/fire_webhook endpoint to manually trigger an Income webhook in the Sandbox environment.
  • POSTFire a test webhook/sandbox/item/fire_webhookThe /sandbox/item/fire_webhook endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks:…
  • POSTForce a Sandbox Item into an error state/sandbox/item/reset_login/sandbox/item/reset_login/ 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…
  • POSTSet verification status for Sandbox account/sandbox/item/set_verification_statusThe /sandbox/item/set_verification_status endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the…
  • POSTSave the selected accounts when connecting to the Platypus Oauth institution/sandbox/oauth/select_accountsSave the selected accounts when connecting to the Platypus Oauth institution
  • POSTReset the login of a Payment Profile/sandbox/payment_profile/reset_login/sandbox/payment_profile/reset_login/ forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for…
  • POSTCreate a test Item and processor token/sandbox/processor_token/createUse the /sandbox/processor_token/create endpoint to create a valid processor_token for an arbitrary institution ID and test credentials. The created…
  • POSTCreate a test Item/sandbox/public_token/createUse the /sandbox/public_token/create endpoint to create a valid public_token for an arbitrary institution ID, initial products, and test credentials. The…
  • POSTManually fire a Transfer webhook/sandbox/transfer/fire_webhookUse the /sandbox/transfer/fire_webhook endpoint to manually trigger a Transfer webhook in the Sandbox environment.
  • POSTTrigger the creation of a repayment/sandbox/transfer/repayment/simulateUse the /sandbox/transfer/repayment/simulate endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created…
  • POSTSimulate a transfer event in Sandbox/sandbox/transfer/simulateUse the /sandbox/transfer/simulate endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will…
  • POSTSimulate creating a sweep/sandbox/transfer/sweep/simulateUse the /sandbox/transfer/sweep/simulate endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all posted…
  • POSTAdvance a test clock/sandbox/transfer/test_clock/advanceUse the /sandbox/transfer/test_clock/advance endpoint to advance a test_clock in the Sandbox environment. A test clock object represents an independent…
  • POSTCreate a test clock/sandbox/transfer/test_clock/createUse the /sandbox/transfer/test_clock/create endpoint to create a test_clock in the Sandbox environment. A test clock object represents an independent timeline…
  • POSTGet a test clock/sandbox/transfer/test_clock/getUse the /sandbox/transfer/test_clock/get endpoint to get a test_clock in the Sandbox environment.
  • POSTList test clocks/sandbox/transfer/test_clock/listUse the /sandbox/transfer/test_clock/list endpoint to see a list of all your test clocks in the Sandbox environment, by ascending virtual_time. Results are…
  • POSTReport whether you initiated an ACH transaction/signal/decision/reportAfter calling /signal/evaluate, call /signal/decision/report to report whether the transaction was initiated. This endpoint will return an INVALID_FIELD error…
  • POSTEvaluate a planned ACH transaction/signal/evaluateUse /signal/evaluate to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.…
  • POSTOpt-in an Item to Signal/signal/prepareWhen Link is not initialized with Signal, call /signal/prepare to opt-in that Item to the Signal data collection process, developing a Signal score. If you…
  • POSTReport a return for an ACH transaction/signal/return/reportCall the /signal/return/report endpoint to report a returned transaction that was previously sent to the /signal/evaluate endpoint. Your feedback will be used…
  • POSTEnrich locally-held transaction data/transactions/enrichThe /transactions/enrich endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product…
  • POSTGet transaction data/transactions/getThe /transactions/get endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those…
  • POSTFetch recurring transaction streams/transactions/recurring/getThe /transactions/recurring/get endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a…
  • POSTRefresh transaction data/transactions/refresh/transactions/refresh is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for…
  • POSTGet incremental transaction updates on an Item/transactions/syncThis endpoint replaces /transactions/get and its associated webhooks for most common use-cases. The /transactions/sync endpoint allows developers to subscribe…
  • POSTCreate a transfer authorization/transfer/authorization/createUse the /transfer/authorization/create endpoint to determine transfer failure risk. In Plaid's Sandbox environment the decisions will be returned as follows:…
  • POSTCancel a transfer/transfer/cancelUse the /transfer/cancel endpoint to cancel a transfer. A transfer is eligible for cancellation if the cancellable property returned by /transfer/get is true.
  • POSTGet RTP eligibility information of a transfer/transfer/capabilities/getUse the /transfer/capabilities/get endpoint to determine the RTP eligibility information of a transfer.
  • POSTCreate a transfer/transfer/createUse the /transfer/create endpoint to initiate a new transfer.
  • POSTList transfer events/transfer/event/listUse the /transfer/event/list endpoint to get a list of transfer events based on specified filter criteria.
  • POSTSync transfer events/transfer/event/sync/transfer/event/sync allows you to request up to the next 25 transfer events that happened after a specific event_id. Use the /transfer/event/sync endpoint to…
  • POSTRetrieve a transfer/transfer/getThe /transfer/get endpoint fetches information about the transfer corresponding to the given transfer_id.
  • POSTCreate a transfer intent object to invoke the Transfer UI/transfer/intent/createUse the /transfer/intent/create endpoint to generate a transfer intent object and invoke the Transfer UI.
  • POSTRetrieve more information about a transfer intent/transfer/intent/getUse the /transfer/intent/get endpoint to retrieve more information about a transfer intent.
  • POSTList transfers/transfer/listUse the /transfer/list endpoint to see a list of all your transfers and their statuses. Results are paginated; use the count and offset query parameters to…
  • POSTMigrate account into Transfers/transfer/migrate_accountAs an alternative to adding Items via Link, you can also use the /transfer/migrate_account endpoint to migrate known account and routing numbers to Plaid…
  • POSTCreate a new originator/transfer/originator/createUse the /transfer/originator/create endpoint to create a new originator and return an originator_client_id.
  • POSTGet status of an originator's onboarding/transfer/originator/getThe /transfer/originator/get endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on…
  • POSTGet status of all originators' onboarding/transfer/originator/listThe /transfer/originator/list endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard.
  • POSTGenerate a Plaid-hosted onboarding UI URL./transfer/questionnaire/createThe /transfer/questionnaire/create endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence…
  • POSTCancel a recurring transfer./transfer/recurring/cancelUse the /transfer/recurring/cancel endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.
  • POSTCreate a recurring transfer/transfer/recurring/createUse the /transfer/recurring/create endpoint to initiate a new recurring transfer.
  • POSTRetrieve a recurring transfer/transfer/recurring/getThe /transfer/recurring/get fetches information about the recurring transfer corresponding to the given recurring_transfer_id.
  • POSTList recurring transfers/transfer/recurring/listUse the /transfer/recurring/list endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the count and offset…
  • POSTCancel a refund/transfer/refund/cancelUse the /transfer/refund/cancel endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.
  • POSTCreate a refund/transfer/refund/createUse the /transfer/refund/create endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days.…
  • POSTRetrieve a refund/transfer/refund/getThe /transfer/refund/get endpoint fetches information about the refund corresponding to the given refund_id.
  • POSTLists historical repayments/transfer/repayment/listThe /transfer/repayment/list endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent…
  • POSTList the returns included in a repayment/transfer/repayment/return/listThe /transfer/repayment/return/list endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of…
  • POSTRetrieve a sweep/transfer/sweep/getThe /transfer/sweep/get endpoint fetches a sweep corresponding to the given sweep_id.
  • POSTList sweeps/transfer/sweep/listThe /transfer/sweep/list endpoint fetches sweeps matching the given filters.
  • POSTCreate user/user/createThis endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data…
  • POSTCreate an e-wallet/wallet/createCreate an e-wallet. The response is the newly created e-wallet object.
  • POSTFetch an e-wallet/wallet/getFetch an e-wallet. The response includes the current balance.
  • POSTFetch a list of e-wallets/wallet/listThis endpoint lists all e-wallets in descending order of creation.
  • POSTExecute a transaction using an e-wallet/wallet/transaction/executeExecute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent…
  • POSTFetch an e-wallet transaction/wallet/transaction/getFetch a specific e-wallet transaction
  • POSTList e-wallet transactions/wallet/transaction/listThis endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the created_at time.
  • POSTCreate a watchlist screening for an entity/watchlist_screening/entity/createCreate a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated…
  • POSTGet an entity screening/watchlist_screening/entity/getRetrieve an entity watchlist screening.
  • POSTList history for entity watchlist screenings/watchlist_screening/entity/history/listList all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
  • POSTList hits for entity watchlist screenings/watchlist_screening/entity/hit/listList all hits for the entity watchlist screening.
  • POSTList entity watchlist screenings/watchlist_screening/entity/listList all entity screenings.
  • POSTGet entity watchlist screening program/watchlist_screening/entity/program/getGet an entity watchlist screening program
  • POSTList entity watchlist screening programs/watchlist_screening/entity/program/listList all entity watchlist screening programs
  • POSTCreate a review for an entity watchlist screening/watchlist_screening/entity/review/createCreate a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential…
  • POSTList reviews for entity watchlist screenings/watchlist_screening/entity/review/listList all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of…
  • POSTUpdate an entity screening/watchlist_screening/entity/updateUpdate an entity watchlist screening.
  • POSTCreate a watchlist screening for a person/watchlist_screening/individual/createCreate a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing…
  • POSTRetrieve an individual watchlist screening/watchlist_screening/individual/getRetrieve a previously created individual watchlist screening
  • POSTList history for individual watchlist screenings/watchlist_screening/individual/history/listList all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be…
  • POSTList hits for individual watchlist screening/watchlist_screening/individual/hit/listList all hits found by Plaid for a particular individual watchlist screening.
  • POSTList Individual Watchlist Screenings/watchlist_screening/individual/listList previously created watchlist screenings for individuals
  • POSTGet individual watchlist screening program/watchlist_screening/individual/program/getGet an individual watchlist screening program
  • POSTList individual watchlist screening programs/watchlist_screening/individual/program/listList all individual watchlist screening programs
  • POSTCreate a review for an individual watchlist screening/watchlist_screening/individual/review/createCreate a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of…
  • POSTList reviews for individual watchlist screenings/watchlist_screening/individual/review/listList all reviews for the individual watchlist screening.
  • POSTUpdate individual watchlist screening/watchlist_screening/individual/updateUpdate a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a…
  • POSTGet webhook verification key/webhook_verification_key/getPlaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A…

API details

Base URL
https://production.plaid.com
https://development.plaid.com
https://sandbox.plaid.com
Authentication
An API key in the PLAID-CLIENT-ID header
An API key in the Plaid-Version header
An API key in the PLAID-SECRET header
Operations
198 operations on 199 pathsPOST 198
7 marked deprecated
Main resources
plaid 198
Response formats
application/json application/pdf application/zip
Description format
OpenAPI 3.0.0, API version 2020-09-14_1.334.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the 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 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 “Retrieve real-time balance data” (POST /accounts/balance/get), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the The Plaid API?

The Plaid REST API. Please see https://plaid.com/docs/api for more details. It is listed under Finance & banking and has 198 endpoints.

Who publishes the 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 The Plaid API?

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

How do I authenticate with the The Plaid API?

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

How many endpoints does the The Plaid API have?

198 operations on 199 paths (198 POST). The largest groups are plaid.

Is forking the 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.