Skip to content
BranchesTags

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:

importplaid

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:

importplaid

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportplaidfrompprintimportpprintfromplaid.apiimportplaid_apifromplaid.model.accounts_balance_get_requestimportAccountsBalanceGetRequestfromplaid.model.accounts_get_requestimportAccountsGetRequestfromplaid.model.accounts_get_responseimportAccountsGetResponsefromplaid.model.application_get_requestimportApplicationGetRequestfromplaid.model.application_get_responseimportApplicationGetResponsefromplaid.model.asset_report_audit_copy_create_requestimportAssetReportAuditCopyCreateRequestfromplaid.model.asset_report_audit_copy_create_responseimportAssetReportAuditCopyCreateResponsefromplaid.model.asset_report_audit_copy_get_requestimportAssetReportAuditCopyGetRequestfromplaid.model.asset_report_audit_copy_remove_requestimportAssetReportAuditCopyRemoveRequestfromplaid.model.asset_report_audit_copy_remove_responseimportAssetReportAuditCopyRemoveResponsefromplaid.model.asset_report_create_requestimportAssetReportCreateRequestfromplaid.model.asset_report_create_responseimportAssetReportCreateResponsefromplaid.model.asset_report_filter_requestimportAssetReportFilterRequestfromplaid.model.asset_report_filter_responseimportAssetReportFilterResponsefromplaid.model.asset_report_freddie_get_requestimportAssetReportFreddieGetRequestfromplaid.model.asset_report_freddie_get_responseimportAssetReportFreddieGetResponsefromplaid.model.asset_report_get_requestimportAssetReportGetRequestfromplaid.model.asset_report_get_responseimportAssetReportGetResponsefromplaid.model.asset_report_pdf_get_requestimportAssetReportPDFGetRequestfromplaid.model.asset_report_refresh_requestimportAssetReportRefreshRequestfromplaid.model.asset_report_refresh_responseimportAssetReportRefreshResponsefromplaid.model.asset_report_remove_requestimportAssetReportRemoveRequestfromplaid.model.asset_report_remove_responseimportAssetReportRemoveResponsefromplaid.model.auth_get_requestimportAuthGetRequestfromplaid.model.auth_get_responseimportAuthGetResponsefromplaid.model.bank_transfer_balance_get_requestimportBankTransferBalanceGetRequestfromplaid.model.bank_transfer_balance_get_responseimportBankTransferBalanceGetResponsefromplaid.model.bank_transfer_cancel_requestimportBankTransferCancelRequestfromplaid.model.bank_transfer_cancel_responseimportBankTransferCancelResponsefromplaid.model.bank_transfer_create_requestimportBankTransferCreateRequestfromplaid.model.bank_transfer_create_responseimportBankTransferCreateResponsefromplaid.model.bank_transfer_event_list_requestimportBankTransferEventListRequestfromplaid.model.bank_transfer_event_list_responseimportBankTransferEventListResponsefromplaid.model.bank_transfer_event_sync_requestimportBankTransferEventSyncRequestfromplaid.model.bank_transfer_event_sync_responseimportBankTransferEventSyncResponsefromplaid.model.bank_transfer_get_requestimportBankTransferGetRequestfromplaid.model.bank_transfer_get_responseimportBankTransferGetResponsefromplaid.model.bank_transfer_list_requestimportBankTransferListRequestfromplaid.model.bank_transfer_list_responseimportBankTransferListResponsefromplaid.model.bank_transfer_migrate_account_requestimportBankTransferMigrateAccountRequestfromplaid.model.bank_transfer_migrate_account_responseimportBankTransferMigrateAccountResponsefromplaid.model.bank_transfer_sweep_get_requestimportBankTransferSweepGetRequestfromplaid.model.bank_transfer_sweep_get_responseimportBankTransferSweepGetResponsefromplaid.model.bank_transfer_sweep_list_requestimportBankTransferSweepListRequestfromplaid.model.bank_transfer_sweep_list_responseimportBankTransferSweepListResponsefromplaid.model.categories_get_responseimportCategoriesGetResponsefromplaid.model.credit_audit_copy_token_create_requestimportCreditAuditCopyTokenCreateRequestfromplaid.model.credit_audit_copy_token_create_responseimportCreditAuditCopyTokenCreateResponsefromplaid.model.credit_audit_copy_token_remove_requestimportCreditAuditCopyTokenRemoveRequestfromplaid.model.credit_audit_copy_token_remove_responseimportCreditAuditCopyTokenRemoveResponsefromplaid.model.credit_audit_copy_token_update_requestimportCreditAuditCopyTokenUpdateRequestfromplaid.model.credit_audit_copy_token_update_responseimportCreditAuditCopyTokenUpdateResponsefromplaid.model.credit_bank_employment_get_requestimportCreditBankEmploymentGetRequestfromplaid.model.credit_bank_employment_get_responseimportCreditBankEmploymentGetResponsefromplaid.model.credit_bank_income_get_requestimportCreditBankIncomeGetRequestfromplaid.model.credit_bank_income_get_responseimportCreditBankIncomeGetResponsefromplaid.model.credit_bank_income_pdf_get_requestimportCreditBankIncomePDFGetRequestfromplaid.model.credit_bank_income_refresh_requestimportCreditBankIncomeRefreshRequestfromplaid.model.credit_bank_income_refresh_responseimportCreditBankIncomeRefreshResponsefromplaid.model.credit_bank_income_webhook_update_requestimportCreditBankIncomeWebhookUpdateRequestfromplaid.model.credit_bank_statements_uploads_get_requestimportCreditBankStatementsUploadsGetRequestfromplaid.model.credit_bank_statements_uploads_get_responseimportCreditBankStatementsUploadsGetResponsefromplaid.model.credit_employment_get_requestimportCreditEmploymentGetRequestfromplaid.model.credit_employment_get_responseimportCreditEmploymentGetResponsefromplaid.model.credit_freddie_mac_reports_get_requestimportCreditFreddieMacReportsGetRequestfromplaid.model.credit_freddie_mac_reports_get_responseimportCreditFreddieMacReportsGetResponsefromplaid.model.credit_payroll_income_get_requestimportCreditPayrollIncomeGetRequestfromplaid.model.credit_payroll_income_get_responseimportCreditPayrollIncomeGetResponsefromplaid.model.credit_payroll_income_precheck_requestimportCreditPayrollIncomePrecheckRequestfromplaid.model.credit_payroll_income_precheck_responseimportCreditPayrollIncomePrecheckResponsefromplaid.model.credit_payroll_income_refresh_requestimportCreditPayrollIncomeRefreshRequestfromplaid.model.credit_payroll_income_refresh_responseimportCreditPayrollIncomeRefreshResponsefromplaid.model.credit_payroll_income_risk_signals_get_requestimportCreditPayrollIncomeRiskSignalsGetRequestfromplaid.model.credit_payroll_income_risk_signals_get_responseimportCreditPayrollIncomeRiskSignalsGetResponsefromplaid.model.credit_relay_create_requestimportCreditRelayCreateRequestfromplaid.model.credit_relay_create_responseimportCreditRelayCreateResponsefromplaid.model.credit_relay_get_requestimportCreditRelayGetRequestfromplaid.model.credit_relay_refresh_requestimportCreditRelayRefreshRequestfromplaid.model.credit_relay_refresh_responseimportCreditRelayRefreshResponsefromplaid.model.credit_relay_remove_requestimportCreditRelayRemoveRequestfromplaid.model.credit_relay_remove_responseimportCreditRelayRemoveResponsefromplaid.model.credit_sessions_get_requestimportCreditSessionsGetRequestfromplaid.model.credit_sessions_get_responseimportCreditSessionsGetResponsefromplaid.model.dashboard_user_get_requestimportDashboardUserGetRequestfromplaid.model.dashboard_user_get_responseimportDashboardUserGetResponsefromplaid.model.dashboard_user_list_requestimportDashboardUserListRequestfromplaid.model.dashboard_user_list_responseimportDashboardUserListResponsefromplaid.model.deposit_switch_alt_create_requestimportDepositSwitchAltCreateRequestfromplaid.model.deposit_switch_alt_create_responseimportDepositSwitchAltCreateResponsefromplaid.model.deposit_switch_create_requestimportDepositSwitchCreateRequestfromplaid.model.deposit_switch_create_responseimportDepositSwitchCreateResponsefromplaid.model.deposit_switch_get_requestimportDepositSwitchGetRequestfromplaid.model.deposit_switch_get_responseimportDepositSwitchGetResponsefromplaid.model.deposit_switch_token_create_requestimportDepositSwitchTokenCreateRequestfromplaid.model.deposit_switch_token_create_responseimportDepositSwitchTokenCreateResponsefromplaid.model.employers_search_requestimportEmployersSearchRequestfromplaid.model.employers_search_responseimportEmployersSearchResponsefromplaid.model.employment_verification_get_requestimportEmploymentVerificationGetRequestfromplaid.model.employment_verification_get_responseimportEmploymentVerificationGetResponsefromplaid.model.fdx_notificationimportFDXNotificationfromplaid.model.identity_get_requestimportIdentityGetRequestfromplaid.model.identity_get_responseimportIdentityGetResponsefromplaid.model.identity_match_requestimportIdentityMatchRequestfromplaid.model.identity_match_responseimportIdentityMatchResponsefromplaid.model.identity_refresh_requestimportIdentityRefreshRequestfromplaid.model.identity_refresh_responseimportIdentityRefreshResponsefromplaid.model.identity_verification_create_requestimportIdentityVerificationCreateRequestfromplaid.model.identity_verification_create_responseimportIdentityVerificationCreateResponsefromplaid.model.identity_verification_get_requestimportIdentityVerificationGetRequestfromplaid.model.identity_verification_get_responseimportIdentityVerificationGetResponsefromplaid.model.identity_verification_list_requestimportIdentityVerificationListRequestfromplaid.model.identity_verification_list_responseimportIdentityVerificationListResponsefromplaid.model.identity_verification_retry_requestimportIdentityVerificationRetryRequestfromplaid.model.identity_verification_retry_responseimportIdentityVerificationRetryResponsefromplaid.model.income_verification_create_requestimportIncomeVerificationCreateRequestfromplaid.model.income_verification_create_responseimportIncomeVerificationCreateResponsefromplaid.model.income_verification_documents_download_requestimportIncomeVerificationDocumentsDownloadRequestfromplaid.model.income_verification_paystubs_get_requestimportIncomeVerificationPaystubsGetRequestfromplaid.model.income_verification_paystubs_get_responseimportIncomeVerificationPaystubsGetResponsefromplaid.model.income_verification_precheck_requestimportIncomeVerificationPrecheckRequestfromplaid.model.income_verification_precheck_responseimportIncomeVerificationPrecheckResponsefromplaid.model.income_verification_taxforms_get_requestimportIncomeVerificationTaxformsGetRequestfromplaid.model.income_verification_taxforms_get_responseimportIncomeVerificationTaxformsGetResponsefromplaid.model.institutions_get_by_id_requestimportInstitutionsGetByIdRequestfromplaid.model.institutions_get_by_id_responseimportInstitutionsGetByIdResponsefromplaid.model.institutions_get_requestimportInstitutionsGetRequestfromplaid.model.institutions_get_responseimportInstitutionsGetResponsefromplaid.model.institutions_search_requestimportInstitutionsSearchRequestfromplaid.model.institutions_search_responseimportInstitutionsSearchResponsefromplaid.model.investments_auth_get_requestimportInvestmentsAuthGetRequestfromplaid.model.investments_auth_get_responseimportInvestmentsAuthGetResponsefromplaid.model.investments_holdings_get_requestimportInvestmentsHoldingsGetRequestfromplaid.model.investments_holdings_get_responseimportInvestmentsHoldingsGetResponsefromplaid.model.investments_refresh_requestimportInvestmentsRefreshRequestfromplaid.model.investments_refresh_responseimportInvestmentsRefreshResponsefromplaid.model.investments_transactions_get_requestimportInvestmentsTransactionsGetRequestfromplaid.model.investments_transactions_get_responseimportInvestmentsTransactionsGetResponsefromplaid.model.item_access_token_invalidate_requestimportItemAccessTokenInvalidateRequestfromplaid.model.item_access_token_invalidate_responseimportItemAccessTokenInvalidateResponsefromplaid.model.item_activity_list_requestimportItemActivityListRequestfromplaid.model.item_activity_list_responseimportItemActivityListResponsefromplaid.model.item_application_list_requestimportItemApplicationListRequestfromplaid.model.item_application_list_responseimportItemApplicationListResponsefromplaid.model.item_application_scopes_update_requestimportItemApplicationScopesUpdateRequestfromplaid.model.item_application_scopes_update_responseimportItemApplicationScopesUpdateResponsefromplaid.model.item_get_requestimportItemGetRequestfromplaid.model.item_get_responseimportItemGetResponsefromplaid.model.item_import_requestimportItemImportRequestfromplaid.model.item_import_responseimportItemImportResponsefromplaid.model.item_public_token_create_requestimportItemPublicTokenCreateRequestfromplaid.model.item_public_token_create_responseimportItemPublicTokenCreateResponsefromplaid.model.item_public_token_exchange_requestimportItemPublicTokenExchangeRequestfromplaid.model.item_public_token_exchange_responseimportItemPublicTokenExchangeResponsefromplaid.model.item_remove_requestimportItemRemoveRequestfromplaid.model.item_remove_responseimportItemRemoveResponsefromplaid.model.item_webhook_update_requestimportItemWebhookUpdateRequestfromplaid.model.item_webhook_update_responseimportItemWebhookUpdateResponsefromplaid.model.liabilities_get_requestimportLiabilitiesGetRequestfromplaid.model.liabilities_get_responseimportLiabilitiesGetResponsefromplaid.model.link_delivery_create_requestimportLinkDeliveryCreateRequestfromplaid.model.link_delivery_create_responseimportLinkDeliveryCreateResponsefromplaid.model.link_delivery_get_requestimportLinkDeliveryGetRequestfromplaid.model.link_delivery_get_responseimportLinkDeliveryGetResponsefromplaid.model.link_o_auth_correlation_id_exchange_requestimportLinkOAuthCorrelationIdExchangeRequestfromplaid.model.link_o_auth_correlation_id_exchange_responseimportLinkOAuthCorrelationIdExchangeResponsefromplaid.model.link_token_create_requestimportLinkTokenCreateRequestfromplaid.model.link_token_create_responseimportLinkTokenCreateResponsefromplaid.model.link_token_get_requestimportLinkTokenGetRequestfromplaid.model.link_token_get_responseimportLinkTokenGetResponsefromplaid.model.partner_customer_create_requestimportPartnerCustomerCreateRequestfromplaid.model.partner_customer_create_responseimportPartnerCustomerCreateResponsefromplaid.model.partner_customer_enable_requestimportPartnerCustomerEnableRequestfromplaid.model.partner_customer_enable_responseimportPartnerCustomerEnableResponsefromplaid.model.partner_customer_get_requestimportPartnerCustomerGetRequestfromplaid.model.partner_customer_get_responseimportPartnerCustomerGetResponsefromplaid.model.partner_customer_o_auth_institutions_get_requestimportPartnerCustomerOAuthInstitutionsGetRequestfromplaid.model.partner_customer_o_auth_institutions_get_responseimportPartnerCustomerOAuthInstitutionsGetResponsefromplaid.model.partner_customer_remove_requestimportPartnerCustomerRemoveRequestfromplaid.model.partner_customer_remove_responseimportPartnerCustomerRemoveResponsefromplaid.model.payment_initiation_consent_create_requestimportPaymentInitiationConsentCreateRequestfromplaid.model.payment_initiation_consent_create_responseimportPaymentInitiationConsentCreateResponsefromplaid.model.payment_initiation_consent_get_requestimportPaymentInitiationConsentGetRequestfromplaid.model.payment_initiation_consent_get_responseimportPaymentInitiationConsentGetResponsefromplaid.model.payment_initiation_consent_payment_execute_requestimportPaymentInitiationConsentPaymentExecuteRequestfromplaid.model.payment_initiation_consent_payment_execute_responseimportPaymentInitiationConsentPaymentExecuteResponsefromplaid.model.payment_initiation_consent_revoke_requestimportPaymentInitiationConsentRevokeRequestfromplaid.model.payment_initiation_consent_revoke_responseimportPaymentInitiationConsentRevokeResponsefromplaid.model.payment_initiation_payment_create_requestimportPaymentInitiationPaymentCreateRequestfromplaid.model.payment_initiation_payment_create_responseimportPaymentInitiationPaymentCreateResponsefromplaid.model.payment_initiation_payment_get_requestimportPaymentInitiationPaymentGetRequestfromplaid.model.payment_initiation_payment_get_responseimportPaymentInitiationPaymentGetResponsefromplaid.model.payment_initiation_payment_list_requestimportPaymentInitiationPaymentListRequestfromplaid.model.payment_initiation_payment_list_responseimportPaymentInitiationPaymentListResponsefromplaid.model.payment_initiation_payment_reverse_requestimportPaymentInitiationPaymentReverseRequestfromplaid.model.payment_initiation_payment_reverse_responseimportPaymentInitiationPaymentReverseResponsefromplaid.model.payment_initiation_payment_token_create_requestimportPaymentInitiationPaymentTokenCreateRequestfromplaid.model.payment_initiation_payment_token_create_responseimportPaymentInitiationPaymentTokenCreateResponsefromplaid.model.payment_initiation_recipient_create_requestimportPaymentInitiationRecipientCreateRequestfromplaid.model.payment_initiation_recipient_create_responseimportPaymentInitiationRecipientCreateResponsefromplaid.model.payment_initiation_recipient_get_requestimportPaymentInitiationRecipientGetRequestfromplaid.model.payment_initiation_recipient_get_responseimportPaymentInitiationRecipientGetResponsefromplaid.model.payment_initiation_recipient_list_requestimportPaymentInitiationRecipientListRequestfromplaid.model.payment_initiation_recipient_list_responseimportPaymentInitiationRecipientListResponsefromplaid.model.payment_profile_create_requestimportPaymentProfileCreateRequestfromplaid.model.payment_profile_create_responseimportPaymentProfileCreateResponsefromplaid.model.payment_profile_get_requestimportPaymentProfileGetRequestfromplaid.model.payment_profile_get_responseimportPaymentProfileGetResponsefromplaid.model.payment_profile_remove_requestimportPaymentProfileRemoveRequestfromplaid.model.payment_profile_remove_responseimportPaymentProfileRemoveResponsefromplaid.model.plaid_errorimportPlaidErrorfromplaid.model.processor_apex_processor_token_create_requestimportProcessorApexProcessorTokenCreateRequestfromplaid.model.processor_auth_get_requestimportProcessorAuthGetRequestfromplaid.model.processor_auth_get_responseimportProcessorAuthGetResponsefromplaid.model.processor_balance_get_requestimportProcessorBalanceGetRequestfromplaid.model.processor_balance_get_responseimportProcessorBalanceGetResponsefromplaid.model.processor_bank_transfer_create_requestimportProcessorBankTransferCreateRequestfromplaid.model.processor_bank_transfer_create_responseimportProcessorBankTransferCreateResponsefromplaid.model.processor_identity_get_requestimportProcessorIdentityGetRequestfromplaid.model.processor_identity_get_responseimportProcessorIdentityGetResponsefromplaid.model.processor_identity_match_requestimportProcessorIdentityMatchRequestfromplaid.model.processor_identity_match_responseimportProcessorIdentityMatchResponsefromplaid.model.processor_signal_decision_report_requestimportProcessorSignalDecisionReportRequestfromplaid.model.processor_signal_decision_report_responseimportProcessorSignalDecisionReportResponsefromplaid.model.processor_signal_evaluate_requestimportProcessorSignalEvaluateRequestfromplaid.model.processor_signal_evaluate_responseimportProcessorSignalEvaluateResponsefromplaid.model.processor_signal_return_report_requestimportProcessorSignalReturnReportRequestfromplaid.model.processor_signal_return_report_responseimportProcessorSignalReturnReportResponsefromplaid.model.processor_stripe_bank_account_token_create_requestimportProcessorStripeBankAccountTokenCreateRequestfromplaid.model.processor_stripe_bank_account_token_create_responseimportProcessorStripeBankAccountTokenCreateResponsefromplaid.model.processor_token_create_requestimportProcessorTokenCreateRequestfromplaid.model.processor_token_create_responseimportProcessorTokenCreateResponsefromplaid.model.processor_token_permissions_get_requestimportProcessorTokenPermissionsGetRequestfromplaid.model.processor_token_permissions_get_responseimportProcessorTokenPermissionsGetResponsefromplaid.model.processor_token_permissions_set_requestimportProcessorTokenPermissionsSetRequestfromplaid.model.processor_token_permissions_set_responseimportProcessorTokenPermissionsSetResponsefromplaid.model.processor_token_webhook_update_requestimportProcessorTokenWebhookUpdateRequestfromplaid.model.processor_token_webhook_update_responseimportProcessorTokenWebhookUpdateResponsefromplaid.model.processor_transactions_get_requestimportProcessorTransactionsGetRequestfromplaid.model.processor_transactions_get_responseimportProcessorTransactionsGetResponsefromplaid.model.processor_transactions_recurring_get_requestimportProcessorTransactionsRecurringGetRequestfromplaid.model.processor_transactions_recurring_get_responseimportProcessorTransactionsRecurringGetResponsefromplaid.model.processor_transactions_refresh_requestimportProcessorTransactionsRefreshRequestfromplaid.model.processor_transactions_refresh_responseimportProcessorTransactionsRefreshResponsefromplaid.model.processor_transactions_sync_requestimportProcessorTransactionsSyncRequestfromplaid.model.processor_transactions_sync_responseimportProcessorTransactionsSyncResponsefromplaid.model.sandbox_bank_income_fire_webhook_requestimportSandboxBankIncomeFireWebhookRequestfromplaid.model.sandbox_bank_income_fire_webhook_responseimportSandboxBankIncomeFireWebhookResponsefromplaid.model.sandbox_bank_transfer_fire_webhook_requestimportSandboxBankTransferFireWebhookRequestfromplaid.model.sandbox_bank_transfer_fire_webhook_responseimportSandboxBankTransferFireWebhookResponsefromplaid.model.sandbox_bank_transfer_simulate_requestimportSandboxBankTransferSimulateRequestfromplaid.model.sandbox_bank_transfer_simulate_responseimportSandboxBankTransferSimulateResponsefromplaid.model.sandbox_income_fire_webhook_requestimportSandboxIncomeFireWebhookRequestfromplaid.model.sandbox_income_fire_webhook_responseimportSandboxIncomeFireWebhookResponsefromplaid.model.sandbox_item_fire_webhook_requestimportSandboxItemFireWebhookRequestfromplaid.model.sandbox_item_fire_webhook_responseimportSandboxItemFireWebhookResponsefromplaid.model.sandbox_item_reset_login_requestimportSandboxItemResetLoginRequestfromplaid.model.sandbox_item_reset_login_responseimportSandboxItemResetLoginResponsefromplaid.model.sandbox_item_set_verification_status_requestimportSandboxItemSetVerificationStatusRequestfromplaid.model.sandbox_item_set_verification_status_responseimportSandboxItemSetVerificationStatusResponsefromplaid.model.sandbox_oauth_select_accounts_requestimportSandboxOauthSelectAccountsRequestfromplaid.model.sandbox_oauth_select_accounts_responseimportSandboxOauthSelectAccountsResponsefromplaid.model.sandbox_payment_profile_reset_login_requestimportSandboxPaymentProfileResetLoginRequestfromplaid.model.sandbox_payment_profile_reset_login_responseimportSandboxPaymentProfileResetLoginResponsefromplaid.model.sandbox_processor_token_create_requestimportSandboxProcessorTokenCreateRequestfromplaid.model.sandbox_processor_token_create_responseimportSandboxProcessorTokenCreateResponsefromplaid.model.sandbox_public_token_create_requestimportSandboxPublicTokenCreateRequestfromplaid.model.sandbox_public_token_create_responseimportSandboxPublicTokenCreateResponsefromplaid.model.sandbox_transfer_fire_webhook_requestimportSandboxTransferFireWebhookRequestfromplaid.model.sandbox_transfer_fire_webhook_responseimportSandboxTransferFireWebhookResponsefromplaid.model.sandbox_transfer_repayment_simulate_requestimportSandboxTransferRepaymentSimulateRequestfromplaid.model.sandbox_transfer_repayment_simulate_responseimportSandboxTransferRepaymentSimulateResponsefromplaid.model.sandbox_transfer_simulate_requestimportSandboxTransferSimulateRequestfromplaid.model.sandbox_transfer_simulate_responseimportSandboxTransferSimulateResponsefromplaid.model.sandbox_transfer_sweep_simulate_requestimportSandboxTransferSweepSimulateRequestfromplaid.model.sandbox_transfer_sweep_simulate_responseimportSandboxTransferSweepSimulateResponsefromplaid.model.sandbox_transfer_test_clock_advance_requestimportSandboxTransferTestClockAdvanceRequestfromplaid.model.sandbox_transfer_test_clock_advance_responseimportSandboxTransferTestClockAdvanceResponsefromplaid.model.sandbox_transfer_test_clock_create_requestimportSandboxTransferTestClockCreateRequestfromplaid.model.sandbox_transfer_test_clock_create_responseimportSandboxTransferTestClockCreateResponsefromplaid.model.sandbox_transfer_test_clock_get_requestimportSandboxTransferTestClockGetRequestfromplaid.model.sandbox_transfer_test_clock_get_responseimportSandboxTransferTestClockGetResponsefromplaid.model.sandbox_transfer_test_clock_list_requestimportSandboxTransferTestClockListRequestfromplaid.model.sandbox_transfer_test_clock_list_responseimportSandboxTransferTestClockListResponsefromplaid.model.signal_decision_report_requestimportSignalDecisionReportRequestfromplaid.model.signal_decision_report_responseimportSignalDecisionReportResponsefromplaid.model.signal_evaluate_requestimportSignalEvaluateRequestfromplaid.model.signal_evaluate_responseimportSignalEvaluateResponsefromplaid.model.signal_prepare_requestimportSignalPrepareRequestfromplaid.model.signal_prepare_responseimportSignalPrepareResponsefromplaid.model.signal_return_report_requestimportSignalReturnReportRequestfromplaid.model.signal_return_report_responseimportSignalReturnReportResponsefromplaid.model.statements_download_requestimportStatementsDownloadRequestfromplaid.model.statements_list_requestimportStatementsListRequestfromplaid.model.statements_list_responseimportStatementsListResponsefromplaid.model.transactions_enhance_get_requestimportTransactionsEnhanceGetRequestfromplaid.model.transactions_enhance_get_responseimportTransactionsEnhanceGetResponsefromplaid.model.transactions_enrich_get_requestimportTransactionsEnrichGetRequestfromplaid.model.transactions_enrich_get_responseimportTransactionsEnrichGetResponsefromplaid.model.transactions_get_requestimportTransactionsGetRequestfromplaid.model.transactions_get_responseimportTransactionsGetResponsefromplaid.model.transactions_recurring_get_requestimportTransactionsRecurringGetRequestfromplaid.model.transactions_recurring_get_responseimportTransactionsRecurringGetResponsefromplaid.model.transactions_refresh_requestimportTransactionsRefreshRequestfromplaid.model.transactions_refresh_responseimportTransactionsRefreshResponsefromplaid.model.transactions_rules_create_requestimportTransactionsRulesCreateRequestfromplaid.model.transactions_rules_create_responseimportTransactionsRulesCreateResponsefromplaid.model.transactions_rules_list_requestimportTransactionsRulesListRequestfromplaid.model.transactions_rules_list_responseimportTransactionsRulesListResponsefromplaid.model.transactions_rules_remove_requestimportTransactionsRulesRemoveRequestfromplaid.model.transactions_rules_remove_responseimportTransactionsRulesRemoveResponsefromplaid.model.transactions_sync_requestimportTransactionsSyncRequestfromplaid.model.transactions_sync_responseimportTransactionsSyncResponsefromplaid.model.transfer_authorization_create_requestimportTransferAuthorizationCreateRequestfromplaid.model.transfer_authorization_create_responseimportTransferAuthorizationCreateResponsefromplaid.model.transfer_balance_get_requestimportTransferBalanceGetRequestfromplaid.model.transfer_balance_get_responseimportTransferBalanceGetResponsefromplaid.model.transfer_cancel_requestimportTransferCancelRequestfromplaid.model.transfer_cancel_responseimportTransferCancelResponsefromplaid.model.transfer_capabilities_get_requestimportTransferCapabilitiesGetRequestfromplaid.model.transfer_capabilities_get_responseimportTransferCapabilitiesGetResponsefromplaid.model.transfer_configuration_get_requestimportTransferConfigurationGetRequestfromplaid.model.transfer_configuration_get_responseimportTransferConfigurationGetResponsefromplaid.model.transfer_create_requestimportTransferCreateRequestfromplaid.model.transfer_create_responseimportTransferCreateResponsefromplaid.model.transfer_diligence_document_upload_requestimportTransferDiligenceDocumentUploadRequestfromplaid.model.transfer_diligence_document_upload_responseimportTransferDiligenceDocumentUploadResponsefromplaid.model.transfer_diligence_submit_requestimportTransferDiligenceSubmitRequestfromplaid.model.transfer_diligence_submit_responseimportTransferDiligenceSubmitResponsefromplaid.model.transfer_event_list_requestimportTransferEventListRequestfromplaid.model.transfer_event_list_responseimportTransferEventListResponsefromplaid.model.transfer_event_sync_requestimportTransferEventSyncRequestfromplaid.model.transfer_event_sync_responseimportTransferEventSyncResponsefromplaid.model.transfer_get_requestimportTransferGetRequestfromplaid.model.transfer_get_responseimportTransferGetResponsefromplaid.model.transfer_intent_create_requestimportTransferIntentCreateRequestfromplaid.model.transfer_intent_create_responseimportTransferIntentCreateResponsefromplaid.model.transfer_intent_get_requestimportTransferIntentGetRequestfromplaid.model.transfer_intent_get_responseimportTransferIntentGetResponsefromplaid.model.transfer_list_requestimportTransferListRequestfromplaid.model.transfer_list_responseimportTransferListResponsefromplaid.model.transfer_metrics_get_requestimportTransferMetricsGetRequestfromplaid.model.transfer_metrics_get_responseimportTransferMetricsGetResponsefromplaid.model.transfer_migrate_account_requestimportTransferMigrateAccountRequestfromplaid.model.transfer_migrate_account_responseimportTransferMigrateAccountResponsefromplaid.model.transfer_originator_create_requestimportTransferOriginatorCreateRequestfromplaid.model.transfer_originator_create_responseimportTransferOriginatorCreateResponsefromplaid.model.transfer_originator_get_requestimportTransferOriginatorGetRequestfromplaid.model.transfer_originator_get_responseimportTransferOriginatorGetResponsefromplaid.model.transfer_originator_list_requestimportTransferOriginatorListRequestfromplaid.model.transfer_originator_list_responseimportTransferOriginatorListResponsefromplaid.model.transfer_questionnaire_create_requestimportTransferQuestionnaireCreateRequestfromplaid.model.transfer_questionnaire_create_responseimportTransferQuestionnaireCreateResponsefromplaid.model.transfer_recurring_cancel_requestimportTransferRecurringCancelRequestfromplaid.model.transfer_recurring_cancel_responseimportTransferRecurringCancelResponsefromplaid.model.transfer_recurring_create_requestimportTransferRecurringCreateRequestfromplaid.model.transfer_recurring_create_responseimportTransferRecurringCreateResponsefromplaid.model.transfer_recurring_get_requestimportTransferRecurringGetRequestfromplaid.model.transfer_recurring_get_responseimportTransferRecurringGetResponsefromplaid.model.transfer_recurring_list_requestimportTransferRecurringListRequestfromplaid.model.transfer_recurring_list_responseimportTransferRecurringListResponsefromplaid.model.transfer_refund_cancel_requestimportTransferRefundCancelRequestfromplaid.model.transfer_refund_cancel_responseimportTransferRefundCancelResponsefromplaid.model.transfer_refund_create_requestimportTransferRefundCreateRequestfromplaid.model.transfer_refund_create_responseimportTransferRefundCreateResponsefromplaid.model.transfer_refund_get_requestimportTransferRefundGetRequestfromplaid.model.transfer_refund_get_responseimportTransferRefundGetResponsefromplaid.model.transfer_repayment_list_requestimportTransferRepaymentListRequestfromplaid.model.transfer_repayment_list_responseimportTransferRepaymentListResponsefromplaid.model.transfer_repayment_return_list_requestimportTransferRepaymentReturnListRequestfromplaid.model.transfer_repayment_return_list_responseimportTransferRepaymentReturnListResponsefromplaid.model.transfer_sweep_get_requestimportTransferSweepGetRequestfromplaid.model.transfer_sweep_get_responseimportTransferSweepGetResponsefromplaid.model.transfer_sweep_list_requestimportTransferSweepListRequestfromplaid.model.transfer_sweep_list_responseimportTransferSweepListResponsefromplaid.model.user_create_requestimportUserCreateRequestfromplaid.model.user_create_responseimportUserCreateResponsefromplaid.model.wallet_create_requestimportWalletCreateRequestfromplaid.model.wallet_create_responseimportWalletCreateResponsefromplaid.model.wallet_get_requestimportWalletGetRequestfromplaid.model.wallet_get_responseimportWalletGetResponsefromplaid.model.wallet_list_requestimportWalletListRequestfromplaid.model.wallet_list_responseimportWalletListResponsefromplaid.model.wallet_transaction_execute_requestimportWalletTransactionExecuteRequestfromplaid.model.wallet_transaction_execute_responseimportWalletTransactionExecuteResponsefromplaid.model.wallet_transaction_get_requestimportWalletTransactionGetRequestfromplaid.model.wallet_transaction_get_responseimportWalletTransactionGetResponsefromplaid.model.wallet_transaction_list_requestimportWalletTransactionListRequestfromplaid.model.wallet_transaction_list_responseimportWalletTransactionListResponsefromplaid.model.watchlist_screening_entity_create_requestimportWatchlistScreeningEntityCreateRequestfromplaid.model.watchlist_screening_entity_create_responseimportWatchlistScreeningEntityCreateResponsefromplaid.model.watchlist_screening_entity_get_requestimportWatchlistScreeningEntityGetRequestfromplaid.model.watchlist_screening_entity_get_responseimportWatchlistScreeningEntityGetResponsefromplaid.model.watchlist_screening_entity_history_list_requestimportWatchlistScreeningEntityHistoryListRequestfromplaid.model.watchlist_screening_entity_history_list_responseimportWatchlistScreeningEntityHistoryListResponsefromplaid.model.watchlist_screening_entity_hit_list_requestimportWatchlistScreeningEntityHitListRequestfromplaid.model.watchlist_screening_entity_hit_list_responseimportWatchlistScreeningEntityHitListResponsefromplaid.model.watchlist_screening_entity_list_requestimportWatchlistScreeningEntityListRequestfromplaid.model.watchlist_screening_entity_list_responseimportWatchlistScreeningEntityListResponsefromplaid.model.watchlist_screening_entity_program_get_requestimportWatchlistScreeningEntityProgramGetRequestfromplaid.model.watchlist_screening_entity_program_get_responseimportWatchlistScreeningEntityProgramGetResponsefromplaid.model.watchlist_screening_entity_program_list_requestimportWatchlistScreeningEntityProgramListRequestfromplaid.model.watchlist_screening_entity_program_list_responseimportWatchlistScreeningEntityProgramListResponsefromplaid.model.watchlist_screening_entity_review_create_requestimportWatchlistScreeningEntityReviewCreateRequestfromplaid.model.watchlist_screening_entity_review_create_responseimportWatchlistScreeningEntityReviewCreateResponsefromplaid.model.watchlist_screening_entity_review_list_requestimportWatchlistScreeningEntityReviewListRequestfromplaid.model.watchlist_screening_entity_review_list_responseimportWatchlistScreeningEntityReviewListResponsefromplaid.model.watchlist_screening_entity_update_requestimportWatchlistScreeningEntityUpdateRequestfromplaid.model.watchlist_screening_entity_update_responseimportWatchlistScreeningEntityUpdateResponsefromplaid.model.watchlist_screening_individual_create_requestimportWatchlistScreeningIndividualCreateRequestfromplaid.model.watchlist_screening_individual_create_responseimportWatchlistScreeningIndividualCreateResponsefromplaid.model.watchlist_screening_individual_get_requestimportWatchlistScreeningIndividualGetRequestfromplaid.model.watchlist_screening_individual_get_responseimportWatchlistScreeningIndividualGetResponsefromplaid.model.watchlist_screening_individual_history_list_requestimportWatchlistScreeningIndividualHistoryListRequestfromplaid.model.watchlist_screening_individual_history_list_responseimportWatchlistScreeningIndividualHistoryListResponsefromplaid.model.watchlist_screening_individual_hit_list_requestimportWatchlistScreeningIndividualHitListRequestfromplaid.model.watchlist_screening_individual_hit_list_responseimportWatchlistScreeningIndividualHitListResponsefromplaid.model.watchlist_screening_individual_list_requestimportWatchlistScreeningIndividualListRequestfromplaid.model.watchlist_screening_individual_list_responseimportWatchlistScreeningIndividualListResponsefromplaid.model.watchlist_screening_individual_program_get_requestimportWatchlistScreeningIndividualProgramGetRequestfromplaid.model.watchlist_screening_individual_program_get_responseimportWatchlistScreeningIndividualProgramGetResponsefromplaid.model.watchlist_screening_individual_program_list_requestimportWatchlistScreeningIndividualProgramListRequestfromplaid.model.watchlist_screening_individual_program_list_responseimportWatchlistScreeningIndividualProgramListResponsefromplaid.model.watchlist_screening_individual_review_create_requestimportWatchlistScreeningIndividualReviewCreateRequestfromplaid.model.watchlist_screening_individual_review_create_responseimportWatchlistScreeningIndividualReviewCreateResponsefromplaid.model.watchlist_screening_individual_review_list_requestimportWatchlistScreeningIndividualReviewListRequestfromplaid.model.watchlist_screening_individual_review_list_responseimportWatchlistScreeningIndividualReviewListResponsefromplaid.model.watchlist_screening_individual_update_requestimportWatchlistScreeningIndividualUpdateRequestfromplaid.model.watchlist_screening_individual_update_responseimportWatchlistScreeningIndividualUpdateResponsefromplaid.model.webhook_verification_key_get_requestimportWebhookVerificationKeyGetRequestfromplaid.model.webhook_verification_key_get_responseimportWebhookVerificationKeyGetResponse# 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: clientIdconfiguration.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: plaidVersionconfiguration.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: secretconfiguration.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 clientwithplaid.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_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 dataapi_response=api_instance.accounts_balance_get(accounts_balance_get_request)
pprint(api_response)
exceptplaid.ApiExceptionase:
print("Exception when calling PlaidApi->accounts_balance_get: %s\n"%e)

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
PlaidApiaccounts_balance_getPOST /accounts/balance/getRetrieve real-time balance data
PlaidApiaccounts_getPOST /accounts/getRetrieve accounts
PlaidApiapplication_getPOST /application/getRetrieve information about a Plaid application
PlaidApiasset_report_audit_copy_createPOST /asset_report/audit_copy/createCreate Asset Report Audit Copy
PlaidApiasset_report_audit_copy_getPOST /asset_report/audit_copy/getRetrieve an Asset Report Audit Copy
PlaidApiasset_report_audit_copy_removePOST /asset_report/audit_copy/removeRemove Asset Report Audit Copy
PlaidApiasset_report_createPOST /asset_report/createCreate an Asset Report
PlaidApiasset_report_filterPOST /asset_report/filterFilter Asset Report
PlaidApiasset_report_getPOST /asset_report/getRetrieve an Asset Report
PlaidApiasset_report_pdf_getPOST /asset_report/pdf/getRetrieve a PDF Asset Report
PlaidApiasset_report_refreshPOST /asset_report/refreshRefresh an Asset Report
PlaidApiasset_report_removePOST /asset_report/removeDelete an Asset Report
PlaidApiauth_getPOST /auth/getRetrieve auth data
PlaidApibank_transfer_balance_getPOST /bank_transfer/balance/getGet balance of your Bank Transfer account
PlaidApibank_transfer_cancelPOST /bank_transfer/cancelCancel a bank transfer
PlaidApibank_transfer_createPOST /bank_transfer/createCreate a bank transfer
PlaidApibank_transfer_event_listPOST /bank_transfer/event/listList bank transfer events
PlaidApibank_transfer_event_syncPOST /bank_transfer/event/syncSync bank transfer events
PlaidApibank_transfer_getPOST /bank_transfer/getRetrieve a bank transfer
PlaidApibank_transfer_listPOST /bank_transfer/listList bank transfers
PlaidApibank_transfer_migrate_accountPOST /bank_transfer/migrate_accountMigrate account into Bank Transfers
PlaidApibank_transfer_sweep_getPOST /bank_transfer/sweep/getRetrieve a sweep
PlaidApibank_transfer_sweep_listPOST /bank_transfer/sweep/listList sweeps
PlaidApicategories_getPOST /categories/getGet categories
PlaidApicreate_payment_tokenPOST /payment_initiation/payment/token/createCreate payment token
PlaidApicredit_asset_report_freddie_mac_getPOST /credit/asset_report/freddie_mac/getRetrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
PlaidApicredit_audit_copy_token_createPOST /credit/audit_copy_token/createCreate Asset or Income Report Audit Copy Token
PlaidApicredit_audit_copy_token_updatePOST /credit/audit_copy_token/updateUpdate an Audit Copy Token
PlaidApicredit_bank_employment_getPOST /beta/credit/v1/bank_employment/getRetrieve information from the bank accounts used for employment verification
PlaidApicredit_bank_income_getPOST /credit/bank_income/getRetrieve information from the bank accounts used for income verification
PlaidApicredit_bank_income_pdf_getPOST /credit/bank_income/pdf/getRetrieve information from the bank accounts used for income verification in PDF format
PlaidApicredit_bank_income_refreshPOST /credit/bank_income/refreshRefresh a user's bank income information
PlaidApicredit_bank_income_webhook_updatePOST /credit/bank_income/webhook/updateSubscribe and unsubscribe to proactive notifications for a user's income profile
PlaidApicredit_bank_statements_uploads_getPOST /credit/bank_statements/uploads/getRetrieve data for a user's uploaded bank statements
PlaidApicredit_employment_getPOST /credit/employment/getRetrieve a summary of an individual's employment information
PlaidApicredit_freddie_mac_reports_getPOST /credit/freddie_mac/reports/getRetrieve 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.
PlaidApicredit_payroll_income_getPOST /credit/payroll_income/getRetrieve a user's payroll information
PlaidApicredit_payroll_income_precheckPOST /credit/payroll_income/precheckCheck income verification eligibility and optimize conversion
PlaidApicredit_payroll_income_refreshPOST /credit/payroll_income/refreshRefresh a digital payroll income verification
PlaidApicredit_payroll_income_risk_signals_getPOST /credit/payroll_income/risk_signals/getRetrieve fraud insights for a user's manually uploaded document(s).
PlaidApicredit_relay_createPOST /credit/relay/createCreate a relay token to share an Asset Report with a partner client (beta)
PlaidApicredit_relay_getPOST /credit/relay/getRetrieve the reports associated with a relay token that was shared with you (beta)
PlaidApicredit_relay_refreshPOST /credit/relay/refreshRefresh a report of a relay token (beta)
PlaidApicredit_relay_removePOST /credit/relay/removeRemove relay token (beta)
PlaidApicredit_report_audit_copy_removePOST /credit/audit_copy_token/removeRemove an Audit Copy token
PlaidApicredit_sessions_getPOST /credit/sessions/getRetrieve Link sessions for your user
PlaidApidashboard_user_getPOST /dashboard_user/getRetrieve a dashboard user
PlaidApidashboard_user_listPOST /dashboard_user/listList dashboard users
PlaidApideposit_switch_alt_createPOST /deposit_switch/alt/createCreate a deposit switch without using Plaid Exchange
PlaidApideposit_switch_createPOST /deposit_switch/createCreate a deposit switch
PlaidApideposit_switch_getPOST /deposit_switch/getRetrieve a deposit switch
PlaidApideposit_switch_token_createPOST /deposit_switch/token/createCreate a deposit switch token
PlaidApiemployers_searchPOST /employers/searchSearch employer database
PlaidApiemployment_verification_getPOST /employment/verification/get(Deprecated) Retrieve a summary of an individual's employment information
PlaidApifdx_notificationsPOST /fdx/notificationsWebhook receiver for fdx notifications
PlaidApiidentity_getPOST /identity/getRetrieve identity data
PlaidApiidentity_matchPOST /identity/matchRetrieve identity match score
PlaidApiidentity_refreshPOST /identity/refreshRefresh identity data
PlaidApiidentity_verification_createPOST /identity_verification/createCreate a new identity verification
PlaidApiidentity_verification_getPOST /identity_verification/getRetrieve Identity Verification
PlaidApiidentity_verification_listPOST /identity_verification/listList Identity Verifications
PlaidApiidentity_verification_retryPOST /identity_verification/retryRetry an Identity Verification
PlaidApiincome_verification_createPOST /income/verification/create(Deprecated) Create an income verification instance
PlaidApiincome_verification_documents_downloadPOST /income/verification/documents/download(Deprecated) Download the original documents used for income verification
PlaidApiincome_verification_paystubs_getPOST /income/verification/paystubs/get(Deprecated) Retrieve information from the paystubs used for income verification
PlaidApiincome_verification_precheckPOST /income/verification/precheck(Deprecated) Check digital income verification eligibility and optimize conversion
PlaidApiincome_verification_taxforms_getPOST /income/verification/taxforms/get(Deprecated) Retrieve information from the tax documents used for income verification
PlaidApiinstitutions_getPOST /institutions/getGet details of all supported institutions
PlaidApiinstitutions_get_by_idPOST /institutions/get_by_idGet details of an institution
PlaidApiinstitutions_searchPOST /institutions/searchSearch institutions
PlaidApiinvestments_auth_getPOST /investments/auth/getGet data needed to authorize an investments transfer
PlaidApiinvestments_holdings_getPOST /investments/holdings/getGet Investment holdings
PlaidApiinvestments_refreshPOST /investments/refreshRefresh investment data
PlaidApiinvestments_transactions_getPOST /investments/transactions/getGet investment transactions
PlaidApiitem_access_token_invalidatePOST /item/access_token/invalidateInvalidate access_token
PlaidApiitem_activity_listPOST /item/activity/listList a historical log of user consent events
PlaidApiitem_application_listPOST /item/application/listList a user’s connected applications
PlaidApiitem_application_scopes_updatePOST /item/application/scopes/updateUpdate the scopes of access for a particular application
PlaidApiitem_create_public_tokenPOST /item/public_token/createCreate public token
PlaidApiitem_getPOST /item/getRetrieve an Item
PlaidApiitem_importPOST /item/importImport Item
PlaidApiitem_public_token_exchangePOST /item/public_token/exchangeExchange public token for an access token
PlaidApiitem_removePOST /item/removeRemove an Item
PlaidApiitem_webhook_updatePOST /item/webhook/updateUpdate Webhook URL
PlaidApiliabilities_getPOST /liabilities/getRetrieve Liabilities data
PlaidApilink_delivery_createPOST /link_delivery/createCreate Hosted Link session
PlaidApilink_delivery_getPOST /link_delivery/getGet Hosted Link session
PlaidApilink_oauth_correlation_id_exchangePOST /link/oauth/correlation_id/exchangeExchange the Link Correlation Id for a Link Token
PlaidApilink_token_createPOST /link/token/createCreate Link Token
PlaidApilink_token_getPOST /link/token/getGet Link Token
PlaidApipartner_customer_createPOST /partner/customer/createCreates a new end customer for a Plaid reseller.
PlaidApipartner_customer_enablePOST /partner/customer/enableEnables a Plaid reseller's end customer in the Production environment.
PlaidApipartner_customer_getPOST /partner/customer/getReturns a Plaid reseller's end customer.
PlaidApipartner_customer_oauth_institutions_getPOST /partner/customer/oauth_institutions/getReturns OAuth-institution registration information for a given end customer.
PlaidApipartner_customer_removePOST /partner/customer/removeRemoves a Plaid reseller's end customer.
PlaidApipayment_initiation_consent_createPOST /payment_initiation/consent/createCreate payment consent
PlaidApipayment_initiation_consent_getPOST /payment_initiation/consent/getGet payment consent
PlaidApipayment_initiation_consent_payment_executePOST /payment_initiation/consent/payment/executeExecute a single payment using consent
PlaidApipayment_initiation_consent_revokePOST /payment_initiation/consent/revokeRevoke payment consent
PlaidApipayment_initiation_payment_createPOST /payment_initiation/payment/createCreate a payment
PlaidApipayment_initiation_payment_getPOST /payment_initiation/payment/getGet payment details
PlaidApipayment_initiation_payment_listPOST /payment_initiation/payment/listList payments
PlaidApipayment_initiation_payment_reversePOST /payment_initiation/payment/reverseReverse an existing payment
PlaidApipayment_initiation_recipient_createPOST /payment_initiation/recipient/createCreate payment recipient
PlaidApipayment_initiation_recipient_getPOST /payment_initiation/recipient/getGet payment recipient
PlaidApipayment_initiation_recipient_listPOST /payment_initiation/recipient/listList payment recipients
PlaidApipayment_profile_createPOST /payment_profile/createCreate payment profile
PlaidApipayment_profile_getPOST /payment_profile/getGet payment profile
PlaidApipayment_profile_removePOST /payment_profile/removeRemove payment profile
PlaidApiprocessor_apex_processor_token_createPOST /processor/apex/processor_token/createCreate Apex bank account token
PlaidApiprocessor_auth_getPOST /processor/auth/getRetrieve Auth data
PlaidApiprocessor_balance_getPOST /processor/balance/getRetrieve Balance data
PlaidApiprocessor_bank_transfer_createPOST /processor/bank_transfer/createCreate a bank transfer as a processor
PlaidApiprocessor_identity_getPOST /processor/identity/getRetrieve Identity data
PlaidApiprocessor_identity_matchPOST /processor/identity/matchRetrieve identity match score
PlaidApiprocessor_signal_decision_reportPOST /processor/signal/decision/reportReport whether you initiated an ACH transaction
PlaidApiprocessor_signal_evaluatePOST /processor/signal/evaluateEvaluate a planned ACH transaction
PlaidApiprocessor_signal_return_reportPOST /processor/signal/return/reportReport a return for an ACH transaction
PlaidApiprocessor_stripe_bank_account_token_createPOST /processor/stripe/bank_account_token/createCreate Stripe bank account token
PlaidApiprocessor_token_createPOST /processor/token/createCreate processor token
PlaidApiprocessor_token_permissions_getPOST /processor/token/permissions/getGet a processor token's product permissions
PlaidApiprocessor_token_permissions_setPOST /processor/token/permissions/setControl a processor's access to products
PlaidApiprocessor_token_webhook_updatePOST /processor/token/webhook/updateUpdate a processor token's webhook URL
PlaidApiprocessor_transactions_getPOST /processor/transactions/getGet transaction data
PlaidApiprocessor_transactions_recurring_getPOST /processor/transactions/recurring/getFetch recurring transaction streams
PlaidApiprocessor_transactions_refreshPOST /processor/transactions/refreshRefresh transaction data
PlaidApiprocessor_transactions_syncPOST /processor/transactions/syncGet incremental transaction updates on an Item
PlaidApisandbox_bank_income_fire_webhookPOST /sandbox/bank_income/fire_webhookManually fire a bank income webhook in sandbox
PlaidApisandbox_bank_transfer_fire_webhookPOST /sandbox/bank_transfer/fire_webhookManually fire a Bank Transfer webhook
PlaidApisandbox_bank_transfer_simulatePOST /sandbox/bank_transfer/simulateSimulate a bank transfer event in Sandbox
PlaidApisandbox_income_fire_webhookPOST /sandbox/income/fire_webhookManually fire an Income webhook
PlaidApisandbox_item_fire_webhookPOST /sandbox/item/fire_webhookFire a test webhook
PlaidApisandbox_item_reset_loginPOST /sandbox/item/reset_loginForce a Sandbox Item into an error state
PlaidApisandbox_item_set_verification_statusPOST /sandbox/item/set_verification_statusSet verification status for Sandbox account
PlaidApisandbox_oauth_select_accountsPOST /sandbox/oauth/select_accountsSave the selected accounts when connecting to the Platypus Oauth institution
PlaidApisandbox_payment_profile_reset_loginPOST /sandbox/payment_profile/reset_loginReset the login of a Payment Profile
PlaidApisandbox_processor_token_createPOST /sandbox/processor_token/createCreate a test Item and processor token
PlaidApisandbox_public_token_createPOST /sandbox/public_token/createCreate a test Item
PlaidApisandbox_transfer_fire_webhookPOST /sandbox/transfer/fire_webhookManually fire a Transfer webhook
PlaidApisandbox_transfer_repayment_simulatePOST /sandbox/transfer/repayment/simulateTrigger the creation of a repayment
PlaidApisandbox_transfer_simulatePOST /sandbox/transfer/simulateSimulate a transfer event in Sandbox
PlaidApisandbox_transfer_sweep_simulatePOST /sandbox/transfer/sweep/simulateSimulate creating a sweep
PlaidApisandbox_transfer_test_clock_advancePOST /sandbox/transfer/test_clock/advanceAdvance a test clock
PlaidApisandbox_transfer_test_clock_createPOST /sandbox/transfer/test_clock/createCreate a test clock
PlaidApisandbox_transfer_test_clock_getPOST /sandbox/transfer/test_clock/getGet a test clock
PlaidApisandbox_transfer_test_clock_listPOST /sandbox/transfer/test_clock/listList test clocks
PlaidApisignal_decision_reportPOST /signal/decision/reportReport whether you initiated an ACH transaction
PlaidApisignal_evaluatePOST /signal/evaluateEvaluate a planned ACH transaction
PlaidApisignal_preparePOST /signal/prepareOpt-in an Item to Signal
PlaidApisignal_return_reportPOST /signal/return/reportReport a return for an ACH transaction
PlaidApistatements_downloadPOST /statements/downloadRetrieve a single statement.
PlaidApistatements_listPOST /statements/listRetrieve a list of all statements associated with the provided item.
PlaidApitransactions_enhancePOST /beta/transactions/v1/enhanceenhance locally-held transaction data
PlaidApitransactions_enrichPOST /transactions/enrichEnrich locally-held transaction data
PlaidApitransactions_getPOST /transactions/getGet transaction data
PlaidApitransactions_recurring_getPOST /transactions/recurring/getFetch recurring transaction streams
PlaidApitransactions_refreshPOST /transactions/refreshRefresh transaction data
PlaidApitransactions_rules_createPOST /beta/transactions/rules/v1/createCreate transaction category rule
PlaidApitransactions_rules_listPOST /beta/transactions/rules/v1/listReturn a list of rules created for the Item associated with the access token.
PlaidApitransactions_rules_removePOST /beta/transactions/rules/v1/removeRemove transaction rule
PlaidApitransactions_syncPOST /transactions/syncGet incremental transaction updates on an Item
PlaidApitransfer_authorization_createPOST /transfer/authorization/createCreate a transfer authorization
PlaidApitransfer_balance_getPOST /transfer/balance/getRetrieve a balance held with Plaid
PlaidApitransfer_cancelPOST /transfer/cancelCancel a transfer
PlaidApitransfer_capabilities_getPOST /transfer/capabilities/getGet RTP eligibility information of a transfer
PlaidApitransfer_configuration_getPOST /transfer/configuration/getGet transfer product configuration
PlaidApitransfer_createPOST /transfer/createCreate a transfer
PlaidApitransfer_diligence_document_uploadPOST /transfer/diligence/document/uploadThis 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.
PlaidApitransfer_diligence_submitPOST /transfer/diligence/submitSubmit transfer diligence on behalf of the end customer (i.e. the originator).
PlaidApitransfer_event_listPOST /transfer/event/listList transfer events
PlaidApitransfer_event_syncPOST /transfer/event/syncSync transfer events
PlaidApitransfer_getPOST /transfer/getRetrieve a transfer
PlaidApitransfer_intent_createPOST /transfer/intent/createCreate a transfer intent object to invoke the Transfer UI
PlaidApitransfer_intent_getPOST /transfer/intent/getRetrieve more information about a transfer intent
PlaidApitransfer_listPOST /transfer/listList transfers
PlaidApitransfer_metrics_getPOST /transfer/metrics/getGet transfer product usage metrics
PlaidApitransfer_migrate_accountPOST /transfer/migrate_accountMigrate account into Transfers
PlaidApitransfer_originator_createPOST /transfer/originator/createCreate a new originator
PlaidApitransfer_originator_getPOST /transfer/originator/getGet status of an originator's onboarding
PlaidApitransfer_originator_listPOST /transfer/originator/listGet status of all originators' onboarding
PlaidApitransfer_questionnaire_createPOST /transfer/questionnaire/createGenerate a Plaid-hosted onboarding UI URL.
PlaidApitransfer_recurring_cancelPOST /transfer/recurring/cancelCancel a recurring transfer.
PlaidApitransfer_recurring_createPOST /transfer/recurring/createCreate a recurring transfer
PlaidApitransfer_recurring_getPOST /transfer/recurring/getRetrieve a recurring transfer
PlaidApitransfer_recurring_listPOST /transfer/recurring/listList recurring transfers
PlaidApitransfer_refund_cancelPOST /transfer/refund/cancelCancel a refund
PlaidApitransfer_refund_createPOST /transfer/refund/createCreate a refund
PlaidApitransfer_refund_getPOST /transfer/refund/getRetrieve a refund
PlaidApitransfer_repayment_listPOST /transfer/repayment/listLists historical repayments
PlaidApitransfer_repayment_return_listPOST /transfer/repayment/return/listList the returns included in a repayment
PlaidApitransfer_sweep_getPOST /transfer/sweep/getRetrieve a sweep
PlaidApitransfer_sweep_listPOST /transfer/sweep/listList sweeps
PlaidApiuser_createPOST /user/createCreate user
PlaidApiwallet_createPOST /wallet/createCreate an e-wallet
PlaidApiwallet_getPOST /wallet/getFetch an e-wallet
PlaidApiwallet_listPOST /wallet/listFetch a list of e-wallets
PlaidApiwallet_transaction_executePOST /wallet/transaction/executeExecute a transaction using an e-wallet
PlaidApiwallet_transaction_getPOST /wallet/transaction/getFetch an e-wallet transaction
PlaidApiwallet_transaction_listPOST /wallet/transaction/listList e-wallet transactions
PlaidApiwatchlist_screening_entity_createPOST /watchlist_screening/entity/createCreate a watchlist screening for an entity
PlaidApiwatchlist_screening_entity_getPOST /watchlist_screening/entity/getGet an entity screening
PlaidApiwatchlist_screening_entity_history_listPOST /watchlist_screening/entity/history/listList history for entity watchlist screenings
PlaidApiwatchlist_screening_entity_hit_listPOST /watchlist_screening/entity/hit/listList hits for entity watchlist screenings
PlaidApiwatchlist_screening_entity_listPOST /watchlist_screening/entity/listList entity watchlist screenings
PlaidApiwatchlist_screening_entity_program_getPOST /watchlist_screening/entity/program/getGet entity watchlist screening program
PlaidApiwatchlist_screening_entity_program_listPOST /watchlist_screening/entity/program/listList entity watchlist screening programs
PlaidApiwatchlist_screening_entity_review_createPOST /watchlist_screening/entity/review/createCreate a review for an entity watchlist screening
PlaidApiwatchlist_screening_entity_review_listPOST /watchlist_screening/entity/review/listList reviews for entity watchlist screenings
PlaidApiwatchlist_screening_entity_updatePOST /watchlist_screening/entity/updateUpdate an entity screening
PlaidApiwatchlist_screening_individual_createPOST /watchlist_screening/individual/createCreate a watchlist screening for a person
PlaidApiwatchlist_screening_individual_getPOST /watchlist_screening/individual/getRetrieve an individual watchlist screening
PlaidApiwatchlist_screening_individual_history_listPOST /watchlist_screening/individual/history/listList history for individual watchlist screenings
PlaidApiwatchlist_screening_individual_hit_listPOST /watchlist_screening/individual/hit/listList hits for individual watchlist screening
PlaidApiwatchlist_screening_individual_listPOST /watchlist_screening/individual/listList Individual Watchlist Screenings
PlaidApiwatchlist_screening_individual_program_getPOST /watchlist_screening/individual/program/getGet individual watchlist screening program
PlaidApiwatchlist_screening_individual_program_listPOST /watchlist_screening/individual/program/listList individual watchlist screening programs
PlaidApiwatchlist_screening_individual_review_createPOST /watchlist_screening/individual/review/createCreate a review for an individual watchlist screening
PlaidApiwatchlist_screening_individual_review_listPOST /watchlist_screening/individual/review/listList reviews for individual watchlist screenings
PlaidApiwatchlist_screening_individual_updatePOST /watchlist_screening/individual/updateUpdate individual watchlist screening
PlaidApiwebhook_verification_key_getPOST /webhook_verification_key/getGet 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

Packages

Contributors

Languages