Plaid
What is Plaid? Plaid makes it easy to securely connect your bank to the apps you want to use Connecting your bank to your apps Plaid power thousands of the apps that people rely on to manage their financial lives. How it works We connect to 11,000 financial institutions across the United States, Canada, and Europe. With Plaid, connecting your bank account is easy: Step 1 When you sign up with a…
108 subscribers
100 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Plaid endpoints
| Method | Endpoint | Description |
|---|---|---|
| Auth | ||
| POST |
retrieveAuthDataAccountRoutingNumber /auth/get |
The `/auth/get` 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… |
| Balance | ||
| POST |
retrieveBalance /accounts/balance/get |
The `/accounts/balance/get` endpoint returns the real-time balance for each of an `Item`’s accounts. It can be used for existing `Item`s that were added via any of Plaid’s other… |
| Assets | ||
| POST |
retrieveAnAssetReportPdf /asset_report/pdf/get |
You can retrieve your Asset Report in multiple formats (PDF and JSON), determined by the endpoint you call. JSON: `/asset_report/get` PDF: `/asset_report/pdf/get` Just like… |
| POST |
refreshAssetReport /asset_report/refresh |
Create a new Asset Report based on the old one, but with the most recent data available from the financial institution(s). |
| POST |
removeAssetReport /asset_report/remove |
The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use… |
| POST |
createAuditCopy /asset_report/audit_copy/create |
Plaid can provide an **Audit Copy** of any Asset Report directly to a participating third party on your behalf. An Audit Copy contains the same underlying data as the Asset… |
| POST |
retrieveAnAssetReportJson /asset_report/get |
You can retrieve your Asset Report in multiple formats (PDF and JSON), determined by the endpoint you call. JSON: `/asset_report/get` PDF: `/asset_report/pdf/get` Just like… |
| POST |
createAssetReport /asset_report/create |
With your desired `access_tokens` in hand, all you need to do to create an Asset Report is to call the `/asset_report/create` endpoint. When creating an Asset Report, the only… |
| POST |
removeAuditCopy /asset_report/audit_copy/remove |
The `/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, meaning both you… |
| Income | ||
| POST |
startHereCreateUserToken /user/create |
|
| POST |
fireIncomeWebhook /sandbox/income/fire_webhook |
|
| POST |
enableOrDisableWebhookNotificationsForAUser /credit/bank_income/webhook/update |
|
| Transfer | ||
| POST |
seeIfAnItemSupportsRealTimePayments /transfer/capabilities/get |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| POST |
migrateARNumberPairToTransferAccountManagerMustEnable /transfer/migrate_account |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| Transfer > [START HERE] Create and send a transfer | ||
| POST |
authorizeATransfer /transfer/authorization/create |
Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. |
| POST |
initiateATransfer /transfer/create |
Use the `/transfer/create` endpoint to initiate a new transfer. |
| Transfer > Transfer events | ||
| POST |
simulateATransferEventInSandbox /sandbox/transfer/simulate |
Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using… |
| Transfer > Transfer sweeps | ||
| POST |
listTransferSweeps /transfer/sweep/list |
Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using… |
| POST |
simulateASweepInSandbox /sandbox/transfer/sweep/simulate |
Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using… |
| POST |
getASweep /transfer/sweep/get |
Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using… |
| Transfer > Transfer UI | ||
| POST |
createTransferIntent /transfer/intent/create |
Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. |
| POST |
getExistingTransferIntent /transfer/intent/get |
Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. |
| Transfer > Ledger | ||
| POST |
sandboxSimulateConvertingPendingBalanceToAvailableBalance /sandbox/transfer/ledger/simulate_available |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| Transfer > Platform payments | ||
| POST |
submitDiligenceInformationYouCollectedAboutAnOriginator /transfer/diligence/submit |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| POST |
getAnOrginator /transfer/originator/get |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| POST |
createAnOriginator //transfer/originator/create |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| POST |
listOriginators /transfer/originator/list |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| POST |
uploadADocumentShowingYourDueDiligencePerformedOnTheOriginator /transfer/diligence/document/upload |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| POST |
createAnOriginatorOnboardingQuestionnaire /transfer/questionnaire/create |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| POST |
changeTheFundingAccountForAnOriginator /transfer/originator/funding_account/update |
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`. |
| Signal | ||
| POST |
reportAnAchReturn /signal/return/report |
|
| POST |
evaluateAPlannedAchTransaction /signal/evaluate |
|
| Institutions | ||
| POST |
searchInstitutionById /institutions/get_by_id |
|
| POST |
retrieveInsitutionList /institutions/get |
To see a full list of supported institutions across all products, use the `/institutions/get` and `/institutions/search` endpoints. Use the `count` and `offset` query parameters… |
| POST |
searchInstitutionByName /institutions/search |
The `/institutions/search` endpoint makes it easy to stay up-to-date with supported institutions and help your users quickly find their institutions. |
| Payment Initiation (UK and Europe only) | ||
| POST |
createPaymentRecipient /payment_initiation/recipient/create |
In the sandbox environment, you can use the `/payment_initiation/recipient/create` endpoint to generate recipients. Programmatic recipient creation in the development and… |
| POST |
createLinkTokenPaymentInitiation /link/token/create |
Creates a link token with options. The `payment_id` from `Create Payment` is passed with the creation of the link token. The link token can then be used to initialize Plaid Link. |
| POST |
revokePaymentConsent /payment_initiation/consent/revoke |
|
| POST |
getPaymentConsent /payment_initiation/consent/get |
|
| POST |
executeConsentBasedPayment /payment_initiation/consent/payment/execute |
|
| POST |
createPayment /payment_initiation/payment/create |
Create and configure a payment by specifying a `recipient_id`, `reference`, `amount`, and `currency` to create a Plaid payment resource. The Plaid API returns a `payment_id` to… |
| POST |
listPayments /payment_initiation/payment/list |
The endpoint `payment_initiation/payment/get` list payment details for all of your previously created payments. This endpoint accepts `count` and `cursor` as optional parameters… |
| POST |
listPaymentRecipients /payment_initiation/recipient/list |
The `/payment_initiation/recipient/list` endpoint allows you to retrieve details for all recipients that you have created. |
| POST |
getPayment /payment_initiation/payment/get |
The endpoint `payment_initiation/payment/get` takes a `payment_id` and returns all of the payment details for a previously created payment. |
| POST |
createPaymentConsent /payment_initiation/consent/create |
|
| POST |
getPaymentRecipient /payment_initiation/recipient/get |
The `/payment_initiation/recipient/get` endpoint allows you to retrieve all of the details for a recipient that you have created. |
| Endpoints for use by Processors only | ||
| POST |
getAccountData /processor/accounts/get |
The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that's… |
| POST |
updateAnItemsWebhook /processor/token/webhook/update |
This endpoint allows you to update the webhook url for an `Item`. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` [webhook](https://plaid.com/docs/api/#item-webhooks). |
| Endpoints for use by Processors only > Auth/Balance/Identity | ||
| POST |
getAuthData /processor/auth/get |
The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that's… |
| POST |
matchIdentityData /processor/identity/match |
The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers,… |
+ 50 more endpoints on the provider's documentation.
Plaid pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO Recommended | $4.99 / month | — |
|
| ULTRA | Free | 100 / second |
|
