Skip to content

Zapgram/pilot-plaid-python

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
docs
docs
 
 
plaid
plaid
 
 
templates/python
templates/python
 
 
2020-09-14.yml
2020-09-14.yml
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
requirements.txt
requirements.txt
 
 
setup.cfg
setup.cfg
 
 
setup.py
setup.py
 
 
test-requirements.txt
test-requirements.txt
 
 
tox.ini
tox.ini
 
 

Repository files navigation

plaid

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

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2020-09-14_1.394.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://plaid.com

Requirements.

Python >=3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import plaid

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import plaid

Getting Started

Please follow the installation procedure and then run the following:

import time
import plaid
from pprint import pprint
from plaid.api import plaid_api
from plaid.model.accounts_balance_get_request import AccountsBalanceGetRequest
from plaid.model.accounts_get_request import AccountsGetRequest
from plaid.model.accounts_get_response import AccountsGetResponse
from plaid.model.application_get_request import ApplicationGetRequest
from plaid.model.application_get_response import ApplicationGetResponse
from plaid.model.asset_report_audit_copy_create_request import AssetReportAuditCopyCreateRequest
from plaid.model.asset_report_audit_copy_create_response import AssetReportAuditCopyCreateResponse
from plaid.model.asset_report_audit_copy_get_request import AssetReportAuditCopyGetRequest
from plaid.model.asset_report_audit_copy_remove_request import AssetReportAuditCopyRemoveRequest
from plaid.model.asset_report_audit_copy_remove_response import AssetReportAuditCopyRemoveResponse
from plaid.model.asset_report_create_request import AssetReportCreateRequest
from plaid.model.asset_report_create_response import AssetReportCreateResponse
from plaid.model.asset_report_filter_request import AssetReportFilterRequest
from plaid.model.asset_report_filter_response import AssetReportFilterResponse
from plaid.model.asset_report_freddie_get_request import AssetReportFreddieGetRequest
from plaid.model.asset_report_freddie_get_response import AssetReportFreddieGetResponse
from plaid.model.asset_report_get_request import AssetReportGetRequest
from plaid.model.asset_report_get_response import AssetReportGetResponse
from plaid.model.asset_report_pdf_get_request import AssetReportPDFGetRequest
from plaid.model.asset_report_refresh_request import AssetReportRefreshRequest
from plaid.model.asset_report_refresh_response import AssetReportRefreshResponse
from plaid.model.asset_report_remove_request import AssetReportRemoveRequest
from plaid.model.asset_report_remove_response import AssetReportRemoveResponse
from plaid.model.auth_get_request import AuthGetRequest
from plaid.model.auth_get_response import AuthGetResponse
from plaid.model.bank_transfer_balance_get_request import BankTransferBalanceGetRequest
from plaid.model.bank_transfer_balance_get_response import BankTransferBalanceGetResponse
from plaid.model.bank_transfer_cancel_request import BankTransferCancelRequest
from plaid.model.bank_transfer_cancel_response import BankTransferCancelResponse
from plaid.model.bank_transfer_create_request import BankTransferCreateRequest
from plaid.model.bank_transfer_create_response import BankTransferCreateResponse
from plaid.model.bank_transfer_event_list_request import BankTransferEventListRequest
from plaid.model.bank_transfer_event_list_response import BankTransferEventListResponse
from plaid.model.bank_transfer_event_sync_request import BankTransferEventSyncRequest
from plaid.model.bank_transfer_event_sync_response import BankTransferEventSyncResponse
from plaid.model.bank_transfer_get_request import BankTransferGetRequest
from plaid.model.bank_transfer_get_response import BankTransferGetResponse
from plaid.model.bank_transfer_list_request import BankTransferListRequest
from plaid.model.bank_transfer_list_response import BankTransferListResponse
from plaid.model.bank_transfer_migrate_account_request import BankTransferMigrateAccountRequest
from plaid.model.bank_transfer_migrate_account_response import BankTransferMigrateAccountResponse
from plaid.model.bank_transfer_sweep_get_request import BankTransferSweepGetRequest
from plaid.model.bank_transfer_sweep_get_response import BankTransferSweepGetResponse
from plaid.model.bank_transfer_sweep_list_request import BankTransferSweepListRequest
from plaid.model.bank_transfer_sweep_list_response import BankTransferSweepListResponse
from plaid.model.categories_get_response import CategoriesGetResponse
from plaid.model.credit_audit_copy_token_create_request import CreditAuditCopyTokenCreateRequest
from plaid.model.credit_audit_copy_token_create_response import CreditAuditCopyTokenCreateResponse
from plaid.model.credit_audit_copy_token_remove_request import CreditAuditCopyTokenRemoveRequest
from plaid.model.credit_audit_copy_token_remove_response import CreditAuditCopyTokenRemoveResponse
from plaid.model.credit_audit_copy_token_update_request import CreditAuditCopyTokenUpdateRequest
from plaid.model.credit_audit_copy_token_update_response import CreditAuditCopyTokenUpdateResponse
from plaid.model.credit_bank_employment_get_request import CreditBankEmploymentGetRequest
from plaid.model.credit_bank_employment_get_response import CreditBankEmploymentGetResponse
from plaid.model.credit_bank_income_get_request import CreditBankIncomeGetRequest
from plaid.model.credit_bank_income_get_response import CreditBankIncomeGetResponse
from plaid.model.credit_bank_income_pdf_get_request import CreditBankIncomePDFGetRequest
from plaid.model.credit_bank_income_refresh_request import CreditBankIncomeRefreshRequest
from plaid.model.credit_bank_income_refresh_response import CreditBankIncomeRefreshResponse
from plaid.model.credit_bank_income_webhook_update_request import CreditBankIncomeWebhookUpdateRequest
from plaid.model.credit_bank_statements_uploads_get_request import CreditBankStatementsUploadsGetRequest
from plaid.model.credit_bank_statements_uploads_get_response import CreditBankStatementsUploadsGetResponse
from plaid.model.credit_employment_get_request import CreditEmploymentGetRequest
from plaid.model.credit_employment_get_response import CreditEmploymentGetResponse
from plaid.model.credit_freddie_mac_reports_get_request import CreditFreddieMacReportsGetRequest
from plaid.model.credit_freddie_mac_reports_get_response import CreditFreddieMacReportsGetResponse
from plaid.model.credit_payroll_income_get_request import CreditPayrollIncomeGetRequest
from plaid.model.credit_payroll_income_get_response import CreditPayrollIncomeGetResponse
from plaid.model.credit_payroll_income_precheck_request import CreditPayrollIncomePrecheckRequest
from plaid.model.credit_payroll_income_precheck_response import CreditPayrollIncomePrecheckResponse
from plaid.model.credit_payroll_income_refresh_request import CreditPayrollIncomeRefreshRequest
from plaid.model.credit_payroll_income_refresh_response import CreditPayrollIncomeRefreshResponse
from plaid.model.credit_payroll_income_risk_signals_get_request import CreditPayrollIncomeRiskSignalsGetRequest
from plaid.model.credit_payroll_income_risk_signals_get_response import CreditPayrollIncomeRiskSignalsGetResponse
from plaid.model.credit_relay_create_request import CreditRelayCreateRequest
from plaid.model.credit_relay_create_response import CreditRelayCreateResponse
from plaid.model.credit_relay_get_request import CreditRelayGetRequest
from plaid.model.credit_relay_refresh_request import CreditRelayRefreshRequest
from plaid.model.credit_relay_refresh_response import CreditRelayRefreshResponse
from plaid.model.credit_relay_remove_request import CreditRelayRemoveRequest
from plaid.model.credit_relay_remove_response import CreditRelayRemoveResponse
from plaid.model.credit_sessions_get_request import CreditSessionsGetRequest
from plaid.model.credit_sessions_get_response import CreditSessionsGetResponse
from plaid.model.dashboard_user_get_request import DashboardUserGetRequest
from plaid.model.dashboard_user_get_response import DashboardUserGetResponse
from plaid.model.dashboard_user_list_request import DashboardUserListRequest
from plaid.model.dashboard_user_list_response import DashboardUserListResponse
from plaid.model.deposit_switch_alt_create_request import DepositSwitchAltCreateRequest
from plaid.model.deposit_switch_alt_create_response import DepositSwitchAltCreateResponse
from plaid.model.deposit_switch_create_request import DepositSwitchCreateRequest
from plaid.model.deposit_switch_create_response import DepositSwitchCreateResponse
from plaid.model.deposit_switch_get_request import DepositSwitchGetRequest
from plaid.model.deposit_switch_get_response import DepositSwitchGetResponse
from plaid.model.deposit_switch_token_create_request import DepositSwitchTokenCreateRequest
from plaid.model.deposit_switch_token_create_response import DepositSwitchTokenCreateResponse
from plaid.model.employers_search_request import EmployersSearchRequest
from plaid.model.employers_search_response import EmployersSearchResponse
from plaid.model.employment_verification_get_request import EmploymentVerificationGetRequest
from plaid.model.employment_verification_get_response import EmploymentVerificationGetResponse
from plaid.model.fdx_notification import FDXNotification
from plaid.model.identity_get_request import IdentityGetRequest
from plaid.model.identity_get_response import IdentityGetResponse
from plaid.model.identity_match_request import IdentityMatchRequest
from plaid.model.identity_match_response import IdentityMatchResponse
from plaid.model.identity_refresh_request import IdentityRefreshRequest
from plaid.model.identity_refresh_response import IdentityRefreshResponse
from plaid.model.identity_verification_create_request import IdentityVerificationCreateRequest
from plaid.model.identity_verification_create_response import IdentityVerificationCreateResponse
from plaid.model.identity_verification_get_request import IdentityVerificationGetRequest
from plaid.model.identity_verification_get_response import IdentityVerificationGetResponse
from plaid.model.identity_verification_list_request import IdentityVerificationListRequest
from plaid.model.identity_verification_list_response import IdentityVerificationListResponse
from plaid.model.identity_verification_retry_request import IdentityVerificationRetryRequest
from plaid.model.identity_verification_retry_response import IdentityVerificationRetryResponse
from plaid.model.income_verification_create_request import IncomeVerificationCreateRequest
from plaid.model.income_verification_create_response import IncomeVerificationCreateResponse
from plaid.model.income_verification_documents_download_request import IncomeVerificationDocumentsDownloadRequest
from plaid.model.income_verification_paystubs_get_request import IncomeVerificationPaystubsGetRequest
from plaid.model.income_verification_paystubs_get_response import IncomeVerificationPaystubsGetResponse
from plaid.model.income_verification_precheck_request import IncomeVerificationPrecheckRequest
from plaid.model.income_verification_precheck_response import IncomeVerificationPrecheckResponse
from plaid.model.income_verification_taxforms_get_request import IncomeVerificationTaxformsGetRequest
from plaid.model.income_verification_taxforms_get_response import IncomeVerificationTaxformsGetResponse
from plaid.model.institutions_get_by_id_request import InstitutionsGetByIdRequest
from plaid.model.institutions_get_by_id_response import InstitutionsGetByIdResponse
from plaid.model.institutions_get_request import InstitutionsGetRequest
from plaid.model.institutions_get_response import InstitutionsGetResponse
from plaid.model.institutions_search_request import InstitutionsSearchRequest
from plaid.model.institutions_search_response import InstitutionsSearchResponse
from plaid.model.investments_auth_get_request import InvestmentsAuthGetRequest
from plaid.model.investments_auth_get_response import InvestmentsAuthGetResponse
from plaid.model.investments_holdings_get_request import InvestmentsHoldingsGetRequest
from plaid.model.investments_holdings_get_response import InvestmentsHoldingsGetResponse
from plaid.model.investments_refresh_request import InvestmentsRefreshRequest
from plaid.model.investments_refresh_response import InvestmentsRefreshResponse
from plaid.model.investments_transactions_get_request import InvestmentsTransactionsGetRequest
from plaid.model.investments_transactions_get_response import InvestmentsTransactionsGetResponse
from plaid.model.item_access_token_invalidate_request import ItemAccessTokenInvalidateRequest
from plaid.model.item_access_token_invalidate_response import ItemAccessTokenInvalidateResponse
from plaid.model.item_activity_list_request import ItemActivityListRequest
from plaid.model.item_activity_list_response import ItemActivityListResponse
from plaid.model.item_application_list_request import ItemApplicationListRequest
from plaid.model.item_application_list_response import ItemApplicationListResponse
from plaid.model.item_application_scopes_update_request import ItemApplicationScopesUpdateRequest
from plaid.model.item_application_scopes_update_response import ItemApplicationScopesUpdateResponse
from plaid.model.item_get_request import ItemGetRequest
from plaid.model.item_get_response import ItemGetResponse
from plaid.model.item_import_request import ItemImportRequest
from plaid.model.item_import_response import ItemImportResponse
from plaid.model.item_public_token_create_request import ItemPublicTokenCreateRequest
from plaid.model.item_public_token_create_response import ItemPublicTokenCreateResponse
from plaid.model.item_public_token_exchange_request import ItemPublicTokenExchangeRequest
from plaid.model.item_public_token_exchange_response import ItemPublicTokenExchangeResponse
from plaid.model.item_remove_request import ItemRemoveRequest
from plaid.model.item_remove_response import ItemRemoveResponse
from plaid.model.item_webhook_update_request import ItemWebhookUpdateRequest
from plaid.model.item_webhook_update_response import ItemWebhookUpdateResponse
from plaid.model.liabilities_get_request import LiabilitiesGetRequest
from plaid.model.liabilities_get_response import LiabilitiesGetResponse
from plaid.model.link_delivery_create_request import LinkDeliveryCreateRequest
from plaid.model.link_delivery_create_response import LinkDeliveryCreateResponse
from plaid.model.link_delivery_get_request import LinkDeliveryGetRequest
from plaid.model.link_delivery_get_response import LinkDeliveryGetResponse
from plaid.model.link_o_auth_correlation_id_exchange_request import LinkOAuthCorrelationIdExchangeRequest
from plaid.model.link_o_auth_correlation_id_exchange_response import LinkOAuthCorrelationIdExchangeResponse
from plaid.model.link_token_create_request import LinkTokenCreateRequest
from plaid.model.link_token_create_response import LinkTokenCreateResponse
from plaid.model.link_token_get_request import LinkTokenGetRequest
from plaid.model.link_token_get_response import LinkTokenGetResponse
from plaid.model.partner_customer_create_request import PartnerCustomerCreateRequest
from plaid.model.partner_customer_create_response import PartnerCustomerCreateResponse
from plaid.model.partner_customer_enable_request import PartnerCustomerEnableRequest
from plaid.model.partner_customer_enable_response import PartnerCustomerEnableResponse
from plaid.model.partner_customer_get_request import PartnerCustomerGetRequest
from plaid.model.partner_customer_get_response import PartnerCustomerGetResponse
from plaid.model.partner_customer_o_auth_institutions_get_request import PartnerCustomerOAuthInstitutionsGetRequest
from plaid.model.partner_customer_o_auth_institutions_get_response import PartnerCustomerOAuthInstitutionsGetResponse
from plaid.model.partner_customer_remove_request import PartnerCustomerRemoveRequest
from plaid.model.partner_customer_remove_response import PartnerCustomerRemoveResponse
from plaid.model.payment_initiation_consent_create_request import PaymentInitiationConsentCreateRequest
from plaid.model.payment_initiation_consent_create_response import PaymentInitiationConsentCreateResponse
from plaid.model.payment_initiation_consent_get_request import PaymentInitiationConsentGetRequest
from plaid.model.payment_initiation_consent_get_response import PaymentInitiationConsentGetResponse
from plaid.model.payment_initiation_consent_payment_execute_request import PaymentInitiationConsentPaymentExecuteRequest
from plaid.model.payment_initiation_consent_payment_execute_response import PaymentInitiationConsentPaymentExecuteResponse
from plaid.model.payment_initiation_consent_revoke_request import PaymentInitiationConsentRevokeRequest
from plaid.model.payment_initiation_consent_revoke_response import PaymentInitiationConsentRevokeResponse
from plaid.model.payment_initiation_payment_create_request import PaymentInitiationPaymentCreateRequest
from plaid.model.payment_initiation_payment_create_response import PaymentInitiationPaymentCreateResponse
from plaid.model.payment_initiation_payment_get_request import PaymentInitiationPaymentGetRequest
from plaid.model.payment_initiation_payment_get_response import PaymentInitiationPaymentGetResponse
from plaid.model.payment_initiation_payment_list_request import PaymentInitiationPaymentListRequest
from plaid.model.payment_initiation_payment_list_response import PaymentInitiationPaymentListResponse
from plaid.model.payment_initiation_payment_reverse_request import PaymentInitiationPaymentReverseRequest
from plaid.model.payment_initiation_payment_reverse_response import PaymentInitiationPaymentReverseResponse
from plaid.model.payment_initiation_payment_token_create_request import PaymentInitiationPaymentTokenCreateRequest
from plaid.model.payment_initiation_payment_token_create_response import PaymentInitiationPaymentTokenCreateResponse
from plaid.model.payment_initiation_recipient_create_request import PaymentInitiationRecipientCreateRequest
from plaid.model.payment_initiation_recipient_create_response import PaymentInitiationRecipientCreateResponse
from plaid.model.payment_initiation_recipient_get_request import PaymentInitiationRecipientGetRequest
from plaid.model.payment_initiation_recipient_get_response import PaymentInitiationRecipientGetResponse
from plaid.model.payment_initiation_recipient_list_request import PaymentInitiationRecipientListRequest
from plaid.model.payment_initiation_recipient_list_response import PaymentInitiationRecipientListResponse
from plaid.model.payment_profile_create_request import PaymentProfileCreateRequest
from plaid.model.payment_profile_create_response import PaymentProfileCreateResponse
from plaid.model.payment_profile_get_request import PaymentProfileGetRequest
from plaid.model.payment_profile_get_response import PaymentProfileGetResponse
from plaid.model.payment_profile_remove_request import PaymentProfileRemoveRequest
from plaid.model.payment_profile_remove_response import PaymentProfileRemoveResponse
from plaid.model.plaid_error import PlaidError
from plaid.model.processor_apex_processor_token_create_request import ProcessorApexProcessorTokenCreateRequest
from plaid.model.processor_auth_get_request import ProcessorAuthGetRequest
from plaid.model.processor_auth_get_response import ProcessorAuthGetResponse
from plaid.model.processor_balance_get_request import ProcessorBalanceGetRequest
from plaid.model.processor_balance_get_response import ProcessorBalanceGetResponse
from plaid.model.processor_bank_transfer_create_request import ProcessorBankTransferCreateRequest
from plaid.model.processor_bank_transfer_create_response import ProcessorBankTransferCreateResponse
from plaid.model.processor_identity_get_request import ProcessorIdentityGetRequest
from plaid.model.processor_identity_get_response import ProcessorIdentityGetResponse
from plaid.model.processor_identity_match_request import ProcessorIdentityMatchRequest
from plaid.model.processor_identity_match_response import ProcessorIdentityMatchResponse
from plaid.model.processor_signal_decision_report_request import ProcessorSignalDecisionReportRequest
from plaid.model.processor_signal_decision_report_response import ProcessorSignalDecisionReportResponse
from plaid.model.processor_signal_evaluate_request import ProcessorSignalEvaluateRequest
from plaid.model.processor_signal_evaluate_response import ProcessorSignalEvaluateResponse
from plaid.model.processor_signal_return_report_request import ProcessorSignalReturnReportRequest
from plaid.model.processor_signal_return_report_response import ProcessorSignalReturnReportResponse
from plaid.model.processor_stripe_bank_account_token_create_request import ProcessorStripeBankAccountTokenCreateRequest
from plaid.model.processor_stripe_bank_account_token_create_response import ProcessorStripeBankAccountTokenCreateResponse
from plaid.model.processor_token_create_request import ProcessorTokenCreateRequest
from plaid.model.processor_token_create_response import ProcessorTokenCreateResponse
from plaid.model.processor_token_permissions_get_request import ProcessorTokenPermissionsGetRequest
from plaid.model.processor_token_permissions_get_response import ProcessorTokenPermissionsGetResponse
from plaid.model.processor_token_permissions_set_request import ProcessorTokenPermissionsSetRequest
from plaid.model.processor_token_permissions_set_response import ProcessorTokenPermissionsSetResponse
from plaid.model.processor_token_webhook_update_request import ProcessorTokenWebhookUpdateRequest
from plaid.model.processor_token_webhook_update_response import ProcessorTokenWebhookUpdateResponse
from plaid.model.processor_transactions_get_request import ProcessorTransactionsGetRequest
from plaid.model.processor_transactions_get_response import ProcessorTransactionsGetResponse
from plaid.model.processor_transactions_recurring_get_request import ProcessorTransactionsRecurringGetRequest
from plaid.model.processor_transactions_recurring_get_response import ProcessorTransactionsRecurringGetResponse
from plaid.model.processor_transactions_refresh_request import ProcessorTransactionsRefreshRequest
from plaid.model.processor_transactions_refresh_response import ProcessorTransactionsRefreshResponse
from plaid.model.processor_transactions_sync_request import ProcessorTransactionsSyncRequest
from plaid.model.processor_transactions_sync_response import ProcessorTransactionsSyncResponse
from plaid.model.sandbox_bank_income_fire_webhook_request import SandboxBankIncomeFireWebhookRequest
from plaid.model.sandbox_bank_income_fire_webhook_response import SandboxBankIncomeFireWebhookResponse
from plaid.model.sandbox_bank_transfer_fire_webhook_request import SandboxBankTransferFireWebhookRequest
from plaid.model.sandbox_bank_transfer_fire_webhook_response import SandboxBankTransferFireWebhookResponse
from plaid.model.sandbox_bank_transfer_simulate_request import SandboxBankTransferSimulateRequest
from plaid.model.sandbox_bank_transfer_simulate_response import SandboxBankTransferSimulateResponse
from plaid.model.sandbox_income_fire_webhook_request import SandboxIncomeFireWebhookRequest
from plaid.model.sandbox_income_fire_webhook_response import SandboxIncomeFireWebhookResponse
from plaid.model.sandbox_item_fire_webhook_request import SandboxItemFireWebhookRequest
from plaid.model.sandbox_item_fire_webhook_response import SandboxItemFireWebhookResponse
from plaid.model.sandbox_item_reset_login_request import SandboxItemResetLoginRequest
from plaid.model.sandbox_item_reset_login_response import SandboxItemResetLoginResponse
from plaid.model.sandbox_item_set_verification_status_request import SandboxItemSetVerificationStatusRequest
from plaid.model.sandbox_item_set_verification_status_response import SandboxItemSetVerificationStatusResponse
from plaid.model.sandbox_oauth_select_accounts_request import SandboxOauthSelectAccountsRequest
from plaid.model.sandbox_oauth_select_accounts_response import SandboxOauthSelectAccountsResponse
from plaid.model.sandbox_payment_profile_reset_login_request import SandboxPaymentProfileResetLoginRequest
from plaid.model.sandbox_payment_profile_reset_login_response import SandboxPaymentProfileResetLoginResponse
from plaid.model.sandbox_processor_token_create_request import SandboxProcessorTokenCreateRequest
from plaid.model.sandbox_processor_token_create_response import SandboxProcessorTokenCreateResponse
from plaid.model.sandbox_public_token_create_request import SandboxPublicTokenCreateRequest
from plaid.model.sandbox_public_token_create_response import SandboxPublicTokenCreateResponse
from plaid.model.sandbox_transfer_fire_webhook_request import SandboxTransferFireWebhookRequest
from plaid.model.sandbox_transfer_fire_webhook_response import SandboxTransferFireWebhookResponse
from plaid.model.sandbox_transfer_repayment_simulate_request import SandboxTransferRepaymentSimulateRequest
from plaid.model.sandbox_transfer_repayment_simulate_response import SandboxTransferRepaymentSimulateResponse
from plaid.model.sandbox_transfer_simulate_request import SandboxTransferSimulateRequest
from plaid.model.sandbox_transfer_simulate_response import SandboxTransferSimulateResponse
from plaid.model.sandbox_transfer_sweep_simulate_request import SandboxTransferSweepSimulateRequest
from plaid.model.sandbox_transfer_sweep_simulate_response import SandboxTransferSweepSimulateResponse
from plaid.model.sandbox_transfer_test_clock_advance_request import SandboxTransferTestClockAdvanceRequest
from plaid.model.sandbox_transfer_test_clock_advance_response import SandboxTransferTestClockAdvanceResponse
from plaid.model.sandbox_transfer_test_clock_create_request import SandboxTransferTestClockCreateRequest
from plaid.model.sandbox_transfer_test_clock_create_response import SandboxTransferTestClockCreateResponse
from plaid.model.sandbox_transfer_test_clock_get_request import SandboxTransferTestClockGetRequest
from plaid.model.sandbox_transfer_test_clock_get_response import SandboxTransferTestClockGetResponse
from plaid.model.sandbox_transfer_test_clock_list_request import SandboxTransferTestClockListRequest
from plaid.model.sandbox_transfer_test_clock_list_response import SandboxTransferTestClockListResponse
from plaid.model.signal_decision_report_request import SignalDecisionReportRequest
from plaid.model.signal_decision_report_response import SignalDecisionReportResponse
from plaid.model.signal_evaluate_request import SignalEvaluateRequest
from plaid.model.signal_evaluate_response import SignalEvaluateResponse
from plaid.model.signal_prepare_request import SignalPrepareRequest
from plaid.model.signal_prepare_response import SignalPrepareResponse
from plaid.model.signal_return_report_request import SignalReturnReportRequest
from plaid.model.signal_return_report_response import SignalReturnReportResponse
from plaid.model.statements_download_request import StatementsDownloadRequest
from plaid.model.statements_list_request import StatementsListRequest
from plaid.model.statements_list_response import StatementsListResponse
from plaid.model.transactions_enhance_get_request import TransactionsEnhanceGetRequest
from plaid.model.transactions_enhance_get_response import TransactionsEnhanceGetResponse
from plaid.model.transactions_enrich_get_request import TransactionsEnrichGetRequest
from plaid.model.transactions_enrich_get_response import TransactionsEnrichGetResponse
from plaid.model.transactions_get_request import TransactionsGetRequest
from plaid.model.transactions_get_response import TransactionsGetResponse
from plaid.model.transactions_recurring_get_request import TransactionsRecurringGetRequest
from plaid.model.transactions_recurring_get_response import TransactionsRecurringGetResponse
from plaid.model.transactions_refresh_request import TransactionsRefreshRequest
from plaid.model.transactions_refresh_response import TransactionsRefreshResponse
from plaid.model.transactions_rules_create_request import TransactionsRulesCreateRequest
from plaid.model.transactions_rules_create_response import TransactionsRulesCreateResponse
from plaid.model.transactions_rules_list_request import TransactionsRulesListRequest
from plaid.model.transactions_rules_list_response import TransactionsRulesListResponse
from plaid.model.transactions_rules_remove_request import TransactionsRulesRemoveRequest
from plaid.model.transactions_rules_remove_response import TransactionsRulesRemoveResponse
from plaid.model.transactions_sync_request import TransactionsSyncRequest
from plaid.model.transactions_sync_response import TransactionsSyncResponse
from plaid.model.transfer_authorization_create_request import TransferAuthorizationCreateRequest
from plaid.model.transfer_authorization_create_response import TransferAuthorizationCreateResponse
from plaid.model.transfer_balance_get_request import TransferBalanceGetRequest
from plaid.model.transfer_balance_get_response import TransferBalanceGetResponse
from plaid.model.transfer_cancel_request import TransferCancelRequest
from plaid.model.transfer_cancel_response import TransferCancelResponse
from plaid.model.transfer_capabilities_get_request import TransferCapabilitiesGetRequest
from plaid.model.transfer_capabilities_get_response import TransferCapabilitiesGetResponse
from plaid.model.transfer_configuration_get_request import TransferConfigurationGetRequest
from plaid.model.transfer_configuration_get_response import TransferConfigurationGetResponse
from plaid.model.transfer_create_request import TransferCreateRequest
from plaid.model.transfer_create_response import TransferCreateResponse
from plaid.model.transfer_diligence_document_upload_request import TransferDiligenceDocumentUploadRequest
from plaid.model.transfer_diligence_document_upload_response import TransferDiligenceDocumentUploadResponse
from plaid.model.transfer_diligence_submit_request import TransferDiligenceSubmitRequest
from plaid.model.transfer_diligence_submit_response import TransferDiligenceSubmitResponse
from plaid.model.transfer_event_list_request import TransferEventListRequest
from plaid.model.transfer_event_list_response import TransferEventListResponse
from plaid.model.transfer_event_sync_request import TransferEventSyncRequest
from plaid.model.transfer_event_sync_response import TransferEventSyncResponse
from plaid.model.transfer_get_request import TransferGetRequest
from plaid.model.transfer_get_response import TransferGetResponse
from plaid.model.transfer_intent_create_request import TransferIntentCreateRequest
from plaid.model.transfer_intent_create_response import TransferIntentCreateResponse
from plaid.model.transfer_intent_get_request import TransferIntentGetRequest
from plaid.model.transfer_intent_get_response import TransferIntentGetResponse
from plaid.model.transfer_list_request import TransferListRequest
from plaid.model.transfer_list_response import TransferListResponse
from plaid.model.transfer_metrics_get_request import TransferMetricsGetRequest
from plaid.model.transfer_metrics_get_response import TransferMetricsGetResponse
from plaid.model.transfer_migrate_account_request import TransferMigrateAccountRequest
from plaid.model.transfer_migrate_account_response import TransferMigrateAccountResponse
from plaid.model.transfer_originator_create_request import TransferOriginatorCreateRequest
from plaid.model.transfer_originator_create_response import TransferOriginatorCreateResponse
from plaid.model.transfer_originator_get_request import TransferOriginatorGetRequest
from plaid.model.transfer_originator_get_response import TransferOriginatorGetResponse
from plaid.model.transfer_originator_list_request import TransferOriginatorListRequest
from plaid.model.transfer_originator_list_response import TransferOriginatorListResponse
from plaid.model.transfer_questionnaire_create_request import TransferQuestionnaireCreateRequest
from plaid.model.transfer_questionnaire_create_response import TransferQuestionnaireCreateResponse
from plaid.model.transfer_recurring_cancel_request import TransferRecurringCancelRequest
from plaid.model.transfer_recurring_cancel_response import TransferRecurringCancelResponse
from plaid.model.transfer_recurring_create_request import TransferRecurringCreateRequest
from plaid.model.transfer_recurring_create_response import TransferRecurringCreateResponse
from plaid.model.transfer_recurring_get_request import TransferRecurringGetRequest
from plaid.model.transfer_recurring_get_response import TransferRecurringGetResponse
from plaid.model.transfer_recurring_list_request import TransferRecurringListRequest
from plaid.model.transfer_recurring_list_response import TransferRecurringListResponse
from plaid.model.transfer_refund_cancel_request import TransferRefundCancelRequest
from plaid.model.transfer_refund_cancel_response import TransferRefundCancelResponse
from plaid.model.transfer_refund_create_request import TransferRefundCreateRequest
from plaid.model.transfer_refund_create_response import TransferRefundCreateResponse
from plaid.model.transfer_refund_get_request import TransferRefundGetRequest
from plaid.model.transfer_refund_get_response import TransferRefundGetResponse
from plaid.model.transfer_repayment_list_request import TransferRepaymentListRequest
from plaid.model.transfer_repayment_list_response import TransferRepaymentListResponse
from plaid.model.transfer_repayment_return_list_request import TransferRepaymentReturnListRequest
from plaid.model.transfer_repayment_return_list_response import TransferRepaymentReturnListResponse
from plaid.model.transfer_sweep_get_request import TransferSweepGetRequest
from plaid.model.transfer_sweep_get_response import TransferSweepGetResponse
from plaid.model.transfer_sweep_list_request import TransferSweepListRequest
from plaid.model.transfer_sweep_list_response import TransferSweepListResponse
from plaid.model.user_create_request import UserCreateRequest
from plaid.model.user_create_response import UserCreateResponse
from plaid.model.wallet_create_request import WalletCreateRequest
from plaid.model.wallet_create_response import WalletCreateResponse
from plaid.model.wallet_get_request import WalletGetRequest
from plaid.model.wallet_get_response import WalletGetResponse
from plaid.model.wallet_list_request import WalletListRequest
from plaid.model.wallet_list_response import WalletListResponse
from plaid.model.wallet_transaction_execute_request import WalletTransactionExecuteRequest
from plaid.model.wallet_transaction_execute_response import WalletTransactionExecuteResponse
from plaid.model.wallet_transaction_get_request import WalletTransactionGetRequest
from plaid.model.wallet_transaction_get_response import WalletTransactionGetResponse
from plaid.model.wallet_transaction_list_request import WalletTransactionListRequest
from plaid.model.wallet_transaction_list_response import WalletTransactionListResponse
from plaid.model.watchlist_screening_entity_create_request import WatchlistScreeningEntityCreateRequest
from plaid.model.watchlist_screening_entity_create_response import WatchlistScreeningEntityCreateResponse
from plaid.model.watchlist_screening_entity_get_request import WatchlistScreeningEntityGetRequest
from plaid.model.watchlist_screening_entity_get_response import WatchlistScreeningEntityGetResponse
from plaid.model.watchlist_screening_entity_history_list_request import WatchlistScreeningEntityHistoryListRequest
from plaid.model.watchlist_screening_entity_history_list_response import WatchlistScreeningEntityHistoryListResponse
from plaid.model.watchlist_screening_entity_hit_list_request import WatchlistScreeningEntityHitListRequest
from plaid.model.watchlist_screening_entity_hit_list_response import WatchlistScreeningEntityHitListResponse
from plaid.model.watchlist_screening_entity_list_request import WatchlistScreeningEntityListRequest
from plaid.model.watchlist_screening_entity_list_response import WatchlistScreeningEntityListResponse
from plaid.model.watchlist_screening_entity_program_get_request import WatchlistScreeningEntityProgramGetRequest
from plaid.model.watchlist_screening_entity_program_get_response import WatchlistScreeningEntityProgramGetResponse
from plaid.model.watchlist_screening_entity_program_list_request import WatchlistScreeningEntityProgramListRequest
from plaid.model.watchlist_screening_entity_program_list_response import WatchlistScreeningEntityProgramListResponse
from plaid.model.watchlist_screening_entity_review_create_request import WatchlistScreeningEntityReviewCreateRequest
from plaid.model.watchlist_screening_entity_review_create_response import WatchlistScreeningEntityReviewCreateResponse
from plaid.model.watchlist_screening_entity_review_list_request import WatchlistScreeningEntityReviewListRequest
from plaid.model.watchlist_screening_entity_review_list_response import WatchlistScreeningEntityReviewListResponse
from plaid.model.watchlist_screening_entity_update_request import WatchlistScreeningEntityUpdateRequest
from plaid.model.watchlist_screening_entity_update_response import WatchlistScreeningEntityUpdateResponse
from plaid.model.watchlist_screening_individual_create_request import WatchlistScreeningIndividualCreateRequest
from plaid.model.watchlist_screening_individual_create_response import WatchlistScreeningIndividualCreateResponse
from plaid.model.watchlist_screening_individual_get_request import WatchlistScreeningIndividualGetRequest
from plaid.model.watchlist_screening_individual_get_response import WatchlistScreeningIndividualGetResponse
from plaid.model.watchlist_screening_individual_history_list_request import WatchlistScreeningIndividualHistoryListRequest
from plaid.model.watchlist_screening_individual_history_list_response import WatchlistScreeningIndividualHistoryListResponse
from plaid.model.watchlist_screening_individual_hit_list_request import WatchlistScreeningIndividualHitListRequest
from plaid.model.watchlist_screening_individual_hit_list_response import WatchlistScreeningIndividualHitListResponse
from plaid.model.watchlist_screening_individual_list_request import WatchlistScreeningIndividualListRequest
from plaid.model.watchlist_screening_individual_list_response import WatchlistScreeningIndividualListResponse
from plaid.model.watchlist_screening_individual_program_get_request import WatchlistScreeningIndividualProgramGetRequest
from plaid.model.watchlist_screening_individual_program_get_response import WatchlistScreeningIndividualProgramGetResponse
from plaid.model.watchlist_screening_individual_program_list_request import WatchlistScreeningIndividualProgramListRequest
from plaid.model.watchlist_screening_individual_program_list_response import WatchlistScreeningIndividualProgramListResponse
from plaid.model.watchlist_screening_individual_review_create_request import WatchlistScreeningIndividualReviewCreateRequest
from plaid.model.watchlist_screening_individual_review_create_response import WatchlistScreeningIndividualReviewCreateResponse
from plaid.model.watchlist_screening_individual_review_list_request import WatchlistScreeningIndividualReviewListRequest
from plaid.model.watchlist_screening_individual_review_list_response import WatchlistScreeningIndividualReviewListResponse
from plaid.model.watchlist_screening_individual_update_request import WatchlistScreeningIndividualUpdateRequest
from plaid.model.watchlist_screening_individual_update_response import WatchlistScreeningIndividualUpdateResponse
from plaid.model.webhook_verification_key_get_request import WebhookVerificationKeyGetRequest
from plaid.model.webhook_verification_key_get_response import WebhookVerificationKeyGetResponse
# Defining the host is optional and defaults to https://production.plaid.com
# See configuration.py for a list of all supported configuration parameters.
configuration = plaid.Configuration(
    host = "https://production.plaid.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: clientId
configuration.api_key['clientId'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['clientId'] = 'Bearer'

# Configure API key authorization: plaidVersion
configuration.api_key['plaidVersion'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['plaidVersion'] = 'Bearer'

# Configure API key authorization: secret
configuration.api_key['secret'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['secret'] = 'Bearer'


# Enter a context with an instance of the API client
with plaid.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = plaid_api.PlaidApi(api_client)
    accounts_balance_get_request = AccountsBalanceGetRequest(
        access_token="access_token_example",
        secret="secret_example",
        client_id="client_id_example",
        options=AccountsBalanceGetRequestOptions(
            account_ids=[
                "account_ids_example",
            ],
            min_last_updated_datetime=dateutil_parser('1970-01-01T00:00:00.00Z'),
        ),
    ) # AccountsBalanceGetRequest | 

    try:
        # Retrieve real-time balance data
        api_response = api_instance.accounts_balance_get(accounts_balance_get_request)
        pprint(api_response)
    except plaid.ApiException as e:
        print("Exception when calling PlaidApi->accounts_balance_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://production.plaid.com

Class Method HTTP request Description
PlaidApi accounts_balance_get POST /accounts/balance/get Retrieve real-time balance data
PlaidApi accounts_get POST /accounts/get Retrieve accounts
PlaidApi application_get POST /application/get Retrieve information about a Plaid application
PlaidApi asset_report_audit_copy_create POST /asset_report/audit_copy/create Create Asset Report Audit Copy
PlaidApi asset_report_audit_copy_get POST /asset_report/audit_copy/get Retrieve an Asset Report Audit Copy
PlaidApi asset_report_audit_copy_remove POST /asset_report/audit_copy/remove Remove Asset Report Audit Copy
PlaidApi asset_report_create POST /asset_report/create Create an Asset Report
PlaidApi asset_report_filter POST /asset_report/filter Filter Asset Report
PlaidApi asset_report_get POST /asset_report/get Retrieve an Asset Report
PlaidApi asset_report_pdf_get POST /asset_report/pdf/get Retrieve a PDF Asset Report
PlaidApi asset_report_refresh POST /asset_report/refresh Refresh an Asset Report
PlaidApi asset_report_remove POST /asset_report/remove Delete an Asset Report
PlaidApi auth_get POST /auth/get Retrieve auth data
PlaidApi bank_transfer_balance_get POST /bank_transfer/balance/get Get balance of your Bank Transfer account
PlaidApi bank_transfer_cancel POST /bank_transfer/cancel Cancel a bank transfer
PlaidApi bank_transfer_create POST /bank_transfer/create Create a bank transfer
PlaidApi bank_transfer_event_list POST /bank_transfer/event/list List bank transfer events
PlaidApi bank_transfer_event_sync POST /bank_transfer/event/sync Sync bank transfer events
PlaidApi bank_transfer_get POST /bank_transfer/get Retrieve a bank transfer
PlaidApi bank_transfer_list POST /bank_transfer/list List bank transfers
PlaidApi bank_transfer_migrate_account POST /bank_transfer/migrate_account Migrate account into Bank Transfers
PlaidApi bank_transfer_sweep_get POST /bank_transfer/sweep/get Retrieve a sweep
PlaidApi bank_transfer_sweep_list POST /bank_transfer/sweep/list List sweeps
PlaidApi categories_get POST /categories/get Get categories
PlaidApi create_payment_token POST /payment_initiation/payment/token/create Create payment token
PlaidApi credit_asset_report_freddie_mac_get POST /credit/asset_report/freddie_mac/get Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
PlaidApi credit_audit_copy_token_create POST /credit/audit_copy_token/create Create Asset or Income Report Audit Copy Token
PlaidApi credit_audit_copy_token_update POST /credit/audit_copy_token/update Update an Audit Copy Token
PlaidApi credit_bank_employment_get POST /beta/credit/v1/bank_employment/get Retrieve information from the bank accounts used for employment verification
PlaidApi credit_bank_income_get POST /credit/bank_income/get Retrieve information from the bank accounts used for income verification
PlaidApi credit_bank_income_pdf_get POST /credit/bank_income/pdf/get Retrieve information from the bank accounts used for income verification in PDF format
PlaidApi credit_bank_income_refresh POST /credit/bank_income/refresh Refresh a user's bank income information
PlaidApi credit_bank_income_webhook_update POST /credit/bank_income/webhook/update Subscribe and unsubscribe to proactive notifications for a user's income profile
PlaidApi credit_bank_statements_uploads_get POST /credit/bank_statements/uploads/get Retrieve data for a user's uploaded bank statements
PlaidApi credit_employment_get POST /credit/employment/get Retrieve a summary of an individual's employment information
PlaidApi credit_freddie_mac_reports_get POST /credit/freddie_mac/reports/get Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
PlaidApi credit_payroll_income_get POST /credit/payroll_income/get Retrieve a user's payroll information
PlaidApi credit_payroll_income_precheck POST /credit/payroll_income/precheck Check income verification eligibility and optimize conversion
PlaidApi credit_payroll_income_refresh POST /credit/payroll_income/refresh Refresh a digital payroll income verification
PlaidApi credit_payroll_income_risk_signals_get POST /credit/payroll_income/risk_signals/get Retrieve fraud insights for a user's manually uploaded document(s).
PlaidApi credit_relay_create POST /credit/relay/create Create a relay token to share an Asset Report with a partner client (beta)
PlaidApi credit_relay_get POST /credit/relay/get Retrieve the reports associated with a relay token that was shared with you (beta)
PlaidApi credit_relay_refresh POST /credit/relay/refresh Refresh a report of a relay token (beta)
PlaidApi credit_relay_remove POST /credit/relay/remove Remove relay token (beta)
PlaidApi credit_report_audit_copy_remove POST /credit/audit_copy_token/remove Remove an Audit Copy token
PlaidApi credit_sessions_get POST /credit/sessions/get Retrieve Link sessions for your user
PlaidApi dashboard_user_get POST /dashboard_user/get Retrieve a dashboard user
PlaidApi dashboard_user_list POST /dashboard_user/list List dashboard users
PlaidApi deposit_switch_alt_create POST /deposit_switch/alt/create Create a deposit switch without using Plaid Exchange
PlaidApi deposit_switch_create POST /deposit_switch/create Create a deposit switch
PlaidApi deposit_switch_get POST /deposit_switch/get Retrieve a deposit switch
PlaidApi deposit_switch_token_create POST /deposit_switch/token/create Create a deposit switch token
PlaidApi employers_search POST /employers/search Search employer database
PlaidApi employment_verification_get POST /employment/verification/get (Deprecated) Retrieve a summary of an individual's employment information
PlaidApi fdx_notifications POST /fdx/notifications Webhook receiver for fdx notifications
PlaidApi identity_get POST /identity/get Retrieve identity data
PlaidApi identity_match POST /identity/match Retrieve identity match score
PlaidApi identity_refresh POST /identity/refresh Refresh identity data
PlaidApi identity_verification_create POST /identity_verification/create Create a new identity verification
PlaidApi identity_verification_get POST /identity_verification/get Retrieve Identity Verification
PlaidApi identity_verification_list POST /identity_verification/list List Identity Verifications
PlaidApi identity_verification_retry POST /identity_verification/retry Retry an Identity Verification
PlaidApi income_verification_create POST /income/verification/create (Deprecated) Create an income verification instance
PlaidApi income_verification_documents_download POST /income/verification/documents/download (Deprecated) Download the original documents used for income verification
PlaidApi income_verification_paystubs_get POST /income/verification/paystubs/get (Deprecated) Retrieve information from the paystubs used for income verification
PlaidApi income_verification_precheck POST /income/verification/precheck (Deprecated) Check digital income verification eligibility and optimize conversion
PlaidApi income_verification_taxforms_get POST /income/verification/taxforms/get (Deprecated) Retrieve information from the tax documents used for income verification
PlaidApi institutions_get POST /institutions/get Get details of all supported institutions
PlaidApi institutions_get_by_id POST /institutions/get_by_id Get details of an institution
PlaidApi institutions_search POST /institutions/search Search institutions
PlaidApi investments_auth_get POST /investments/auth/get Get data needed to authorize an investments transfer
PlaidApi investments_holdings_get POST /investments/holdings/get Get Investment holdings
PlaidApi investments_refresh POST /investments/refresh Refresh investment data
PlaidApi investments_transactions_get POST /investments/transactions/get Get investment transactions
PlaidApi item_access_token_invalidate POST /item/access_token/invalidate Invalidate access_token
PlaidApi item_activity_list POST /item/activity/list List a historical log of user consent events
PlaidApi item_application_list POST /item/application/list List a user’s connected applications
PlaidApi item_application_scopes_update POST /item/application/scopes/update Update the scopes of access for a particular application
PlaidApi item_create_public_token POST /item/public_token/create Create public token
PlaidApi item_get POST /item/get Retrieve an Item
PlaidApi item_import POST /item/import Import Item
PlaidApi item_public_token_exchange POST /item/public_token/exchange Exchange public token for an access token
PlaidApi item_remove POST /item/remove Remove an Item
PlaidApi item_webhook_update POST /item/webhook/update Update Webhook URL
PlaidApi liabilities_get POST /liabilities/get Retrieve Liabilities data
PlaidApi link_delivery_create POST /link_delivery/create Create Hosted Link session
PlaidApi link_delivery_get POST /link_delivery/get Get Hosted Link session
PlaidApi link_oauth_correlation_id_exchange POST /link/oauth/correlation_id/exchange Exchange the Link Correlation Id for a Link Token
PlaidApi link_token_create POST /link/token/create Create Link Token
PlaidApi link_token_get POST /link/token/get Get Link Token
PlaidApi partner_customer_create POST /partner/customer/create Creates a new end customer for a Plaid reseller.
PlaidApi partner_customer_enable POST /partner/customer/enable Enables a Plaid reseller's end customer in the Production environment.
PlaidApi partner_customer_get POST /partner/customer/get Returns a Plaid reseller's end customer.
PlaidApi partner_customer_oauth_institutions_get POST /partner/customer/oauth_institutions/get Returns OAuth-institution registration information for a given end customer.
PlaidApi partner_customer_remove POST /partner/customer/remove Removes a Plaid reseller's end customer.
PlaidApi payment_initiation_consent_create POST /payment_initiation/consent/create Create payment consent
PlaidApi payment_initiation_consent_get POST /payment_initiation/consent/get Get payment consent
PlaidApi payment_initiation_consent_payment_execute POST /payment_initiation/consent/payment/execute Execute a single payment using consent
PlaidApi payment_initiation_consent_revoke POST /payment_initiation/consent/revoke Revoke payment consent
PlaidApi payment_initiation_payment_create POST /payment_initiation/payment/create Create a payment
PlaidApi payment_initiation_payment_get POST /payment_initiation/payment/get Get payment details
PlaidApi payment_initiation_payment_list POST /payment_initiation/payment/list List payments
PlaidApi payment_initiation_payment_reverse POST /payment_initiation/payment/reverse Reverse an existing payment
PlaidApi payment_initiation_recipient_create POST /payment_initiation/recipient/create Create payment recipient
PlaidApi payment_initiation_recipient_get POST /payment_initiation/recipient/get Get payment recipient
PlaidApi payment_initiation_recipient_list POST /payment_initiation/recipient/list List payment recipients
PlaidApi payment_profile_create POST /payment_profile/create Create payment profile
PlaidApi payment_profile_get POST /payment_profile/get Get payment profile
PlaidApi payment_profile_remove POST /payment_profile/remove Remove payment profile
PlaidApi processor_apex_processor_token_create POST /processor/apex/processor_token/create Create Apex bank account token
PlaidApi processor_auth_get POST /processor/auth/get Retrieve Auth data
PlaidApi processor_balance_get POST /processor/balance/get Retrieve Balance data
PlaidApi processor_bank_transfer_create POST /processor/bank_transfer/create Create a bank transfer as a processor
PlaidApi processor_identity_get POST /processor/identity/get Retrieve Identity data
PlaidApi processor_identity_match POST /processor/identity/match Retrieve identity match score
PlaidApi processor_signal_decision_report POST /processor/signal/decision/report Report whether you initiated an ACH transaction
PlaidApi processor_signal_evaluate POST /processor/signal/evaluate Evaluate a planned ACH transaction
PlaidApi processor_signal_return_report POST /processor/signal/return/report Report a return for an ACH transaction
PlaidApi processor_stripe_bank_account_token_create POST /processor/stripe/bank_account_token/create Create Stripe bank account token
PlaidApi processor_token_create POST /processor/token/create Create processor token
PlaidApi processor_token_permissions_get POST /processor/token/permissions/get Get a processor token's product permissions
PlaidApi processor_token_permissions_set POST /processor/token/permissions/set Control a processor's access to products
PlaidApi processor_token_webhook_update POST /processor/token/webhook/update Update a processor token's webhook URL
PlaidApi processor_transactions_get POST /processor/transactions/get Get transaction data
PlaidApi processor_transactions_recurring_get POST /processor/transactions/recurring/get Fetch recurring transaction streams
PlaidApi processor_transactions_refresh POST /processor/transactions/refresh Refresh transaction data
PlaidApi processor_transactions_sync POST /processor/transactions/sync Get incremental transaction updates on an Item
PlaidApi sandbox_bank_income_fire_webhook POST /sandbox/bank_income/fire_webhook Manually fire a bank income webhook in sandbox
PlaidApi sandbox_bank_transfer_fire_webhook POST /sandbox/bank_transfer/fire_webhook Manually fire a Bank Transfer webhook
PlaidApi sandbox_bank_transfer_simulate POST /sandbox/bank_transfer/simulate Simulate a bank transfer event in Sandbox
PlaidApi sandbox_income_fire_webhook POST /sandbox/income/fire_webhook Manually fire an Income webhook
PlaidApi sandbox_item_fire_webhook POST /sandbox/item/fire_webhook Fire a test webhook
PlaidApi sandbox_item_reset_login POST /sandbox/item/reset_login Force a Sandbox Item into an error state
PlaidApi sandbox_item_set_verification_status POST /sandbox/item/set_verification_status Set verification status for Sandbox account
PlaidApi sandbox_oauth_select_accounts POST /sandbox/oauth/select_accounts Save the selected accounts when connecting to the Platypus Oauth institution
PlaidApi sandbox_payment_profile_reset_login POST /sandbox/payment_profile/reset_login Reset the login of a Payment Profile
PlaidApi sandbox_processor_token_create POST /sandbox/processor_token/create Create a test Item and processor token
PlaidApi sandbox_public_token_create POST /sandbox/public_token/create Create a test Item
PlaidApi sandbox_transfer_fire_webhook POST /sandbox/transfer/fire_webhook Manually fire a Transfer webhook
PlaidApi sandbox_transfer_repayment_simulate POST /sandbox/transfer/repayment/simulate Trigger the creation of a repayment
PlaidApi sandbox_transfer_simulate POST /sandbox/transfer/simulate Simulate a transfer event in Sandbox
PlaidApi sandbox_transfer_sweep_simulate POST /sandbox/transfer/sweep/simulate Simulate creating a sweep
PlaidApi sandbox_transfer_test_clock_advance POST /sandbox/transfer/test_clock/advance Advance a test clock
PlaidApi sandbox_transfer_test_clock_create POST /sandbox/transfer/test_clock/create Create a test clock
PlaidApi sandbox_transfer_test_clock_get POST /sandbox/transfer/test_clock/get Get a test clock
PlaidApi sandbox_transfer_test_clock_list POST /sandbox/transfer/test_clock/list List test clocks
PlaidApi signal_decision_report POST /signal/decision/report Report whether you initiated an ACH transaction
PlaidApi signal_evaluate POST /signal/evaluate Evaluate a planned ACH transaction
PlaidApi signal_prepare POST /signal/prepare Opt-in an Item to Signal
PlaidApi signal_return_report POST /signal/return/report Report a return for an ACH transaction
PlaidApi statements_download POST /statements/download Retrieve a single statement.
PlaidApi statements_list POST /statements/list Retrieve a list of all statements associated with the provided item.
PlaidApi transactions_enhance POST /beta/transactions/v1/enhance enhance locally-held transaction data
PlaidApi transactions_enrich POST /transactions/enrich Enrich locally-held transaction data
PlaidApi transactions_get POST /transactions/get Get transaction data
PlaidApi transactions_recurring_get POST /transactions/recurring/get Fetch recurring transaction streams
PlaidApi transactions_refresh POST /transactions/refresh Refresh transaction data
PlaidApi transactions_rules_create POST /beta/transactions/rules/v1/create Create transaction category rule
PlaidApi transactions_rules_list POST /beta/transactions/rules/v1/list Return a list of rules created for the Item associated with the access token.
PlaidApi transactions_rules_remove POST /beta/transactions/rules/v1/remove Remove transaction rule
PlaidApi transactions_sync POST /transactions/sync Get incremental transaction updates on an Item
PlaidApi transfer_authorization_create POST /transfer/authorization/create Create a transfer authorization
PlaidApi transfer_balance_get POST /transfer/balance/get Retrieve a balance held with Plaid
PlaidApi transfer_cancel POST /transfer/cancel Cancel a transfer
PlaidApi transfer_capabilities_get POST /transfer/capabilities/get Get RTP eligibility information of a transfer
PlaidApi transfer_configuration_get POST /transfer/configuration/get Get transfer product configuration
PlaidApi transfer_create POST /transfer/create Create a transfer
PlaidApi transfer_diligence_document_upload POST /transfer/diligence/document/upload This endpoint allows third-party sender customers to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
PlaidApi transfer_diligence_submit POST /transfer/diligence/submit Submit transfer diligence on behalf of the end customer (i.e. the originator).
PlaidApi transfer_event_list POST /transfer/event/list List transfer events
PlaidApi transfer_event_sync POST /transfer/event/sync Sync transfer events
PlaidApi transfer_get POST /transfer/get Retrieve a transfer
PlaidApi transfer_intent_create POST /transfer/intent/create Create a transfer intent object to invoke the Transfer UI
PlaidApi transfer_intent_get POST /transfer/intent/get Retrieve more information about a transfer intent
PlaidApi transfer_list POST /transfer/list List transfers
PlaidApi transfer_metrics_get POST /transfer/metrics/get Get transfer product usage metrics
PlaidApi transfer_migrate_account POST /transfer/migrate_account Migrate account into Transfers
PlaidApi transfer_originator_create POST /transfer/originator/create Create a new originator
PlaidApi transfer_originator_get POST /transfer/originator/get Get status of an originator's onboarding
PlaidApi transfer_originator_list POST /transfer/originator/list Get status of all originators' onboarding
PlaidApi transfer_questionnaire_create POST /transfer/questionnaire/create Generate a Plaid-hosted onboarding UI URL.
PlaidApi transfer_recurring_cancel POST /transfer/recurring/cancel Cancel a recurring transfer.
PlaidApi transfer_recurring_create POST /transfer/recurring/create Create a recurring transfer
PlaidApi transfer_recurring_get POST /transfer/recurring/get Retrieve a recurring transfer
PlaidApi transfer_recurring_list POST /transfer/recurring/list List recurring transfers
PlaidApi transfer_refund_cancel POST /transfer/refund/cancel Cancel a refund
PlaidApi transfer_refund_create POST /transfer/refund/create Create a refund
PlaidApi transfer_refund_get POST /transfer/refund/get Retrieve a refund
PlaidApi transfer_repayment_list POST /transfer/repayment/list Lists historical repayments
PlaidApi transfer_repayment_return_list POST /transfer/repayment/return/list List the returns included in a repayment
PlaidApi transfer_sweep_get POST /transfer/sweep/get Retrieve a sweep
PlaidApi transfer_sweep_list POST /transfer/sweep/list List sweeps
PlaidApi user_create POST /user/create Create user
PlaidApi wallet_create POST /wallet/create Create an e-wallet
PlaidApi wallet_get POST /wallet/get Fetch an e-wallet
PlaidApi wallet_list POST /wallet/list Fetch a list of e-wallets
PlaidApi wallet_transaction_execute POST /wallet/transaction/execute Execute a transaction using an e-wallet
PlaidApi wallet_transaction_get POST /wallet/transaction/get Fetch an e-wallet transaction
PlaidApi wallet_transaction_list POST /wallet/transaction/list List e-wallet transactions
PlaidApi watchlist_screening_entity_create POST /watchlist_screening/entity/create Create a watchlist screening for an entity
PlaidApi watchlist_screening_entity_get POST /watchlist_screening/entity/get Get an entity screening
PlaidApi watchlist_screening_entity_history_list POST /watchlist_screening/entity/history/list List history for entity watchlist screenings
PlaidApi watchlist_screening_entity_hit_list POST /watchlist_screening/entity/hit/list List hits for entity watchlist screenings
PlaidApi watchlist_screening_entity_list POST /watchlist_screening/entity/list List entity watchlist screenings
PlaidApi watchlist_screening_entity_program_get POST /watchlist_screening/entity/program/get Get entity watchlist screening program
PlaidApi watchlist_screening_entity_program_list POST /watchlist_screening/entity/program/list List entity watchlist screening programs
PlaidApi watchlist_screening_entity_review_create POST /watchlist_screening/entity/review/create Create a review for an entity watchlist screening
PlaidApi watchlist_screening_entity_review_list POST /watchlist_screening/entity/review/list List reviews for entity watchlist screenings
PlaidApi watchlist_screening_entity_update POST /watchlist_screening/entity/update Update an entity screening
PlaidApi watchlist_screening_individual_create POST /watchlist_screening/individual/create Create a watchlist screening for a person
PlaidApi watchlist_screening_individual_get POST /watchlist_screening/individual/get Retrieve an individual watchlist screening
PlaidApi watchlist_screening_individual_history_list POST /watchlist_screening/individual/history/list List history for individual watchlist screenings
PlaidApi watchlist_screening_individual_hit_list POST /watchlist_screening/individual/hit/list List hits for individual watchlist screening
PlaidApi watchlist_screening_individual_list POST /watchlist_screening/individual/list List Individual Watchlist Screenings
PlaidApi watchlist_screening_individual_program_get POST /watchlist_screening/individual/program/get Get individual watchlist screening program
PlaidApi watchlist_screening_individual_program_list POST /watchlist_screening/individual/program/list List individual watchlist screening programs
PlaidApi watchlist_screening_individual_review_create POST /watchlist_screening/individual/review/create Create a review for an individual watchlist screening
PlaidApi watchlist_screening_individual_review_list POST /watchlist_screening/individual/review/list List reviews for individual watchlist screenings
PlaidApi watchlist_screening_individual_update POST /watchlist_screening/individual/update Update individual watchlist screening
PlaidApi webhook_verification_key_get POST /webhook_verification_key/get Get webhook verification key

Documentation For Models

Documentation For Authorization

clientId

  • Type: API key
  • API key parameter name: PLAID-CLIENT-ID
  • Location: HTTP header

plaidVersion

  • Type: API key
  • API key parameter name: Plaid-Version
  • Location: HTTP header

secret

  • Type: API key
  • API key parameter name: PLAID-SECRET
  • Location: HTTP header

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in plaid.apis and plaid.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from plaid.api.default_api import DefaultApi
  • from plaid.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import plaid
from plaid.apis import *
from plaid.models import *

About

No description, website, or topics provided.

Resources

Readme

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

6 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages