plaid2.client module

class plaid2.client.PlaidClient(base_url: str, authenticator: PlaidAuthentication)[source]

Bases: object

accounts_balance_get(access_token: str, *, options: Optional[AccountsBalanceGetRequestOptions] = None) → AccountsGetResponse[source]

Retrieve real-time balance data

The /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 /accounts/balance/get forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, balance itself is not a product that can be used to initialize Link.

See endpoint docs at <https://plaid.com/docs/api/products/balance/#accountsbalanceget>.

accounts_get(access_token: str, *, options: Optional[List[str]] = None) → AccountsGetResponse[source]

Retrieve accounts

The /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, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [NEW_ACCOUNTS_AVAILABLE](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link’s [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.

This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use /accounts/balance/get instead. Note that some information is nullable.

See endpoint docs at <https://plaid.com/docs/api/accounts/#accountsget>.

application_get(application_id: str) → ApplicationGetResponse[source]

Retrieve information about a Plaid application

Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences

asset_report_audit_copy_create(asset_report_token: str, auditor_id: str) → AssetReportAuditCopyCreateResponse[source]

Create Asset Report Audit Copy

Plaid 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 directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report.

To grant access to an Audit Copy, use the /asset_report/audit_copy/create endpoint to create an audit_copy_token and then pass that token to the third party who needs access. Each third party has its own auditor_id, for example fannie_mae. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportaudit_copycreate>.

asset_report_audit_copy_get(audit_copy_token: str) → AssetReportGetResponse[source]

Retrieve an Asset Report Audit Copy

/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 caller of /asset_report/audit_copy/create must provide the audit_copy_token to the auditor. This token can then be used to call /asset_report/audit_copy/create.

See endpoint docs at <https://plaid.com/docs/none/>.

asset_report_audit_copy_remove(audit_copy_token: str) → AssetReportAuditCopyRemoveResponse[source]

Remove Asset Report Audit Copy

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 and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportaudit_copyremove>.

asset_report_create(access_tokens: List[str], days_requested: int, *, options: Optional[AssetReportCreateRequestOptions] = None) → AssetReportCreateResponse[source]

Create an Asset Report

The /asset_report/create endpoint initiates the process of 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.

The Asset Report takes some time to be created and is not available immediately after calling /asset_report/create. When the Asset Report is ready to be retrieved using /asset_report/get or /asset_report/pdf/get, Plaid will fire a PRODUCT_READY webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/products/assets/#webhooks).

The /asset_report/create endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the /asset_report/refresh endpoint.

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportcreate>.

asset_report_filter(asset_report_token: str, account_ids_to_exclude: List[str]) → AssetReportFilterResponse[source]

Filter Asset Report

By 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 example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the /accounts/get endpoint. To narrow an Asset Report to only a subset of accounts, use the /asset_report/filter endpoint.

To exclude certain Accounts from an Asset Report, first use the /asset_report/create endpoint to create the report, then send the asset_report_token along with a list of account_ids to exclude to the /asset_report/filter endpoint, to create a new Asset Report which contains only a subset of the original Asset Report’s data.

Because Asset Reports are immutable, calling /asset_report/filter does not alter the original Asset Report in any way; rather, /asset_report/filter creates a new Asset Report with a new token and id. Asset Reports created via /asset_report/filter do not contain new Asset data, and are not billed.

Plaid will fire a [PRODUCT_READY](https://plaid.com/docs/api/products/assets/#product_ready) webhook once generation of the filtered Asset Report has completed.

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportfilter>.

asset_report_get(asset_report_token: str, *, include_insights: Optional[bool] = None, fast_report: Optional[bool] = None) → AssetReportGetResponse[source]

Retrieve an Asset Report

The /asset_report/get endpoint 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](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved.

By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report.

To retrieve an Asset Report with Insights, call the /asset_report/get endpoint with include_insights set to true.

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportget>.

asset_report_pdf_get(asset_report_token: str) → None[source]

Retrieve a PDF Asset Report

The /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 using /asset_report/create (or filter an Asset Report using /asset_report/filter) and then wait for the [PRODUCT_READY](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved.

The response to /asset_report/pdf/get is the PDF binary data. The request_id is returned in the Plaid-Request-ID header.

[View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportpdfget>.

asset_report_refresh(asset_report_token: str, *, days_requested: Optional[int] = None, options: Optional[AssetReportRefreshRequestOptions] = None) → AssetReportRefreshResponse[source]

Refresh an Asset Report

An 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 /asset_report/refresh endpoint to create a new Asset Report based on the old one, but with the most recent data available.

The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to /asset_report/filter. By default, the new Asset Report will also use the same parameters you submitted with your original /asset_report/create request, but the original days_requested value and the values of any parameters in the options object can be overridden with new values. To change these arguments, simply supply new values for them in your request to /asset_report/refresh. Submit an empty string (“”) for any previously-populated fields you would like set as empty.

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportrefresh>.

asset_report_relay_create(asset_report_token: str, secondary_client_id: str, *, webhook: Optional[str] = None) → AssetReportRelayCreateResponse[source]

Create an asset_relay_token to share an Asset Report with a partner client

Plaid 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 created in /asset_report/create.

To grant access to an Asset Report to a third party, use the /asset_report/relay/create endpoint to create an asset_relay_token and then pass that token to the third party who needs access. Each third party has its own secondary_client_id, for example ce5bd328dcd34123456. You’ll need to create a separate asset_relay_token for each third party to whom you want to grant access to the Report.

See endpoint docs at <https://plaid.com/docs/none/>.

asset_report_relay_get(asset_relay_token: str) → AssetReportGetResponse[source]

Retrieve an Asset Report that was shared with you

/asset_report/relay/get allows third parties to get an Asset Report that was shared with them, using an asset_relay_token that was created by the report owner.

See endpoint docs at <https://plaid.com/docs/none/>.

asset_report_relay_refresh(asset_relay_token: str, *, webhook: Optional[str] = None) → AssetReportRelayRefreshResponse[source]

Refresh a Relay Token’s Asset Report

The /asset_report/relay/refresh endpoint allows third parties to refresh an Asset Report that was relayed to them, using an asset_relay_token that was created by the report owner. A new Asset Report will be created based on the old one, but with the most recent data available.

See endpoint docs at <https://plaid.com/docs/api/products/#asset_reportrelayrefresh>.

asset_report_relay_remove(asset_relay_token: str) → AssetReportRelayRemoveResponse[source]

Remove Asset Report Relay Token

The /asset_report/relay/remove endpoint allows you to invalidate an asset_relay_token, meaning the third party holding the token will no longer be able to use it to access the Asset Report to which the asset_relay_token gives access to. The Asset Report, Items associated with it, and other Asset Relay Tokens that provide access to the same Asset Report are not affected and will remain accessible after removing the given `asset_relay_token.

See endpoint docs at <https://plaid.com/docs/none/>.

asset_report_remove(asset_report_token: str) → AssetReportRemoveResponse[source]

Delete an Asset Report

The /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 not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically.

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 it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any audit_copy_tokens associated with the Asset Report.

See endpoint docs at <https://plaid.com/docs/api/products/assets/#asset_reportremove>.

auth_get(access_token: str, *, options: Optional[List[str]] = None) → AuthGetResponse[source]

Retrieve auth data

The /auth/get endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item’s checking and savings accounts, along with high-level account data and balances when available.

Note: This request may take some time to complete if auth was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.

Also note that /auth/get will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.

Versioning note: In API version 2017-03-08, the schema of the numbers object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).

See endpoint docs at <https://plaid.com/docs/api/products/auth/#authget>.

bank_transfer_balance_get(*, origination_account_id: Optional[str] = None) → BankTransferBalanceGetResponse[source]

Get balance of your Bank Transfer account

Use the /bank_transfer/balance/get endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created.

The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.

Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transferbalanceget>.

bank_transfer_cancel(bank_transfer_id: str) → BankTransferCancelResponse[source]

Cancel a bank transfer

Use the /bank_transfer/cancel endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the cancellable property returned by /bank_transfer/get is true.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfercancel>.

bank_transfer_create(idempotency_key: str, access_token: str, account_id: str, type: str, network: str, amount: str, iso_currency_code: str, description: str, user: BankTransferUser, *, ach_class: Optional[str] = None, custom_tag: Optional[str] = None, metadata: Optional[BankTransferMetadata] = None, origination_account_id: Optional[str] = None) → BankTransferCreateResponse[source]

Create a bank transfer

Use the /bank_transfer/create endpoint to initiate a new bank transfer.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfercreate>.

bank_transfer_event_list(*, start_date: Optional[str] = None, end_date: Optional[str] = None, bank_transfer_id: Optional[str] = None, account_id: Optional[str] = None, bank_transfer_type: Optional[str] = None, event_types: Optional[List[str]] = None, count: Optional[int] = None, offset: Optional[int] = None, origination_account_id: Optional[str] = None, direction: Optional[str] = None) → BankTransferEventListResponse[source]

List bank transfer events

Use the /bank_transfer/event/list endpoint to get a list of bank transfer events based on specified filter criteria.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfereventlist>.

bank_transfer_event_sync(after_id: int, *, count: Optional[int] = None) → BankTransferEventSyncResponse[source]

Sync bank transfer events

/bank_transfer/event/sync allows you to request up to the next 25 bank transfer events that happened after a specific event_id. Use the /bank_transfer/event/sync endpoint to guarantee you have seen all bank transfer events.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfereventsync>.

bank_transfer_get(bank_transfer_id: str) → BankTransferGetResponse[source]

Retrieve a bank transfer

The /bank_transfer/get fetches information about the bank transfer corresponding to the given bank_transfer_id.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transferget>.

bank_transfer_list(*, start_date: Optional[str] = None, end_date: Optional[str] = None, count: Optional[int] = None, offset: Optional[int] = None, origination_account_id: Optional[str] = None, direction: Optional[str] = None) → BankTransferListResponse[source]

List bank transfers

Use 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 parameters to retrieve the desired bank transfers.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transferlist>.

bank_transfer_migrate_account(account_number: str, routing_number: str, account_type: str, *, wire_routing_number: Optional[str] = None) → BankTransferMigrateAccountResponse[source]

Migrate account into Bank Transfers

As 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 Items. Note that Items created in this way are not compatible with endpoints for other products, such as /accounts/balance/get, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to /bank_transfer/migrate_account is not enabled by default; to obtain access, contact your Plaid Account Manager.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfermigrate_account>.

bank_transfer_sweep_get(sweep_id: str) → BankTransferSweepGetResponse[source]

Retrieve a sweep

The /bank_transfer/sweep/get endpoint fetches information about the sweep corresponding to the given sweep_id.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#bank_transfersweepget>.

bank_transfer_sweep_list(*, origination_account_id: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, count: Optional[int] = None) → BankTransferSweepListResponse[source]

List sweeps

The /bank_transfer/sweep/list endpoint fetches information about the sweeps matching the given filters.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#bank_transfersweeplist>.

categories_get() → CategoriesGetResponse[source]

Get Categories

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

See endpoint docs at <https://plaid.com/docs/api/products/transactions/#categoriesget>.

create_payment_token(payment_id: str) → PaymentInitiationPaymentTokenCreateResponse[source]

Create payment token

The /payment_initiation/payment/token/create endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, link_token-based flow. The recommended flow is to provide the payment_id to /link/token/create, which returns a link_token used to initialize Link.

The /payment_initiation/payment/token/create is used to create a payment_token, which can then be used in Link initialization to enter a payment initiation flow. You can only use a payment_token once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.

See endpoint docs at <https://plaid.com/docs/link/maintain-legacy-integration/#creating-a-payment-token>.

credit_audit_copy_token_create(report_tokens: List[ReportToken], auditor_id: str) → CreditAuditCopyTokenCreateResponse[source]

Create Asset or Income Report Audit Copy Token

Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get).

To grant access to an Audit Copy token, use the /credit/audit_copy_token/create endpoint to create an audit_copy_token and then pass that token to the third party who needs access. Each third party has its own auditor_id, for example fannie_mae. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditaudit_copy_tokencreate>.

credit_bank_income_get(*, user_token: Optional[str] = None, options: Optional[int] = None) → CreditBankIncomeGetResponse[source]

Retrieve information from the bank accounts used for income verification

/credit/bank_income/get returns the bank income report(s) for a specified user.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditbank_incomeget>.

credit_bank_income_pdf_get(user_token: str) → None[source]

Retrieve information from the bank accounts used for income verification in PDF format

/credit/bank_income/pdf/get returns the most recent bank income report for a specified user in PDF format.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditbank_incomepdfget>.

credit_bank_income_refresh(user_token: str, *, options: Optional[CreditBankIncomeRefreshRequestOptions] = None) → CreditBankIncomeRefreshResponse[source]

Refresh a user’s bank income information

/credit/bank_income/refresh refreshes the bank income report data for a specific user.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditbank_incomerefresh>.

credit_employment_get(user_token: str) → CreditEmploymentGetResponse[source]

Retrieve a summary of an individual’s employment information

/credit/employment/get returns a list of items with employment information from a user’s payroll provider that was verified by an end user.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditemploymentget>.

credit_payroll_income_get(*, user_token: Optional[str] = None) → CreditPayrollIncomeGetResponse[source]

Retrieve a user’s payroll information

This 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 related document.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditpayroll_incomeget>.

credit_payroll_income_precheck(*, user_token: Optional[str] = None, access_tokens: Optional[List[str]] = None, employer: Optional[IncomeVerificationPrecheckEmployer] = None, us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo] = None) → CreditPayrollIncomePrecheckResponse[source]

Check income verification eligibility and optimize conversion

/credit/payroll_income/precheck is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income.

While all request fields are optional, providing employer data will increase the chance of receiving a useful result.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditpayroll_incomeprecheck>.

credit_payroll_income_refresh(*, user_token: Optional[str] = None) → CreditPayrollIncomeRefreshResponse[source]

Refresh a digital payroll income verification

/credit/payroll_income/refresh refreshes a given digital payroll income verification.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditpayroll_incomerefresh>.

credit_relay_create(report_tokens: List[ReportToken], secondary_client_id: str, *, webhook: Optional[str] = None) → CreditRelayCreateResponse[source]

Create a relay_token to share an Asset Report with a partner client

Plaid 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 created in /asset_report/create.

To grant access to an Asset Report to a third party, use the /credit/relay/create endpoint to create a relay_token and then pass that token to the third party who needs access. Each third party has its own secondary_client_id, for example ce5bd328dcd34123456. You’ll need to create a separate relay_token for each third party to whom you want to grant access to the Report.

See endpoint docs at <https://plaid.com/docs/none/>.

credit_relay_get(relay_token: str, report_type: str) → AssetReportGetResponse[source]

Retrieve the reports associated with a Relay token that was shared with you

/credit/relay/get allows third parties to get a report that was shared with them, using an relay_token that was created by the report owner.

See endpoint docs at <https://plaid.com/docs/none/>.

credit_relay_refresh(relay_token: str, report_type: str, *, webhook: Optional[str] = None) → CreditRelayRefreshResponse[source]

Refresh a report of a Relay Token

The /credit/relay/refresh endpoint allows third parties to refresh an report that was relayed to them, using a relay_token that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.

See endpoint docs at <https://plaid.com/docs/api/products/#creditrelayrefresh>.

credit_relay_remove(relay_token: str) → CreditRelayRemoveResponse[source]

Remove Credit Relay Token

The /credit/relay/remove endpoint allows you to invalidate a relay_token, meaning the third party holding the token will no longer be able to use it to access the reports to which the relay_token gives access to. The report, items associated with it, and other Relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token.

See endpoint docs at <https://plaid.com/docs/none/>.

credit_report_audit_copy_remove(audit_copy_token: str) → CreditAuditCopyTokenRemoveResponse[source]

Remove an Audit Copy token

The /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, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.

See endpoint docs at <https://plaid.com/docs/api/products/income/#creditaudit_copy_tokenremove>.

dashboard_user_list(*, cursor: Optional[str] = None) → PaginatedDashboardUserListResponse[source]

List dashboard users

List all dashboard users associated with your account.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#dashboard_userlist>.

dashobard_user_get(dashboard_user_id: str) → DashboardUserResponse[source]

Retrieve a dashboard user

Retrieve information about a dashboard user.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#dashboard_userget>.

deposit_switch_alt_create(target_account: DepositSwitchTargetAccount, target_user: DepositSwitchTargetUser, *, options: Optional[DepositSwitchCreateRequestOptions] = None, country_code: Optional[str] = None) → DepositSwitchAltCreateResponse[source]

Create a deposit switch without using Plaid Exchange

This endpoint provides an alternative to /deposit_switch/create for customers who have not yet fully integrated with Plaid Exchange. Like /deposit_switch/create, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.

See endpoint docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchaltcreate>.

deposit_switch_create(target_access_token: str, target_account_id: str, *, country_code: Optional[str] = None, options: Optional[DepositSwitchCreateRequestOptions] = None) → DepositSwitchCreateResponse[source]

Create a deposit switch

This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.

See endpoint docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchcreate>.

deposit_switch_get(deposit_switch_id: str) → DepositSwitchGetResponse[source]

Retrieve a deposit switch

This 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 build logic related to the user’s direct deposit allocation preferences.

See endpoint docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchget>.

deposit_switch_token_create(deposit_switch_id: str) → DepositSwitchTokenCreateResponse[source]

Create a deposit switch token

In 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 can be used one time and expires after 30 minutes.

See endpoint docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchtokencreate>.

Search employer database

/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 user’s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow.

The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.

See endpoint docs at <https://plaid.com/docs/api/employers/#employerssearch>.

employment_verification_get(access_token: str) → EmploymentVerificationGetResponse[source]

(Deprecated) Retrieve a summary of an individual’s employment information

/employment/verification/get returns a list of employments through a user payroll that was verified by an end user.

This endpoint has been deprecated; new integrations should use /credit/employment/get instead.

See endpoint docs at <https://plaid.com/docs/api/products/income/#employmentverificationget>.

classmethod from_env() → PlaidClient[source]
identity_get(access_token: str, *, options: Optional[List[str]] = None) → IdentityGetResponse[source]

Retrieve identity data

The /identity/get endpoint allows you to 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.

This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.

Note: In API versions 2018-05-22 and earlier, the owners object is not returned, and instead identity information is returned in the top level identity object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).

See endpoint docs at <https://plaid.com/docs/api/products/identity/#identityget>.

identity_match(access_token: str, *, user: Optional[IdentityMatchUser] = None, options: Optional[List[str]] = None) → IdentityMatchResponse[source]

Retrieve identity match score

The /identity/match endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder’s financial institution.

This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.

See endpoint docs at <https://plaid.com/docs/api/products/identity/#identitymatch>.

identity_verification_create(is_shareable: bool, template_id: str, gave_consent: bool, user: IdentityVerificationRequestUser, *, is_idempotent: Optional[bool] = None) → IdentityVerificationResponse[source]

Create a new identity verification

Create 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 template_id provided. If you don’t know whether the associated user already has an active Identity Verification, you can specify “is_idempotent”: true in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated client_user_id and template_id. If an Identity Verification is found, it will be returned unmodified with an 200 OK HTTP status code.

See endpoint docs at <https://plaid.com/docs/api/products/identity-verification/#identity_verificationcreate>.

identity_verification_get(identity_verification_id: str) → IdentityVerificationResponse[source]

Retrieve Identity Verification

Retrieve a previously created identity verification

See endpoint docs at <https://plaid.com/docs/api/products/identity-verification/#identity_verificationget>.

identity_verification_list(template_id: str, client_user_id: str, *, cursor: Optional[str] = None) → PaginatedIdentityVerificationListResponse[source]

List Identity Verifications

Filter and list Identity Verifications created by your account

See endpoint docs at <https://plaid.com/docs/api/products/identity-verification/#identity_verificationlist>.

identity_verification_retry(client_user_id: str, template_id: str, strategy: str, *, steps: Optional[IdentityVerificationRetryRequestStepsObject] = None) → IdentityVerificationResponse[source]

Retry an Identity Verification

Allow a customer to retry their identity verification

See endpoint docs at <https://plaid.com/docs/api/products/identity-verification/#identity_verificationretry>.

income_verification_create(webhook: str, *, precheck_id: Optional[str] = None, options: Optional[List[str]] = None) → IncomeVerificationCreateResponse[source]

(Deprecated) Create an income verification instance

/income/verification/create begins the income verification process by returning an income_verification_id. You can then provide the income_verification_id to /link/token/create under the income_verification parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an INCOME webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.

See endpoint docs at <https://plaid.com/docs/api/products/income/#incomeverificationcreate>.

income_verification_documents_download(*, income_verification_id: Optional[str] = None, access_token: Optional[str] = None, document_id: Optional[str] = None) → None[source]

(Deprecated) Download the original documents used for income verification

/income/verification/documents/download provides the ability to download the source documents associated with the verification.

If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint.

The response to /income/verification/documents/download is a ZIP file in binary data. If a document_id is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification.

The request_id is returned in the Plaid-Request-ID header.

See endpoint docs at <https://plaid.com/docs/api/products/income/#incomeverificationdocumentsdownload>.

income_verification_paystubs_get(*, income_verification_id: Optional[str] = None, access_token: Optional[str] = None) → IncomeVerificationPaystubsGetResponse[source]

(Deprecated) Retrieve information from the paystubs used for income verification

/income/verification/paystubs/get returns the information collected from the paystubs that were used to verify an end user’s income. It can be called once the status of the verification has been set to VERIFICATION_STATUS_PROCESSING_COMPLETE, as reported by the INCOME: verification_status webhook. Attempting to call the endpoint before verification has been completed will result in an error.

This endpoint has been deprecated; new integrations should use /credit/payroll_income/get instead.

See endpoint docs at <https://plaid.com/docs/api/products/income/#incomeverificationpaystubsget>.

income_verification_precheck(*, user: Optional[IncomeVerificationPrecheckUser] = None, employer: Optional[IncomeVerificationPrecheckEmployer] = None, transactions_access_token: Optional[str] = None, transactions_access_tokens: Optional[List[str]] = None, us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo] = None) → IncomeVerificationPrecheckResponse[source]

(Deprecated) Check digital income verification eligibility and optimize conversion

/income/verification/precheck is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a precheck_id that can be provided to /link/token/create. If the user is eligible for digital verification, providing the precheck_id in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the precheck_id can still be provided to /link/token/create and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income.

While all request fields are optional, providing either employer or transactions_access_tokens data will increase the chance of receiving a useful result.

This endpoint has been deprecated; new integrations should use /credit/payroll_income/precheck instead.

See endpoint docs at <https://plaid.com/docs/api/products/income/#incomeverificationprecheck>.

income_verification_refresh(*, income_verification_id: Optional[str] = None, access_token: Optional[str] = None) → IncomeVerificationRefreshResponse[source]

(Deprecated) Refresh an income verification

/income/verification/refresh refreshes a given income verification.

See endpoint docs at <https://plaid.com/docs/api/products/income/#incomeverificationrefresh>.

income_verification_taxforms_get(*, income_verification_id: Optional[str] = None, access_token: Optional[str] = None) → IncomeVerificationTaxformsGetResponse[source]

(Deprecated) Retrieve information from the tax documents used for income verification

/income/verification/taxforms/get returns the information collected from forms that were used to verify an end user’’s income. It can be called once the status of the verification has been set to VERIFICATION_STATUS_PROCESSING_COMPLETE, as reported by the INCOME: verification_status webhook. Attempting to call the endpoint before verification has been completed will result in an error.

This endpoint has been deprecated; new integrations should use /credit/payroll_income/get instead.

See endpoint docs at <https://plaid.com/docs/api/products/income/#incomeverificationtaxformsget>.

institutions_get(count: int, offset: int, country_codes: List[str], *, options: Optional[InstitutionsGetRequestOptions] = None) → InstitutionsGetResponse[source]

Get details of all supported institutions

Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated.

If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.

See endpoint docs at <https://plaid.com/docs/api/institutions/#institutionsget>.

institutions_get_by_id(institution_id: str, country_codes: List[str], *, options: Optional[InstitutionsGetByIdRequestOptions] = None) → InstitutionsGetByIdResponse[source]

Get details of an institution

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

Versioning note: API versions 2019-05-29 and earlier allow use of the public_key parameter instead of the client_id and secret to authenticate to this endpoint. The public_key has been deprecated; all customers are encouraged to use client_id and secret instead.

See endpoint docs at <https://plaid.com/docs/api/institutions/#institutionsget_by_id>.

Search institutions

Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.

Versioning note: API versions 2019-05-29 and earlier allow use of the public_key parameter instead of the client_id and secret parameters to authenticate to this endpoint. The public_key parameter has since been deprecated; all customers are encouraged to use client_id and secret instead.

See endpoint docs at <https://plaid.com/docs/api/institutions/#institutionssearch>.

investments_holdings_get(access_token: str, *, options: Optional[List[str]] = None) → InvestmentsHoldingsGetResponse[source]

Get Investment holdings

The /investments/holdings/get endpoint allows developers to receive user-authorized stock position data for investment-type accounts.

See endpoint docs at <https://plaid.com/docs/api/products/investments/#investmentsholdingsget>.

investments_transactions_get(access_token: str, start_date: str, end_date: str, *, options: Optional[InvestmentsTransactionsGetRequestOptions] = None) → InvestmentsTransactionsGetResponse[source]

Get investment transactions

The /investments/transactions/get endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts.

Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift.

Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_investment_transactions response body field to fetch all available investment transactions.

See endpoint docs at <https://plaid.com/docs/api/products/investments/#investmentstransactionsget>.

item_access_token_invalidate(access_token: str) → ItemAccessTokenInvalidateResponse[source]

Invalidate access_token

By default, the access_token associated with an Item does not expire and should be stored in a persistent, secure manner.

You can use the /item/access_token/invalidate endpoint to rotate the access_token associated with an Item. The endpoint returns a new access_token and immediately invalidates the previous access_token.

See endpoint docs at <https://plaid.com/docs/api/tokens/#itemaccess_tokeninvalidate>.

item_application_list(*, access_token: Optional[str] = None) → ItemApplicationListResponse[source]

List a user’s connected applications

item_application_scopes_update(access_token: str, application_id: str, scopes: Scopes, context: str, *, state: Optional[str] = None) → ItemApplicationScopesUpdateResponse[source]

Update the scopes of access for a particular application

Enable consumers to update product access on selected accounts for an application.

item_create_public_token(access_token: str) → ItemPublicTokenCreateResponse[source]

Create public token

Note: 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 use with [update mode](https://plaid.com/docs/link/update-mode).

If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the /item/public_token/create endpoint and then initialize Link with that public_token.

A public_token is one-time use and expires after 30 minutes. You use a public_token to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a public_token for an Item even if you did not use Link to create the Item originally.

The /item/public_token/create endpoint is not used to create your initial public_token. If you have not already received an access_token for a specific Item, use Link to obtain your public_token instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.

See endpoint docs at <https://plaid.com/docs/api/tokens/#itempublic_tokencreate>.

item_get(access_token: str) → ItemGetResponse[source]

Retrieve an Item

Returns information about the status of an Item.

See endpoint docs at <https://plaid.com/docs/api/items/#itemget>.

item_import(products: List[str], user_auth: ItemImportRequestUserAuth, *, options: Optional[str] = None) → ItemImportResponse[source]

Import Item

/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 (user_auth.user_id) and Authentication Token (user_auth.auth_token) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you.

Upon creating an Item via /item/import, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (target_account_id).

item_public_token_exchange(public_token: str) → ItemPublicTokenExchangeResponse[source]

Exchange public token for an 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 successfully created an Item. The public_token is ephemeral and expires after 30 minutes. An access_token does not expire, but can be revoked by calling /item/remove.

The response also includes an item_id that should be stored with the access_token. The item_id is used to identify an Item in a webhook. The item_id can also be retrieved by making an /item/get request.

See endpoint docs at <https://plaid.com/docs/api/tokens/#itempublic_tokenexchange>.

item_remove(access_token: str) → ItemRemoveResponse[source]

Remove an Item

The /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 the Item, is no longer valid and cannot be used to access any data that was associated with the Item.

Note that in the Development environment, issuing an /item/remove request will not decrement your live credential count. To increase your credential account in Development, contact Support.

Also note that for certain OAuth-based institutions, an Item removed via /item/remove may still show as an active connection in the institution’s OAuth permission manager.

API versions 2019-05-29 and earlier return a removed boolean as part of the response.

See endpoint docs at <https://plaid.com/docs/api/items/#itemremove>.

item_webhook_update(access_token: str, *, webhook: Optional[str] = None) → ItemWebhookUpdateResponse[source]

Update Webhook URL

The POST /item/webhook/update allows you to update the webhook URL associated with an Item. This request triggers a [WEBHOOK_UPDATE_ACKNOWLEDGED](https://plaid.com/docs/api/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL.

See endpoint docs at <https://plaid.com/docs/api/items/#itemwebhookupdate>.

liabilities_get(access_token: str, *, options: Optional[List[str]] = None) → LiabilitiesGetResponse[source]

Retrieve Liabilities data

The /liabilities/get endpoint 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. Currently supported account types are account type credit with account subtype credit card or paypal, and account type loan with account subtype student or mortgage. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the account_filters parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate).

The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling /liabilities/get.

Note: This request may take some time to complete if liabilities was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.

See endpoint docs at <https://plaid.com/docs/api/products/liabilities/#liabilitiesget>.

Create Link Token

The /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 public_token, which can then be exchanged for an access_token via /item/public_token/exchange as part of the main Link flow.

A link_token generated by /link/token/create is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.

See endpoint docs at <https://plaid.com/docs/api/tokens/#linktokencreate>.

Get Link Token

The /link/token/get endpoint gets information about a previously-created link_token using the /link/token/create endpoint. It can be useful for debugging purposes.

See endpoint docs at <https://plaid.com/docs/api/tokens/#linktokenget>.

partner_customers_create(company_name: str, is_diligence_attested: bool, products: List[str], *, create_link_customization: Optional[bool] = None) → PartnerCustomersCreateResponse[source]

Creates a new client for a reseller partner end customer.

The /partner/v1/customers/create endpoint is used by reseller partners to create an end customer client.

Create payment consent

The /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 consents are created with UNAUTHORISED status by default and must be authorised by the user before payments can be initiated.

Consents can be limited in time and scope, and have constraints that describe limitations for payments.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationconsentcreate>.

Get payment consent

The /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 and constraints.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationconsentget>.

Execute a single payment using consent

The /payment_initiation/consent/payment/execute endpoint can be used to execute payments using payment consent.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationconsentpaymentexecute>.

Revoke payment consent

The /payment_initiation/consent/revoke endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationconsentrevoke>.

payment_initiation_payment_create(recipient_id: str, reference: str, amount: PaymentAmount, *, schedule: Optional[ExternalPaymentScheduleBase] = None, options: Optional[ExternalPaymentOptions] = None) → PaymentInitiationPaymentCreateResponse[source]

Create a payment

After creating a payment recipient, you can use the /payment_initiation/payment/create endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day.

Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.

In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationpaymentcreate>.

payment_initiation_payment_get(payment_id: str) → PaymentInitiationPaymentGetResponse[source]

Get payment details

The /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 payment amount. In the case of standing orders, the /payment_initiation/payment/get endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationpaymentget>.

payment_initiation_payment_list(*, count: Optional[int] = None, cursor: Optional[str] = None, consent_id: Optional[str] = None) → PaymentInitiationPaymentListResponse[source]

List payments

The /payment_initiation/payment/list endpoint can be used to 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.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationpaymentlist>.

payment_initiation_payment_reverse(payment_id: str, idempotency_key: str, reference: str) → PaymentInitiationPaymentReverseResponse[source]

Reverse an existing payment

Reverse a previously initiated payment.

A payment can only be reversed once and will be refunded to the original sender’s account.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationpaymentreverse>.

payment_initiation_recipient_create(name_: str, *, iban: Optional[str] = None, bacs: Optional[RecipientBacs] = None, address: Optional[PaymentInitiationAddress] = None) → PaymentInitiationRecipientCreateResponse[source]

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). For a standing order (recurring) payment, the recipient must be in the UK.

The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same recipient_id.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationrecipientcreate>.

payment_initiation_recipient_get(recipient_id: str) → PaymentInitiationRecipientGetResponse[source]

Get payment recipient

Get details about a payment recipient you have previously created.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationrecipientget>.

payment_initiation_recipient_list() → PaymentInitiationRecipientListResponse[source]

List payment recipients

The /payment_initiation/recipient/list endpoint list the payment recipients that you have previously created.

See endpoint docs at <https://plaid.com/docs/api/products/payment-initiation/#payment_initiationrecipientlist>.

payment_profile_create() → PaymentProfileCreateResponse[source]

Create payment profile

Use /payment_profile/create endpoint to create a new payment profile, the return value is a Payment Profile ID. Attach it to the link token create request and the link workflow will then “activate” this Payment Profile if the linkage is successful. It can then be used to create Transfers using /transfer/authorization/create and /transfer/create`.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#payment_profilecreate>.

payment_profile_get(payment_profile_id: str) → PaymentProfileGetResponse[source]

Get payment profile

Use the /payment_profile/get endpoint to get the status of a given Payment Profile.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#payment_profileget>.

payment_profile_remove(payment_profile_id: str) → PaymentProfileRemoveResponse[source]

Remove payment profile

Use the /payment_profile/remove endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#payment_profileremove>.

processor_apex_processor_token_create(access_token: str, account_id: str) → ProcessorTokenCreateResponse[source]

Create Apex bank account token

Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.

See endpoint docs at <https://plaid.com/docs/none/>.

processor_auth_get(processor_token: str) → ProcessorAuthGetResponse[source]

Retrieve Auth data

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 associated with a given processor_token. The endpoint also returns high-level account data and balances when available.

Versioning note: API versions 2019-05-29 and earlier use a different schema for the numbers object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).

See endpoint docs at <https://plaid.com/docs/api/processors/#processorauthget>.

processor_balance_get(processor_token: str, *, options: Optional[str] = None) → ProcessorBalanceGetResponse[source]

Retrieve Balance data

The /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 /processor/balance/get forces the available and current balance fields to be refreshed rather than cached.

See endpoint docs at <https://plaid.com/docs/api/processors/#processorbalanceget>.

processor_bank_transfer_create(idempotency_key: str, processor_token: str, type: str, network: str, amount: str, iso_currency_code: str, description: str, user: BankTransferUser, *, ach_class: Optional[str] = None, custom_tag: Optional[str] = None, metadata: Optional[BankTransferMetadata] = None, origination_account_id: Optional[str] = None) → ProcessorBankTransferCreateResponse[source]

Create a bank transfer as a processor

Use the /processor/bank_transfer/create endpoint to initiate a new bank transfer as a processor

See endpoint docs at <https://plaid.com/docs/api/processors/#bank_transfercreate>.

processor_identity_get(processor_token: str) → ProcessorIdentityGetResponse[source]

Retrieve Identity data

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

See endpoint docs at <https://plaid.com/docs/api/processors/#processoridentityget>.

processor_stripe_bank_account_token_create(access_token: str, account_id: str) → ProcessorStripeBankAccountTokenCreateResponse[source]

Create Stripe bank account token

Used 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 app](https://plaid.com/docs/auth/partnerships/stripe/). Bank account tokens can also be revoked, using /item/remove.

See endpoint docs at <https://plaid.com/docs/api/processors/#processorstripebank_account_tokencreate>.

processor_token_create(access_token: str, account_id: str, processor: str) → ProcessorTokenCreateResponse[source]

Create processor token

Used 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; see /processor/stripe/bank_account_token/create for creating tokens for use with Stripe integrations. Processor tokens can also be revoked, using /item/remove.

See endpoint docs at <https://plaid.com/docs/api/processors/#processortokencreate>.

sandbox_bank_transfer_fire_webhook(webhook: str) → SandboxBankTransferFireWebhookResponse[source]

Manually fire a Bank Transfer webhook

Use the /sandbox/bank_transfer/fire_webhook endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference/#sandboxbank_transferfire_webhook>.

sandbox_bank_transfer_simulate(bank_transfer_id: str, event_type: str, *, failure_reason: Optional[BankTransferFailure] = None) → SandboxBankTransferSimulateResponse[source]

Simulate a bank transfer event in Sandbox

Use 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 will appear when using endpoints such as /bank_transfer/event/sync or /bank_transfer/event/list, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

See endpoint docs at <https://plaid.com/docs/bank-transfers/reference/#sandboxbank_transfersimulate>.

sandbox_income_fire_webhook(item_id: str, webhook: str, verification_status: str, *, user_id: Optional[str] = None) → SandboxIncomeFireWebhookResponse[source]

Manually fire an Income webhook

Use the /sandbox/income/fire_webhook endpoint to manually trigger an Income webhook in the Sandbox environment.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxincomefire_webhook>.

sandbox_item_fire_webhook(access_token: str, webhook_code: str, *, webhook_type: Optional[str] = None) → SandboxItemFireWebhookResponse[source]

Fire a test webhook

The /sandbox/item/fire_webhook endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks:

DEFAULT_UPDATE: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a SANDBOX_PRODUCT_NOT_ENABLED error will result.

NEW_ACCOUNTS_AVAILABLE: Webhook to be fired for a given Sandbox Item created with Account Select v2.

AUTH_DATA_UPDATE: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product.

RECURRING_TRANSACTIONS_UPDATE: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a SANDBOX_PRODUCT_NOT_ENABLED error will result.

Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxitemfire_webhook>.

sandbox_item_reset_login(access_token: str) → SandboxItemResetLoginResponse[source]

Force a Sandbox Item into an error state

/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 test Link’s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling /sandbox/item/reset_login, You can then use Plaid Link update mode to restore the Item to a good state. An ITEM_LOGIN_REQUIRED webhook will also be fired after a call to this endpoint, if one is associated with the Item.

In the Sandbox, Items will transition to an ITEM_LOGIN_REQUIRED error state automatically after 30 days, even if this endpoint is not called.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxitemreset_login>.

sandbox_item_set_verification_status(access_token: str, account_id: str, verification_status: str) → SandboxItemSetVerificationStatusResponse[source]

Set verification status for Sandbox account

The /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 Automated Micro-deposit flow.

Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access).

For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxitemset_verification_status>.

sandbox_oauth_select_accounts(oauth_state_id: str, accounts: List[str]) → SandboxOauthSelectAccountsResponse[source]

Save the selected accounts when connecting to the Platypus Oauth institution

sandbox_processor_token_create(institution_id: str, *, options: Optional[SandboxProcessorTokenCreateRequestOptions] = None) → SandboxProcessorTokenCreateResponse[source]

Create a test Item and processor token

Use the /sandbox/processor_token/create endpoint to create a valid processor_token for an arbitrary institution ID and test credentials. The created processor_token corresponds to a new Sandbox Item. You can then use this processor_token with the /processor/ API endpoints in Sandbox. You can also use /sandbox/processor_token/create with the [user_custom test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxprocessor_tokencreate>.

sandbox_public_token_create(institution_id: str, initial_products: List[str], *, options: Optional[SandboxPublicTokenCreateRequestOptions] = None, user_token: Optional[str] = None) → SandboxPublicTokenCreateResponse[source]

Create a test Item

Use the /sandbox/public_token/create endpoint to 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. You can then call /item/public_token/exchange to exchange the public_token for an access_token and perform all API actions. /sandbox/public_token/create can also be used with the [user_custom test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. /sandbox/public_token/create cannot be used with OAuth institutions.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxpublic_tokencreate>.

sandbox_transfer_fire_webhook(webhook: str) → SandboxTransferFireWebhookResponse[source]

Manually fire a Transfer webhook

Use the /sandbox/transfer/fire_webhook endpoint to manually trigger a Transfer webhook in the Sandbox environment.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxtransferfire_webhook>.

sandbox_transfer_repayment_simulate() → SandboxTransferRepaymentSimulateResponse[source]

Trigger the creation of a repayment

Use 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 that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxtransferrepaymentsimulate>.

sandbox_transfer_simulate(transfer_id: str, event_type: str, *, failure_reason: Optional[TransferFailure] = None) → SandboxTransferSimulateResponse[source]

Simulate a transfer event in Sandbox

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 endpoints such as /transfer/event/sync or /transfer/event/list, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxtransfersimulate>.

sandbox_transfer_sweep_simulate() → SandboxTransferSweepSimulateResponse[source]

Simulate creating a sweep

Use the /sandbox/transfer/sweep/simulate endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all posted or pending transfers with a sweep status of unswept will become swept, and all returned transfers with a sweep status of swept will become return_swept.

See endpoint docs at <https://plaid.com/docs/api/sandbox/#sandboxtransfersweepsimulate>.

send(method: str, url: str, headers: Dict[str, Optional[str]], params: Dict[str, Optional[Union[str, int]]], data: Dict[str, Any]) → str[source]
signal_decision_report(client_transaction_id: str, initiated: bool, *, days_funds_on_hold: Optional[int] = None) → SignalDecisionReportResponse[source]

Report whether you initiated an ACH transaction

After calling /signal/evaluate, call /signal/decision/report to report whether the transaction was initiated. This endpoint will return an INVALID_REQUEST error if called a second time with a different value for initiated.

See endpoint docs at <https://plaid.com/docs/signal/reference#signaldecisionreport>.

signal_evaluate(access_token: str, account_id: str, client_transaction_id: str, amount: float, *, user_present: Optional[bool] = None, client_user_id: Optional[str] = None, user: Optional[SignalUser] = None, device: Optional[SignalDevice] = None) → SignalEvaluateResponse[source]

Evaluate a planned ACH transaction

Use /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.

In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If /signal/evaluate is called on the same transaction multiple times within a 24-hour period, cached results may be returned.

See endpoint docs at <https://plaid.com/docs/signal/reference#signalevaluate>.

signal_prepare(access_token: str) → SignalPrepareResponse[source]

Prepare the Signal product before calling /signal/evaluate

Call /signal/prepare with Plaid-linked bank account information at least 10 seconds before calling /signal/evaluate or as soon as an end-user enters the ACH deposit flow in your application.

See endpoint docs at <https://plaid.com/docs/signal/reference#signalprepare>.

signal_return_report(client_transaction_id: str, return_code: str) → SignalReturnReportResponse[source]

Report a return for an ACH transaction

Call the /signal/return/report endpoint to report a returned transaction that was previously sent to the /signal/evaluate endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.

See endpoint docs at <https://plaid.com/docs/signal/reference#signalreturnreport>.

transactions_enhance(account_type: str, transactions: List[ClientProvidedRawTransaction]) → TransactionsEnhanceGetResponse[source]

enhance locally-held transaction data

The ‘/beta/transactions/v1/enhance’ endpoint enriches raw transaction data provided directly by clients.

The product is currently in beta.

transactions_get(access_token: str, start_date: str, end_date: str, *, options: Optional[TransactionsGetRequestOptions] = None) → TransactionsGetResponse[source]

Get transaction data

The /transactions/get endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. 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.

Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in /transactions/get. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions).

Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_transactions response body field to fetch all available transactions.

Data returned by /transactions/get will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item’s status.transactions.last_successful_update field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the /transactions/refresh endpoint.

Note that data may not be immediately available to /transactions/get. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with transactions, or upon the first call to /transactions/get, if it wasn’t. To be alerted when transaction data is ready to be fetched, listen for the [INITIAL_UPDATE](https://plaid.com/docs/api/products/transactions/#initial_update) and [HISTORICAL_UPDATE](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when /transactions/get is called, it will return a PRODUCT_NOT_READY error.

See endpoint docs at <https://plaid.com/docs/api/products/transactions/#transactionsget>.

transactions_recurring_get(access_token: str, account_ids: List[str], *, options: Optional[bool] = None) → TransactionsRecurringGetResponse[source]

Fetch recurring transaction streams

The /transactions/recurring/get endpoint allows developers to 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. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.

This endpoint is not included by default as part of Transactions. To request access to this endpoint and learn more about pricing, contact your Plaid account manager.

Note that unlike /transactions/get, /transactions/recurring/get will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in /link/token/create, or after Link, by calling /transactions/get) before calling this endpoint. Data is available to /transactions/recurring/get approximately 5 seconds after the [HISTORICAL_UPDATE](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization).

After the initial call, you can call /transactions/recurring/get endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.

See endpoint docs at <https://plaid.com/docs/api/products/transactions/#transactionsrecurringget>.

transactions_refresh(access_token: str) → TransactionsRefreshResponse[source]

Refresh transaction data

/transactions/refresh is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling /transactions/refresh, Plaid will fire a webhook: [TRANSACTIONS_REMOVED](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [DEFAULT_UPDATE](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling /transactions/get.

Access to /transactions/refresh in Production is specific to certain pricing plans. If you cannot access /transactions/refresh in Production, [contact Sales](https://www.plaid.com/contact) for assistance.

See endpoint docs at <https://plaid.com/docs/api/products/transactions/#transactionsrefresh>.

transactions_rules_create(access_token: str, personal_finance_category: str, rule_details: TransactionsRuleDetails) → TransactionsRulesCreateResponse[source]

Create transaction category rule

The /transactions/rules/v1/create endpoint creates transaction categorization rules.

Rules will be applied on the Item’s transactions returned in /transactions/get response.

The product is currently in beta. To request access, contact transactions-feedback@plaid.com.

transactions_rules_list(access_token: str) → TransactionsRulesListResponse[source]

Return a list of rules created for the Item associated with the access token.

The /transactions/rules/v1/list returns a list of transaction rules created for the Item associated with the access token.

transactions_rules_remove(access_token: str, rule_id: str) → TransactionsRulesRemoveResponse[source]

Remove transaction rule

The /transactions/rules/v1/remove endpoint is used to remove a transaction rule.

transactions_sync(access_token: str, *, cursor: Optional[str] = None, count: Optional[int] = None, options: Optional[TransactionsSyncRequestOptions] = None) → TransactionsSyncResponse[source]

Get incremental transaction updates on an Item

This endpoint replaces /transactions/get and its associated webhooks for most common use-cases.

The /transactions/sync endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. /transactions/sync provides the same functionality as /transactions/get and can be used instead of /transactions/get to simplify the process of tracking transactions updates.

This endpoint provides user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student; coverage may be limited). For transaction history from investments accounts, use /investments/transactions/get instead.

Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API.

In the first call to /transactions/sync for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as “adds”), which then generates a next_cursor for that Item. In subsequent calls, send the next_cursor to receive only the changes that have occurred since the previous call.

Due to the potentially large number of transactions associated with an Item, results are paginated. The has_more field specifies if additional calls are necessary to fetch all available transaction updates.

Whenever new or updated transaction data becomes available, /transactions/sync will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item’s status.transactions.last_successful_update field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the /transactions/refresh endpoint.

Note that for newly created Items, data may not be immediately available to /transactions/sync. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.

To be alerted when new data is available, listen for the [SYNC_UPDATES_AVAILABLE](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.

See endpoint docs at <https://plaid.com/docs/api/products/transactions/#transactionssync>.

transfer_authorization_create(type: str, network: str, amount: str, ach_class: str, user: TransferAuthorizationUserInRequest, *, access_token: Optional[str] = None, account_id: Optional[str] = None, device: Optional[TransferAuthorizationDevice] = None, origination_account_id: Optional[str] = None, iso_currency_code: Optional[str] = None, user_present: Optional[bool] = None, payment_profile_id: Optional[str] = None) → TransferAuthorizationCreateResponse[source]

Create a transfer authorization

Use the /transfer/authorization/create endpoint to determine transfer failure risk.

In Plaid’s sandbox environment the decisions will be returned as follows:

For guaranteed ACH customers, the following fields are required : user.phone_number (optional if email_address provided), user.email_address (optional if phone_number provided), device.ip_address, device.user_agent, and user_present.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transferauthorizationcreate>.

transfer_cancel(transfer_id: str) → TransferCancelResponse[source]

Cancel a transfer

Use the /transfer/cancel endpoint to cancel a transfer. A transfer is eligible for cancelation if the cancellable property returned by /transfer/get is true.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transfercancel>.

transfer_create(authorization_id: str, type: str, network: str, amount: str, description: str, ach_class: str, user: TransferUserInRequest, *, idempotency_key: Optional[str] = None, access_token: Optional[str] = None, account_id: Optional[str] = None, metadata: Optional[TransferMetadata] = None, origination_account_id: Optional[str] = None, iso_currency_code: Optional[str] = None, payment_profile_id: Optional[str] = None) → TransferCreateResponse[source]

Create a transfer

Use the /transfer/create endpoint to initiate a new transfer.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transfercreate>.

transfer_event_list(*, start_date: Optional[str] = None, end_date: Optional[str] = None, transfer_id: Optional[str] = None, account_id: Optional[str] = None, transfer_type: Optional[str] = None, event_types: Optional[List[str]] = None, sweep_id: Optional[str] = None, count: Optional[int] = None, offset: Optional[int] = None, origination_account_id: Optional[str] = None) → TransferEventListResponse[source]

List transfer events

Use the /transfer/event/list endpoint to get a list of transfer events based on specified filter criteria.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transfereventlist>.

transfer_event_sync(after_id: int, *, count: Optional[int] = None) → TransferEventSyncResponse[source]

Sync transfer events

/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 guarantee you have seen all transfer events.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transfereventsync>.

transfer_get(transfer_id: str) → TransferGetResponse[source]

Retrieve a transfer

The /transfer/get fetches information about the transfer corresponding to the given transfer_id.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transferget>.

transfer_intent_create(mode: str, amount: str, description: str, ach_class: str, user: TransferUserInRequest, *, account_id: Optional[str] = None, origination_account_id: Optional[str] = None, metadata: Optional[TransferMetadata] = None, iso_currency_code: Optional[str] = None, require_guarantee: Optional[bool] = None) → TransferIntentCreateResponse[source]

Create a transfer intent object to invoke the Transfer UI

Use the /transfer/intent/create endpoint to generate a transfer intent object and invoke the Transfer UI.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transferintentcreate>.

transfer_intent_get(transfer_intent_id: str) → TransferIntentGetResponse[source]

Retrieve more information about a transfer intent

Use the /transfer/intent/get endpoint to retrieve more information about a transfer intent.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transferintentget>.

transfer_list(*, start_date: Optional[str] = None, end_date: Optional[str] = None, count: Optional[int] = None, offset: Optional[int] = None, origination_account_id: Optional[str] = None) → TransferListResponse[source]

List transfers

Use 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 retrieve the desired transfers.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transferlist>.

transfer_migrate_account(account_number: str, routing_number: str, account_type: str, *, wire_routing_number: Optional[str] = None) → TransferMigrateAccountResponse[source]

Migrate account into Transfers

As 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 Items. Note that Items created in this way are not compatible with endpoints for other products, such as /accounts/balance/get, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to /transfer/migrate_account is not enabled by default; to obtain access, contact your Plaid Account Manager.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transfermigrate_account>.

transfer_repayment_list(*, start_date: Optional[str] = None, end_date: Optional[str] = None, count: Optional[int] = None, offset: Optional[int] = None) → TransferRepaymentListResponse[source]

Lists historical repayments

The /transfer/repayment/list endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given start_time.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transferrepaymentlist>.

transfer_repayment_return_list(repayment_id: str, *, count: Optional[int] = None, offset: Optional[int] = None) → TransferRepaymentReturnListResponse[source]

List the returns included in a repayment

The /transfer/repayment/return/list endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transferrepaymentreturnlist>.

transfer_sweep_get(sweep_id: str) → TransferSweepGetResponse[source]

Retrieve a sweep

The /transfer/sweep/get endpoint fetches a sweep corresponding to the given sweep_id.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transfersweepget>.

transfer_sweep_list(*, start_date: Optional[str] = None, end_date: Optional[str] = None, count: Optional[int] = None, offset: Optional[int] = None) → TransferSweepListResponse[source]

List sweeps

The /transfer/sweep/list endpoint fetches sweeps matching the given filters.

See endpoint docs at <https://plaid.com/docs/api/products/transfer/#transfersweeplist>.

user_create(client_user_id: str) → UserCreateResponse[source]

Create user

This 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 associated with the user. You should only create one per end user.

If you call the endpoint multiple times with the same client_user_id, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given client_user_id.

See endpoint docs at <https://plaid.com/docs/api/products/income/#usercreate>.

wallet_create(iso_currency_code: str) → WalletCreateResponse[source]

Create an e-wallet

Create an e-wallet. The response is the newly created e-wallet object.

See endpoint docs at <https://plaid.com/docs/api/products/#walletcreate>.

wallet_get(wallet_id: str) → WalletGetResponse[source]

Fetch an e-wallet

Fetch an e-wallet. The response includes the current balance.

See endpoint docs at <https://plaid.com/docs/api/products/#walletget>.

wallet_list(*, iso_currency_code: Optional[str] = None, cursor: Optional[str] = None, count: Optional[int] = None) → WalletListResponse[source]

Fetch a list of e-wallets

This endpoint lists all e-wallets in descending order of creation.

See endpoint docs at <https://plaid.com/docs/api/products/#walletlist>.

wallet_transaction_execute(idempotency_key: str, wallet_id: str, counterparty: WalletTransactionCounterparty, amount: WalletTransactionAmount, reference: str) → WalletTransactionExecuteResponse[source]

Execute a transaction using an e-wallet

Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.

See endpoint docs at <https://plaid.com/docs/api/products/#wallettransactionexecute>.

wallet_transaction_get(transaction_id: str) → WalletTransactionGetResponse[source]

Fetch a specific e-wallet transaction

See endpoint docs at <https://plaid.com/docs/api/products/#wallettransactionget>.

wallet_transactions_list(wallet_id: str, *, cursor: Optional[str] = None, count: Optional[int] = None) → WalletTransactionsListResponse[source]

List e-wallet transactions

This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the created_at time.

See endpoint docs at <https://plaid.com/docs/api/products/#wallettransactionslist>.

watchlist_screening_entity_create(search_terms: EntityWatchlistSearchTerms, *, client_user_id: Optional[str] = None) → EntityWatchlistScreeningResponse[source]

Create a watchlist screening for an entity

Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentitycreate>.

watchlist_screening_entity_get(entity_watchlist_screening_id: str) → EntityWatchlistScreeningResponse[source]

Get an entity screening

Retrieve an entity watchlist screening.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityget>.

watchlist_screening_entity_history_list(entity_watchlist_screening_id: str, *, cursor: Optional[str] = None) → PaginatedEntityWatchlistScreeningListResponse[source]

List history for entity watchlist screenings

List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityhistorylist>.

watchlist_screening_entity_hits_list(entity_watchlist_screening_id: str, *, cursor: Optional[str] = None) → PaginatedEntityWatchlistScreeningHitListResponse[source]

List hits for entity watchlist screenings

List all hits for the entity watchlist screening.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityhitlist>.

watchlist_screening_entity_list(entity_watchlist_program_id: str, *, client_user_id: Optional[str] = None, status: Optional[str] = None, assignee: Optional[str] = None, cursor: Optional[str] = None) → PaginatedEntityWatchlistScreeningListResponse[source]

List entity watchlist screenings

List all entity screenings.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentitylist>.

watchlist_screening_entity_program_get(entity_watchlist_program_id: str) → EntityWatchlistProgramResponse[source]

Get entity watchlist screening program

Get an entity watchlist screening program

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityprogramget>.

watchlist_screening_entity_program_list(*, cursor: Optional[str] = None) → PaginatedEntityWatchlistProgramListResponse[source]

List entity watchlist screening programs

List all entity watchlist screening programs

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityprogramlist>.

watchlist_screening_entity_review_create(confirmed_hits: List[str], dismissed_hits: List[str], entity_watchlist_screening_id: str, *, comment: Optional[str] = None) → EntityWatchlistScreeningReviewResponse[source]

Create a review for an entity watchlist screening

Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityreviewcreate>.

watchlist_screening_entity_review_list(entity_watchlist_screening_id: str, *, cursor: Optional[str] = None) → PaginatedEntityWatchlistScreeningReviewListResponse[source]

List reviews for entity watchlist screenings

List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityreviewlist>.

watchlist_screening_entity_update(entity_watchlist_screening_id: str, *, search_terms: Optional[UpdateEntityScreeningRequestSearchTerms] = None, assignee: Optional[str] = None, status: Optional[str] = None, client_user_id: Optional[str] = None, reset_fields: Optional[List[str]] = None) → EntityWatchlistScreeningResponse[source]

Update an entity screening

Update an entity watchlist screening.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningentityupdate>.

watchlist_screening_individual_create(search_terms: WatchlistScreeningRequestSearchTerms, *, client_user_id: Optional[str] = None) → WatchlistScreeningIndividualResponse[source]

Create a watchlist screening for a person

Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualcreate>.

watchlist_screening_individual_get(watchlist_screening_id: str) → WatchlistScreeningIndividualResponse[source]

Retrieve an individual watchlist screening

Retrieve a previously created individual watchlist screening

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualget>.

watchlist_screening_individual_history_list(watchlist_screening_id: str, *, cursor: Optional[str] = None) → PaginatedIndividualWatchlistScreeningListResponse[source]

List history for individual watchlist screenings

List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualhistorylist>.

watchlist_screening_individual_hit_list(watchlist_screening_id: str, *, cursor: Optional[str] = None) → PaginatedIndividualWatchlistScreeningHitListResponse[source]

List hits for individual watchlist screening

List all hits found by Plaid for a particular individual watchlist screening.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualhitlist>.

watchlist_screening_individual_list(watchlist_program_id: str, *, client_user_id: Optional[str] = None, status: Optional[str] = None, assignee: Optional[str] = None, cursor: Optional[str] = None) → PaginatedIndividualWatchlistScreeningListResponse[source]

List Individual Watchlist Screenings

List previously created watchlist screenings for individuals

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividuallist>.

watchlist_screening_individual_program_get(watchlist_program_id: str) → IndividualWatchlistProgramResponse[source]

Get individual watchlist screening program

Get an individual watchlist screening program

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualprogramget>.

watchlist_screening_individual_program_list(*, cursor: Optional[str] = None) → PaginatedIndividualWatchlistProgramListResponse[source]

List individual watchlist screening programs

List all individual watchlist screening programs

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualprogramlist>.

watchlist_screening_individual_review_create(confirmed_hits: List[str], dismissed_hits: List[str], watchlist_screening_id: str, *, comment: Optional[str] = None) → WatchlistScreeningReviewResponse[source]

Create a review for an individual watchlist screening

Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualreviewcreate>.

watchlist_screening_individual_reviews_list(watchlist_screening_id: str, *, cursor: Optional[str] = None) → PaginatedIndividualWatchlistScreeningReviewListResponse[source]

List reviews for individual watchlist screenings

List all reviews for the individual watchlist screening.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualreviewlist>.

watchlist_screening_individual_update(watchlist_screening_id: str, *, search_terms: Optional[UpdateIndividualScreeningRequestSearchTerms] = None, assignee: Optional[str] = None, status: Optional[str] = None, client_user_id: Optional[str] = None, reset_fields: Optional[List[str]] = None) → WatchlistScreeningIndividualResponse[source]

Update individual watchlist screening

Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update search_terms and status at the same time since editing search_terms may trigger an automatic status change.

See endpoint docs at <https://plaid.com/docs/api/products/monitor/#watchlist_screeningindividualupdate>.

webhook_verification_key_get(key_id: str) → WebhookVerificationKeyGetResponse[source]

Get webhook verification key

Plaid 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 message signature is included in the Plaid-Verification header.

The /webhook_verification_key/get endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.

See endpoint docs at <https://plaid.com/docs/api/webhooks/webhook-verification/#webhook_verification_keyget>.

plaid2.client.log_prepped_request(req: Request, prepped: PreparedRequest) → None[source]
plaid2.client.log_response(res: Response) → None[source]
plaid2.client.raise_for_status(res: Response) → None[source]