plaid 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown → 14.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -3
- data/CONTRIBUTING.md +1 -5
- data/Gemfile.lock +3 -3
- data/Makefile +1 -1
- data/README.md +5 -4
- data/doc/rdoc/.DS_Store +0 -0
- data/doc/rdoc/apple-touch-icon.png +0 -0
- data/doc/rdoc/classes/Object.html +118 -0
- data/doc/rdoc/classes/Plaid/APIError.html +97 -0
- data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/AccessToken.html +211 -0
- data/doc/rdoc/classes/Plaid/Accounts.html +257 -0
- data/doc/rdoc/classes/Plaid/AccountsResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +205 -0
- data/doc/rdoc/classes/Plaid/Apex.html +149 -0
- data/doc/rdoc/classes/Plaid/AssetReport.html +683 -0
- data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +96 -0
- data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +96 -0
- data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +96 -0
- data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Auth.html +206 -0
- data/doc/rdoc/classes/Plaid/AuthResponse.html +127 -0
- data/doc/rdoc/classes/Plaid/Balance.html +206 -0
- data/doc/rdoc/classes/Plaid/BaseProduct.html +304 -0
- data/doc/rdoc/classes/Plaid/Categories.html +191 -0
- data/doc/rdoc/classes/Plaid/CategoriesResponse.html +111 -0
- data/doc/rdoc/classes/Plaid/Client.html +802 -0
- data/doc/rdoc/classes/Plaid/CreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/CreditDetails.html +203 -0
- data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +128 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +150 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch.html +339 -0
- data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +205 -0
- data/doc/rdoc/classes/Plaid/Dwolla.html +150 -0
- data/doc/rdoc/classes/Plaid/Error.html +214 -0
- data/doc/rdoc/classes/Plaid/GetResponse.html +134 -0
- data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +137 -0
- data/doc/rdoc/classes/Plaid/Holdings.html +218 -0
- data/doc/rdoc/classes/Plaid/Identity.html +199 -0
- data/doc/rdoc/classes/Plaid/IdentityResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Income.html +198 -0
- data/doc/rdoc/classes/Plaid/IncomeResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/InstitutionError.html +96 -0
- data/doc/rdoc/classes/Plaid/Institutions.html +356 -0
- data/doc/rdoc/classes/Plaid/InvalidInputError.html +97 -0
- data/doc/rdoc/classes/Plaid/InvalidRequestError.html +96 -0
- data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +145 -0
- data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +240 -0
- data/doc/rdoc/classes/Plaid/Investments.html +204 -0
- data/doc/rdoc/classes/Plaid/Item/GetResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Item.html +382 -0
- data/doc/rdoc/classes/Plaid/ItemError.html +98 -0
- data/doc/rdoc/classes/Plaid/Liabilities.html +202 -0
- data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +128 -0
- data/doc/rdoc/classes/Plaid/LinkToken.html +215 -0
- data/doc/rdoc/classes/Plaid/Middleware.html +225 -0
- data/doc/rdoc/classes/Plaid/Models/Account.html +166 -0
- data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReport.html +153 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +198 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +145 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +139 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +187 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +159 -0
- data/doc/rdoc/classes/Plaid/Models/Balances.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/BaseError.html +140 -0
- data/doc/rdoc/classes/Plaid/Models/BaseModel.html +259 -0
- data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/Category.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/Cause.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +175 -0
- data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +137 -0
- data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +166 -0
- data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/Error.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/Holding.html +181 -0
- data/doc/rdoc/classes/Plaid/Models/Identity.html +135 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/Income.html +173 -0
- data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +136 -0
- data/doc/rdoc/classes/Plaid/Models/Institution.html +230 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +136 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +111 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +224 -0
- data/doc/rdoc/classes/Plaid/Models/Item.html +169 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +119 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +119 -0
- data/doc/rdoc/classes/Plaid/Models/Liabilities.html +130 -0
- data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +158 -0
- data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/MFA.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/NumberACH.html +134 -0
- data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +134 -0
- data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/Numbers.html +135 -0
- data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +128 -0
- data/doc/rdoc/classes/Plaid/Models/Payment.html +191 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +134 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/Security.html +228 -0
- data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +305 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/Transaction.html +265 -0
- data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +166 -0
- data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +167 -0
- data/doc/rdoc/classes/Plaid/Models/Warning.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +174 -0
- data/doc/rdoc/classes/Plaid/Models.html +506 -0
- data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +205 -0
- data/doc/rdoc/classes/Plaid/Ocrolus.html +151 -0
- data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +191 -0
- data/doc/rdoc/classes/Plaid/PaymentInitiation.html +570 -0
- data/doc/rdoc/classes/Plaid/PaymentListResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +142 -0
- data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PlaidAPIError.html +260 -0
- data/doc/rdoc/classes/Plaid/PlaidError.html +96 -0
- data/doc/rdoc/classes/Plaid/PlaidServerError.html +96 -0
- data/doc/rdoc/classes/Plaid/Processor.html +143 -0
- data/doc/rdoc/classes/Plaid/ProcessorToken.html +219 -0
- data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PublicToken.html +283 -0
- data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +97 -0
- data/doc/rdoc/classes/Plaid/Sandbox.html +119 -0
- data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/SandboxItem.html +351 -0
- data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +249 -0
- data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +111 -0
- data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +215 -0
- data/doc/rdoc/classes/Plaid/Stripe.html +151 -0
- data/doc/rdoc/classes/Plaid/SubproductMixin.html +179 -0
- data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +144 -0
- data/doc/rdoc/classes/Plaid/Transactions.html +302 -0
- data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Webhook.html +214 -0
- data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Webhooks.html +207 -0
- data/doc/rdoc/classes/Plaid.html +772 -0
- data/doc/rdoc/created.rid +28 -0
- data/doc/rdoc/css/github.css +123 -0
- data/doc/rdoc/css/main.css +333 -0
- data/doc/rdoc/css/panel.css +383 -0
- data/doc/rdoc/css/reset.css +48 -0
- data/doc/rdoc/favicon.ico +0 -0
- data/doc/rdoc/files/LICENSE_txt.html +98 -0
- data/doc/rdoc/files/README_md.html +388 -0
- data/doc/rdoc/files/lib/plaid/client_rb.html +121 -0
- data/doc/rdoc/files/lib/plaid/errors_rb.html +132 -0
- data/doc/rdoc/files/lib/plaid/middleware_rb.html +99 -0
- data/doc/rdoc/files/lib/plaid/models_rb.html +450 -0
- data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +132 -0
- data/doc/rdoc/files/lib/plaid/products/auth_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +92 -0
- data/doc/rdoc/files/lib/plaid/products/categories_rb.html +92 -0
- data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/identity_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/income_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/investments_rb.html +120 -0
- data/doc/rdoc/files/lib/plaid/products/item_rb.html +142 -0
- data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +127 -0
- data/doc/rdoc/files/lib/plaid/products/processor_rb.html +142 -0
- data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +117 -0
- data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +105 -0
- data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/version_rb.html +82 -0
- data/doc/rdoc/files/lib/plaid_rb.html +120 -0
- data/doc/rdoc/i/arrows.png +0 -0
- data/doc/rdoc/i/results_bg.png +0 -0
- data/doc/rdoc/i/tree_bg.png +0 -0
- data/doc/rdoc/index.html +13 -0
- data/doc/rdoc/js/highlight.pack.js +1 -0
- data/doc/rdoc/js/jquery-1.3.2.min.js +19 -0
- data/doc/rdoc/js/main.js +29 -0
- data/doc/rdoc/js/navigation.js +142 -0
- data/doc/rdoc/js/navigation.js.gz +0 -0
- data/doc/rdoc/js/search_index.js +1 -0
- data/doc/rdoc/js/search_index.js.gz +0 -0
- data/doc/rdoc/js/searchdoc.js +468 -0
- data/doc/rdoc/js/searcher.js +229 -0
- data/doc/rdoc/js/searcher.js.gz +0 -0
- data/doc/rdoc/panel/index.html +74 -0
- data/doc/rdoc/panel/links.html +60 -0
- data/doc/rdoc/panel/tree.js +1 -0
- data/lib/plaid/.DS_Store +0 -0
- data/lib/plaid/api/plaid_api.rb +644 -61
- data/lib/plaid/api_client.rb +3 -2
- data/lib/plaid/api_error.rb +1 -1
- data/lib/plaid/configuration.rb +1 -1
- data/lib/plaid/models/account_access.rb +238 -0
- data/lib/plaid/models/account_assets.rb +16 -5
- data/lib/plaid/models/account_assets_all_of.rb +16 -4
- data/lib/plaid/models/account_balance.rb +6 -10
- data/lib/plaid/models/account_base.rb +1 -2
- data/lib/plaid/models/account_filter.rb +258 -0
- data/lib/plaid/models/account_filters_response.rb +1 -1
- data/lib/plaid/models/account_identity.rb +1 -2
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_selection_cardinality.rb +38 -0
- data/lib/plaid/models/account_subtype.rb +5 -1
- data/lib/plaid/models/account_type.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_request.rb +1 -1
- data/lib/plaid/models/accounts_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_response.rb +1 -1
- data/lib/plaid/models/ach_class.rb +1 -1
- data/lib/plaid/models/address.rb +1 -2
- data/lib/plaid/models/address_data.rb +2 -6
- data/lib/plaid/models/{nullable_address_data.rb → address_data_nullable.rb} +5 -9
- data/lib/plaid/models/{nullable_address.rb → address_nullable.rb} +4 -5
- data/lib/plaid/models/application.rb +17 -2
- data/lib/plaid/models/application_get_request.rb +1 -1
- data/lib/plaid/models/application_get_response.rb +1 -1
- data/lib/plaid/models/apr.rb +1 -1
- data/lib/plaid/models/asset_report.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_filter_request.rb +1 -1
- data/lib/plaid/models/asset_report_filter_response.rb +1 -1
- data/lib/plaid/models/asset_report_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +2 -2
- data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_transaction.rb +108 -187
- data/lib/plaid/models/asset_report_transaction_all_of.rb +6 -21
- data/lib/plaid/models/asset_report_user.rb +2 -2
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +21 -1
- data/lib/plaid/models/auth_get_request.rb +1 -1
- data/lib/plaid/models/auth_get_request_options.rb +1 -1
- data/lib/plaid/models/auth_get_response.rb +1 -1
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
- data/lib/plaid/models/bank_transfer.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_direction.rb +2 -1
- data/lib/plaid/models/bank_transfer_event.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_list_request.rb +16 -4
- data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_failure.rb +2 -2
- data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_network.rb +1 -1
- data/lib/plaid/models/bank_transfer_receiver_details.rb +3 -3
- data/lib/plaid/models/bank_transfer_status.rb +1 -1
- data/lib/plaid/models/bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_user.rb +2 -2
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/cause.rb +1 -1
- data/lib/plaid/models/connected_application.rb +357 -0
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/credit_card_liability.rb +5 -9
- data/lib/plaid/models/credit_filter.rb +2 -2
- data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
- data/lib/plaid/models/default_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +59 -5
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request.rb +59 -5
- data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
- data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_response.rb +74 -7
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +250 -0
- data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
- data/lib/plaid/models/depository_filter.rb +2 -2
- data/lib/plaid/models/email.rb +1 -1
- data/lib/plaid/models/employee.rb +6 -17
- data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employer.rb +7 -3
- data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employers_search_request.rb +1 -1
- data/lib/plaid/models/employers_search_response.rb +1 -1
- data/lib/plaid/models/error.rb +2 -9
- data/lib/plaid/models/external_payment_options.rb +61 -7
- data/lib/plaid/models/external_payment_refund_details.rb +7 -2
- data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +21 -25
- data/lib/plaid/models/external_payment_schedule_get.rb +19 -19
- data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
- data/lib/plaid/models/health_incident.rb +18 -5
- data/lib/plaid/models/historical_balance.rb +3 -3
- data/lib/plaid/models/historical_update_webhook.rb +1 -1
- data/lib/plaid/models/holding.rb +3 -3
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/identity_get_request.rb +1 -1
- data/lib/plaid/models/identity_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_get_response.rb +1 -1
- data/lib/plaid/models/incident_update.rb +4 -4
- data/lib/plaid/models/income_breakdown.rb +36 -2
- data/lib/plaid/models/income_summary.rb +26 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_response.rb +1 -1
- data/lib/plaid/models/{income_verification_paystub_get_request.rb → income_verification_paystubs_get_request.rb} +5 -5
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +241 -0
- data/lib/plaid/models/income_verification_refresh_request.rb +245 -0
- data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
- data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
- data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_summary_get_response.rb +12 -2
- data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +1 -1
- data/lib/plaid/models/institution.rb +2 -2
- data/lib/plaid/models/institution_status.rb +30 -3
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +2 -2
- data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
- data/lib/plaid/models/institutions_get_request.rb +1 -1
- data/lib/plaid/models/institutions_get_request_options.rb +2 -2
- data/lib/plaid/models/institutions_get_response.rb +1 -1
- data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
- data/lib/plaid/models/institutions_search_request.rb +2 -2
- data/lib/plaid/models/institutions_search_request_options.rb +2 -2
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_filter.rb +2 -2
- data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
- data/lib/plaid/models/investment_transaction.rb +5 -5
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/item.rb +5 -5
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_application_list_request.rb +241 -0
- data/lib/plaid/models/item_application_list_response.rb +237 -0
- data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
- data/lib/plaid/models/item_application_scopes_update_request.rb +274 -0
- data/lib/plaid/models/{income_verification_paystub_get_response.rb → item_application_scopes_update_response.rb} +11 -15
- data/lib/plaid/models/item_error_webhook.rb +1 -1
- data/lib/plaid/models/item_get_request.rb +1 -1
- data/lib/plaid/models/item_get_response.rb +2 -2
- data/lib/plaid/models/item_import_request.rb +1 -1
- data/lib/plaid/models/item_import_request_options.rb +1 -1
- data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
- data/lib/plaid/models/item_import_response.rb +1 -1
- data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/item_public_token_create_request.rb +1 -1
- data/lib/plaid/models/item_public_token_create_response.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
- data/lib/plaid/models/item_remove_request.rb +1 -1
- data/lib/plaid/models/item_remove_response.rb +1 -1
- data/lib/plaid/models/item_status.rb +7 -16
- data/lib/plaid/models/item_status_investments.rb +232 -0
- data/lib/plaid/models/{nullable_recipient_bacs.rb → item_status_last_webhook.rb} +22 -26
- data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +10 -19
- data/lib/plaid/models/item_status_transactions.rb +232 -0
- data/lib/plaid/models/item_webhook_update_request.rb +1 -1
- data/lib/plaid/models/item_webhook_update_response.rb +1 -1
- data/lib/plaid/models/jwk_public_key.rb +1 -1
- data/lib/plaid/models/jwt_header.rb +1 -1
- data/lib/plaid/models/liabilities_default_update_webhook.rb +27 -2
- data/lib/plaid/models/liabilities_get_request.rb +1 -1
- data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
- data/lib/plaid/models/liabilities_get_response.rb +1 -1
- data/lib/plaid/models/liabilities_object.rb +4 -4
- data/lib/plaid/models/liability_override.rb +3 -3
- data/lib/plaid/models/link_token_account_filters.rb +2 -2
- data/lib/plaid/models/link_token_create_request.rb +12 -3
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
- data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -3
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +22 -1
- data/lib/plaid/models/link_token_create_request_user.rb +8 -8
- data/lib/plaid/models/link_token_create_response.rb +1 -1
- data/lib/plaid/models/link_token_eu_config.rb +220 -0
- data/lib/plaid/models/link_token_get_metadata_response.rb +11 -1
- data/lib/plaid/models/link_token_get_request.rb +1 -1
- data/lib/plaid/models/link_token_get_response.rb +11 -1
- data/lib/plaid/models/loan_filter.rb +2 -2
- data/lib/plaid/models/location.rb +1 -1
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
- data/lib/plaid/models/mortgage_liability.rb +20 -6
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/numbers.rb +1 -41
- data/lib/plaid/models/numbers_ach.rb +2 -2
- data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +5 -5
- data/lib/plaid/models/numbers_bacs.rb +1 -1
- data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +4 -4
- data/lib/plaid/models/numbers_eft.rb +1 -1
- data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +4 -4
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +4 -4
- data/lib/plaid/models/override_account_type.rb +40 -0
- data/lib/plaid/models/override_accounts.rb +2 -2
- data/lib/plaid/models/owner.rb +1 -1
- data/lib/plaid/models/owner_override.rb +1 -1
- data/lib/plaid/models/pay_frequency.rb +1 -1
- data/lib/plaid/models/pay_period_details.rb +4 -4
- data/lib/plaid/models/payment_amount.rb +12 -1
- data/lib/plaid/models/payment_initiation_address.rb +118 -4
- data/lib/plaid/models/payment_initiation_metadata.rb +16 -1
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +53 -1
- data/lib/plaid/models/payment_initiation_payment.rb +20 -2
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +53 -3
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +35 -1
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +22 -1
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +20 -2
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -18
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +22 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +49 -2
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +22 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +16 -1
- data/lib/plaid/models/payment_meta.rb +1 -1
- data/lib/plaid/models/payment_schedule_interval.rb +1 -1
- data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
- data/lib/plaid/models/paystub.rb +5 -22
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/{nullable_access_token.rb → paystub_employer.rb} +17 -6
- data/lib/plaid/models/paystub_ytd_details.rb +2 -1
- data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
- data/lib/plaid/models/phone_number.rb +11 -3
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request.rb +1 -1
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
- data/lib/plaid/models/processor_identity_get_request.rb +1 -1
- data/lib/plaid/models/processor_identity_get_response.rb +1 -1
- data/lib/plaid/models/processor_number.rb +5 -5
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +36 -2
- data/lib/plaid/models/processor_token_create_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +262 -0
- data/lib/plaid/models/product_status.rb +3 -3
- data/lib/plaid/models/product_status_breakdown.rb +1 -2
- data/lib/plaid/models/products.rb +2 -1
- data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +2 -2
- data/lib/plaid/models/recaptcha_required_error.rb +1 -1
- data/lib/plaid/models/recipient_bacs.rb +53 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +288 -0
- data/lib/plaid/models/requested_scopes.rb +261 -0
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +4 -4
- data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
- data/lib/plaid/models/scopes.rb +243 -0
- data/lib/plaid/models/scopes_nullable.rb +249 -0
- data/lib/plaid/models/security.rb +3 -3
- data/lib/plaid/models/sender_bacs_nullable.rb +288 -0
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/signal_address_data.rb +263 -0
- data/lib/plaid/models/signal_decision_report_request.rb +259 -0
- data/lib/plaid/models/signal_decision_report_response.rb +224 -0
- data/lib/plaid/models/signal_device.rb +232 -0
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +584 -0
- data/lib/plaid/models/signal_evaluate_request.rb +355 -0
- data/lib/plaid/models/signal_evaluate_response.rb +252 -0
- data/lib/plaid/models/signal_person_name.rb +265 -0
- data/lib/plaid/models/signal_return_report_request.rb +259 -0
- data/lib/plaid/models/signal_return_report_response.rb +224 -0
- data/lib/plaid/models/signal_scores.rb +227 -0
- data/lib/plaid/models/signal_user.rb +252 -0
- data/lib/plaid/models/standalone_account_type.rb +1 -1
- data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
- data/lib/plaid/models/standalone_investment_transaction_subtype.rb +1 -1
- data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
- data/lib/plaid/models/student_loan.rb +27 -7
- data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
- data/lib/plaid/models/student_loan_status.rb +2 -2
- data/lib/plaid/models/student_repayment_plan.rb +3 -3
- data/lib/plaid/models/transaction.rb +164 -124
- data/lib/plaid/models/transaction_all_of.rb +312 -0
- data/lib/plaid/models/transaction_base.rb +436 -0
- data/lib/plaid/models/transaction_code.rb +1 -1
- data/lib/plaid/models/transaction_data.rb +2 -2
- data/lib/plaid/models/transaction_override.rb +3 -3
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +18 -5
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/user_custom_password.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
- data/lib/plaid/models/verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/verification_refresh_status.rb +36 -0
- data/lib/plaid/models/verification_status.rb +1 -1
- data/lib/plaid/models/warning.rb +35 -1
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
- data/lib/plaid/version.rb +2 -2
- data/lib/plaid.rb +59 -13
- data/pkg/plaid-13.2.0.gem +0 -0
- data/pkg/plaid-14.0.0.beta.3.gem +0 -0
- data/pkg/plaid-14.0.0.beta.5.gem +0 -0
- data/plaid.gemspec +1 -1
- data/templates/ruby/api_client.mustache +3 -1
- data/test/test_bank_transfers.rb +1 -1
- data/test/test_item.rb +0 -9
- data/test/test_payment_initiation.rb +1 -1
- data/test/test_processor.rb +1 -16
- metadata +293 -24
- data/pkg/plaid-14.2.0.gem +0 -0
data/lib/plaid/api/plaid_api.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2020-09-14_1.
|
6
|
+
The version of the OpenAPI document: 2020-09-14_1.20.6
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.1.0
|
@@ -410,7 +410,7 @@ module Plaid
|
|
410
410
|
end
|
411
411
|
|
412
412
|
# Create an Asset Report
|
413
|
-
# The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
|
413
|
+
# The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
|
414
414
|
# @param asset_report_create_request [AssetReportCreateRequest]
|
415
415
|
# @param [Hash] opts the optional parameters
|
416
416
|
# @return [AssetReportCreateResponse]
|
@@ -420,7 +420,7 @@ module Plaid
|
|
420
420
|
end
|
421
421
|
|
422
422
|
# Create an Asset Report
|
423
|
-
# The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
|
423
|
+
# The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#Assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
|
424
424
|
# @param asset_report_create_request [AssetReportCreateRequest]
|
425
425
|
# @param [Hash] opts the optional parameters
|
426
426
|
# @return [Array<(AssetReportCreateResponse, Integer, Hash)>] AssetReportCreateResponse data, response status code and response headers
|
@@ -475,7 +475,7 @@ module Plaid
|
|
475
475
|
end
|
476
476
|
|
477
477
|
# Filter Asset Report
|
478
|
-
# By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Select
|
478
|
+
# By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
|
479
479
|
# @param asset_report_filter_request [AssetReportFilterRequest]
|
480
480
|
# @param [Hash] opts the optional parameters
|
481
481
|
# @return [AssetReportFilterResponse]
|
@@ -485,7 +485,7 @@ module Plaid
|
|
485
485
|
end
|
486
486
|
|
487
487
|
# Filter Asset Report
|
488
|
-
# By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Select
|
488
|
+
# By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
|
489
489
|
# @param asset_report_filter_request [AssetReportFilterRequest]
|
490
490
|
# @param [Hash] opts the optional parameters
|
491
491
|
# @return [Array<(AssetReportFilterResponse, Integer, Hash)>] AssetReportFilterResponse data, response status code and response headers
|
@@ -540,7 +540,7 @@ module Plaid
|
|
540
540
|
end
|
541
541
|
|
542
542
|
# Retrieve an Asset Report
|
543
|
-
# The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
|
543
|
+
# The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
|
544
544
|
# @param asset_report_get_request [AssetReportGetRequest]
|
545
545
|
# @param [Hash] opts the optional parameters
|
546
546
|
# @return [AssetReportGetResponse]
|
@@ -550,7 +550,7 @@ module Plaid
|
|
550
550
|
end
|
551
551
|
|
552
552
|
# Retrieve an Asset Report
|
553
|
-
# The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
|
553
|
+
# The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
|
554
554
|
# @param asset_report_get_request [AssetReportGetRequest]
|
555
555
|
# @param [Hash] opts the optional parameters
|
556
556
|
# @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
|
@@ -605,7 +605,7 @@ module Plaid
|
|
605
605
|
end
|
606
606
|
|
607
607
|
# Retrieve a PDF Asset Report
|
608
|
-
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report
|
608
|
+
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
|
609
609
|
# @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
|
610
610
|
# @param [Hash] opts the optional parameters
|
611
611
|
# @return [File]
|
@@ -615,7 +615,7 @@ module Plaid
|
|
615
615
|
end
|
616
616
|
|
617
617
|
# Retrieve a PDF Asset Report
|
618
|
-
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report
|
618
|
+
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
|
619
619
|
# @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
|
620
620
|
# @param [Hash] opts the optional parameters
|
621
621
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
@@ -800,7 +800,7 @@ module Plaid
|
|
800
800
|
end
|
801
801
|
|
802
802
|
# Retrieve auth data
|
803
|
-
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
|
803
|
+
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
|
804
804
|
# @param auth_get_request [AuthGetRequest]
|
805
805
|
# @param [Hash] opts the optional parameters
|
806
806
|
# @return [AuthGetResponse]
|
@@ -810,7 +810,7 @@ module Plaid
|
|
810
810
|
end
|
811
811
|
|
812
812
|
# Retrieve auth data
|
813
|
-
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
|
813
|
+
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
|
814
814
|
# @param auth_get_request [AuthGetRequest]
|
815
815
|
# @param [Hash] opts the optional parameters
|
816
816
|
# @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
|
@@ -1514,7 +1514,7 @@ module Plaid
|
|
1514
1514
|
return data, status_code, headers
|
1515
1515
|
end
|
1516
1516
|
|
1517
|
-
# Create a deposit switch
|
1517
|
+
# Create a deposit switch without using Plaid Exchange
|
1518
1518
|
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
1519
1519
|
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
1520
1520
|
# @param [Hash] opts the optional parameters
|
@@ -1524,7 +1524,7 @@ module Plaid
|
|
1524
1524
|
data
|
1525
1525
|
end
|
1526
1526
|
|
1527
|
-
# Create a deposit switch
|
1527
|
+
# Create a deposit switch without using Plaid Exchange
|
1528
1528
|
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
1529
1529
|
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
1530
1530
|
# @param [Hash] opts the optional parameters
|
@@ -1775,7 +1775,7 @@ module Plaid
|
|
1775
1775
|
end
|
1776
1776
|
|
1777
1777
|
# Search employer database
|
1778
|
-
# `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the
|
1778
|
+
# `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
|
1779
1779
|
# @param employers_search_request [EmployersSearchRequest]
|
1780
1780
|
# @param [Hash] opts the optional parameters
|
1781
1781
|
# @return [EmployersSearchResponse]
|
@@ -1785,7 +1785,7 @@ module Plaid
|
|
1785
1785
|
end
|
1786
1786
|
|
1787
1787
|
# Search employer database
|
1788
|
-
# `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the
|
1788
|
+
# `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
|
1789
1789
|
# @param employers_search_request [EmployersSearchRequest]
|
1790
1790
|
# @param [Hash] opts the optional parameters
|
1791
1791
|
# @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
|
@@ -1905,7 +1905,7 @@ module Plaid
|
|
1905
1905
|
end
|
1906
1906
|
|
1907
1907
|
# Create an income verification instance
|
1908
|
-
# `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to
|
1908
|
+
# `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
|
1909
1909
|
# @param income_verification_create_request [IncomeVerificationCreateRequest]
|
1910
1910
|
# @param [Hash] opts the optional parameters
|
1911
1911
|
# @return [IncomeVerificationCreateResponse]
|
@@ -1915,7 +1915,7 @@ module Plaid
|
|
1915
1915
|
end
|
1916
1916
|
|
1917
1917
|
# Create an income verification instance
|
1918
|
-
# `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to
|
1918
|
+
# `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
|
1919
1919
|
# @param income_verification_create_request [IncomeVerificationCreateRequest]
|
1920
1920
|
# @param [Hash] opts the optional parameters
|
1921
1921
|
# @return [Array<(IncomeVerificationCreateResponse, Integer, Hash)>] IncomeVerificationCreateResponse data, response status code and response headers
|
@@ -1970,7 +1970,7 @@ module Plaid
|
|
1970
1970
|
end
|
1971
1971
|
|
1972
1972
|
# Download the original documents used for income verification
|
1973
|
-
# `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
1973
|
+
# `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id` is returned in the `Plaid-Request-ID` header. For Payroll Income, the most recent file available for download with the payroll provider will also be available from this endpoint.
|
1974
1974
|
# @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
|
1975
1975
|
# @param [Hash] opts the optional parameters
|
1976
1976
|
# @return [File]
|
@@ -1980,7 +1980,7 @@ module Plaid
|
|
1980
1980
|
end
|
1981
1981
|
|
1982
1982
|
# Download the original documents used for income verification
|
1983
|
-
# `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
1983
|
+
# `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id` is returned in the `Plaid-Request-ID` header. For Payroll Income, the most recent file available for download with the payroll provider will also be available from this endpoint.
|
1984
1984
|
# @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
|
1985
1985
|
# @param [Hash] opts the optional parameters
|
1986
1986
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
@@ -2034,31 +2034,31 @@ module Plaid
|
|
2034
2034
|
return data, status_code, headers
|
2035
2035
|
end
|
2036
2036
|
|
2037
|
-
# Retrieve information from the
|
2038
|
-
# `/income/verification/
|
2039
|
-
# @param
|
2037
|
+
# Retrieve information from the paystubs used for income verification
|
2038
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
2039
|
+
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
2040
2040
|
# @param [Hash] opts the optional parameters
|
2041
|
-
# @return [
|
2042
|
-
def
|
2043
|
-
data, _status_code, _headers =
|
2041
|
+
# @return [IncomeVerificationPaystubsGetResponse]
|
2042
|
+
def income_verification_paystubs_get(income_verification_paystubs_get_request, opts = {})
|
2043
|
+
data, _status_code, _headers = income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts)
|
2044
2044
|
data
|
2045
2045
|
end
|
2046
2046
|
|
2047
|
-
# Retrieve information from the
|
2048
|
-
# `/income/verification/
|
2049
|
-
# @param
|
2047
|
+
# Retrieve information from the paystubs used for income verification
|
2048
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
2049
|
+
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
2050
2050
|
# @param [Hash] opts the optional parameters
|
2051
|
-
# @return [Array<(
|
2052
|
-
def
|
2051
|
+
# @return [Array<(IncomeVerificationPaystubsGetResponse, Integer, Hash)>] IncomeVerificationPaystubsGetResponse data, response status code and response headers
|
2052
|
+
def income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts = {})
|
2053
2053
|
if @api_client.config.debugging
|
2054
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
2054
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystubs_get ...'
|
2055
2055
|
end
|
2056
|
-
# verify the required parameter '
|
2057
|
-
if @api_client.config.client_side_validation &&
|
2058
|
-
fail ArgumentError, "Missing the required parameter '
|
2056
|
+
# verify the required parameter 'income_verification_paystubs_get_request' is set
|
2057
|
+
if @api_client.config.client_side_validation && income_verification_paystubs_get_request.nil?
|
2058
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_paystubs_get_request' when calling PlaidApi.income_verification_paystubs_get"
|
2059
2059
|
end
|
2060
2060
|
# resource path
|
2061
|
-
local_var_path = '/income/verification/
|
2061
|
+
local_var_path = '/income/verification/paystubs/get'
|
2062
2062
|
|
2063
2063
|
# query parameters
|
2064
2064
|
query_params = opts[:query_params] || {}
|
@@ -2074,16 +2074,16 @@ module Plaid
|
|
2074
2074
|
form_params = opts[:form_params] || {}
|
2075
2075
|
|
2076
2076
|
# http body (model)
|
2077
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2077
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystubs_get_request)
|
2078
2078
|
|
2079
2079
|
# return_type
|
2080
|
-
return_type = opts[:debug_return_type] || '
|
2080
|
+
return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubsGetResponse'
|
2081
2081
|
|
2082
2082
|
# auth_names
|
2083
2083
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2084
2084
|
|
2085
2085
|
new_options = opts.merge(
|
2086
|
-
:operation => :"PlaidApi.
|
2086
|
+
:operation => :"PlaidApi.income_verification_paystubs_get",
|
2087
2087
|
:header_params => header_params,
|
2088
2088
|
:query_params => query_params,
|
2089
2089
|
:form_params => form_params,
|
@@ -2094,7 +2094,72 @@ module Plaid
|
|
2094
2094
|
|
2095
2095
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2096
2096
|
if @api_client.config.debugging
|
2097
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
2097
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_paystubs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2098
|
+
end
|
2099
|
+
return data, status_code, headers
|
2100
|
+
end
|
2101
|
+
|
2102
|
+
# Refresh an income verification
|
2103
|
+
# `/income/verification/refresh` refreshes a given income verification.
|
2104
|
+
# @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
|
2105
|
+
# @param [Hash] opts the optional parameters
|
2106
|
+
# @return [IncomeVerificationRefreshResponse]
|
2107
|
+
def income_verification_refresh(income_verification_refresh_request, opts = {})
|
2108
|
+
data, _status_code, _headers = income_verification_refresh_with_http_info(income_verification_refresh_request, opts)
|
2109
|
+
data
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# Refresh an income verification
|
2113
|
+
# `/income/verification/refresh` refreshes a given income verification.
|
2114
|
+
# @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
|
2115
|
+
# @param [Hash] opts the optional parameters
|
2116
|
+
# @return [Array<(IncomeVerificationRefreshResponse, Integer, Hash)>] IncomeVerificationRefreshResponse data, response status code and response headers
|
2117
|
+
def income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {})
|
2118
|
+
if @api_client.config.debugging
|
2119
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_refresh ...'
|
2120
|
+
end
|
2121
|
+
# verify the required parameter 'income_verification_refresh_request' is set
|
2122
|
+
if @api_client.config.client_side_validation && income_verification_refresh_request.nil?
|
2123
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
|
2124
|
+
end
|
2125
|
+
# resource path
|
2126
|
+
local_var_path = '/income/verification/refresh'
|
2127
|
+
|
2128
|
+
# query parameters
|
2129
|
+
query_params = opts[:query_params] || {}
|
2130
|
+
|
2131
|
+
# header parameters
|
2132
|
+
header_params = opts[:header_params] || {}
|
2133
|
+
# HTTP header 'Accept' (if needed)
|
2134
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2135
|
+
# HTTP header 'Content-Type'
|
2136
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2137
|
+
|
2138
|
+
# form parameters
|
2139
|
+
form_params = opts[:form_params] || {}
|
2140
|
+
|
2141
|
+
# http body (model)
|
2142
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
|
2143
|
+
|
2144
|
+
# return_type
|
2145
|
+
return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
|
2146
|
+
|
2147
|
+
# auth_names
|
2148
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2149
|
+
|
2150
|
+
new_options = opts.merge(
|
2151
|
+
:operation => :"PlaidApi.income_verification_refresh",
|
2152
|
+
:header_params => header_params,
|
2153
|
+
:query_params => query_params,
|
2154
|
+
:form_params => form_params,
|
2155
|
+
:body => post_body,
|
2156
|
+
:auth_names => auth_names,
|
2157
|
+
:return_type => return_type
|
2158
|
+
)
|
2159
|
+
|
2160
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2161
|
+
if @api_client.config.debugging
|
2162
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2098
2163
|
end
|
2099
2164
|
return data, status_code, headers
|
2100
2165
|
end
|
@@ -2165,7 +2230,7 @@ module Plaid
|
|
2165
2230
|
end
|
2166
2231
|
|
2167
2232
|
# Get details of all supported institutions
|
2168
|
-
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
|
2233
|
+
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
|
2169
2234
|
# @param institutions_get_request [InstitutionsGetRequest]
|
2170
2235
|
# @param [Hash] opts the optional parameters
|
2171
2236
|
# @return [InstitutionsGetResponse]
|
@@ -2175,7 +2240,7 @@ module Plaid
|
|
2175
2240
|
end
|
2176
2241
|
|
2177
2242
|
# Get details of all supported institutions
|
2178
|
-
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
|
2243
|
+
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call. This data changes frequently. If you store it locally on your system, be sure to update it regularly.
|
2179
2244
|
# @param institutions_get_request [InstitutionsGetRequest]
|
2180
2245
|
# @param [Hash] opts the optional parameters
|
2181
2246
|
# @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
|
@@ -2554,8 +2619,138 @@ module Plaid
|
|
2554
2619
|
return data, status_code, headers
|
2555
2620
|
end
|
2556
2621
|
|
2622
|
+
# List a user’s connected applications
|
2623
|
+
# List a user’s connected applications
|
2624
|
+
# @param item_application_list_request [ItemApplicationListRequest]
|
2625
|
+
# @param [Hash] opts the optional parameters
|
2626
|
+
# @return [ItemApplicationListResponse]
|
2627
|
+
def item_application_list(item_application_list_request, opts = {})
|
2628
|
+
data, _status_code, _headers = item_application_list_with_http_info(item_application_list_request, opts)
|
2629
|
+
data
|
2630
|
+
end
|
2631
|
+
|
2632
|
+
# List a user’s connected applications
|
2633
|
+
# List a user’s connected applications
|
2634
|
+
# @param item_application_list_request [ItemApplicationListRequest]
|
2635
|
+
# @param [Hash] opts the optional parameters
|
2636
|
+
# @return [Array<(ItemApplicationListResponse, Integer, Hash)>] ItemApplicationListResponse data, response status code and response headers
|
2637
|
+
def item_application_list_with_http_info(item_application_list_request, opts = {})
|
2638
|
+
if @api_client.config.debugging
|
2639
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_application_list ...'
|
2640
|
+
end
|
2641
|
+
# verify the required parameter 'item_application_list_request' is set
|
2642
|
+
if @api_client.config.client_side_validation && item_application_list_request.nil?
|
2643
|
+
fail ArgumentError, "Missing the required parameter 'item_application_list_request' when calling PlaidApi.item_application_list"
|
2644
|
+
end
|
2645
|
+
# resource path
|
2646
|
+
local_var_path = '/item/application/list'
|
2647
|
+
|
2648
|
+
# query parameters
|
2649
|
+
query_params = opts[:query_params] || {}
|
2650
|
+
|
2651
|
+
# header parameters
|
2652
|
+
header_params = opts[:header_params] || {}
|
2653
|
+
# HTTP header 'Accept' (if needed)
|
2654
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2655
|
+
# HTTP header 'Content-Type'
|
2656
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2657
|
+
|
2658
|
+
# form parameters
|
2659
|
+
form_params = opts[:form_params] || {}
|
2660
|
+
|
2661
|
+
# http body (model)
|
2662
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_list_request)
|
2663
|
+
|
2664
|
+
# return_type
|
2665
|
+
return_type = opts[:debug_return_type] || 'ItemApplicationListResponse'
|
2666
|
+
|
2667
|
+
# auth_names
|
2668
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2669
|
+
|
2670
|
+
new_options = opts.merge(
|
2671
|
+
:operation => :"PlaidApi.item_application_list",
|
2672
|
+
:header_params => header_params,
|
2673
|
+
:query_params => query_params,
|
2674
|
+
:form_params => form_params,
|
2675
|
+
:body => post_body,
|
2676
|
+
:auth_names => auth_names,
|
2677
|
+
:return_type => return_type
|
2678
|
+
)
|
2679
|
+
|
2680
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2681
|
+
if @api_client.config.debugging
|
2682
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_application_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2683
|
+
end
|
2684
|
+
return data, status_code, headers
|
2685
|
+
end
|
2686
|
+
|
2687
|
+
# Update the scopes of access for a particular application
|
2688
|
+
# Enable consumers to update product access on selected accounts for an application.
|
2689
|
+
# @param item_application_scopes_update_request [ItemApplicationScopesUpdateRequest]
|
2690
|
+
# @param [Hash] opts the optional parameters
|
2691
|
+
# @return [ItemApplicationScopesUpdateResponse]
|
2692
|
+
def item_application_scopes_update(item_application_scopes_update_request, opts = {})
|
2693
|
+
data, _status_code, _headers = item_application_scopes_update_with_http_info(item_application_scopes_update_request, opts)
|
2694
|
+
data
|
2695
|
+
end
|
2696
|
+
|
2697
|
+
# Update the scopes of access for a particular application
|
2698
|
+
# Enable consumers to update product access on selected accounts for an application.
|
2699
|
+
# @param item_application_scopes_update_request [ItemApplicationScopesUpdateRequest]
|
2700
|
+
# @param [Hash] opts the optional parameters
|
2701
|
+
# @return [Array<(ItemApplicationScopesUpdateResponse, Integer, Hash)>] ItemApplicationScopesUpdateResponse data, response status code and response headers
|
2702
|
+
def item_application_scopes_update_with_http_info(item_application_scopes_update_request, opts = {})
|
2703
|
+
if @api_client.config.debugging
|
2704
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_application_scopes_update ...'
|
2705
|
+
end
|
2706
|
+
# verify the required parameter 'item_application_scopes_update_request' is set
|
2707
|
+
if @api_client.config.client_side_validation && item_application_scopes_update_request.nil?
|
2708
|
+
fail ArgumentError, "Missing the required parameter 'item_application_scopes_update_request' when calling PlaidApi.item_application_scopes_update"
|
2709
|
+
end
|
2710
|
+
# resource path
|
2711
|
+
local_var_path = '/item/application/scopes/update'
|
2712
|
+
|
2713
|
+
# query parameters
|
2714
|
+
query_params = opts[:query_params] || {}
|
2715
|
+
|
2716
|
+
# header parameters
|
2717
|
+
header_params = opts[:header_params] || {}
|
2718
|
+
# HTTP header 'Accept' (if needed)
|
2719
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2720
|
+
# HTTP header 'Content-Type'
|
2721
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2722
|
+
|
2723
|
+
# form parameters
|
2724
|
+
form_params = opts[:form_params] || {}
|
2725
|
+
|
2726
|
+
# http body (model)
|
2727
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_scopes_update_request)
|
2728
|
+
|
2729
|
+
# return_type
|
2730
|
+
return_type = opts[:debug_return_type] || 'ItemApplicationScopesUpdateResponse'
|
2731
|
+
|
2732
|
+
# auth_names
|
2733
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2734
|
+
|
2735
|
+
new_options = opts.merge(
|
2736
|
+
:operation => :"PlaidApi.item_application_scopes_update",
|
2737
|
+
:header_params => header_params,
|
2738
|
+
:query_params => query_params,
|
2739
|
+
:form_params => form_params,
|
2740
|
+
:body => post_body,
|
2741
|
+
:auth_names => auth_names,
|
2742
|
+
:return_type => return_type
|
2743
|
+
)
|
2744
|
+
|
2745
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2746
|
+
if @api_client.config.debugging
|
2747
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_application_scopes_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2748
|
+
end
|
2749
|
+
return data, status_code, headers
|
2750
|
+
end
|
2751
|
+
|
2557
2752
|
# Create public token
|
2558
|
-
# Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](/docs/quickstart) for more information.
|
2753
|
+
# Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
|
2559
2754
|
# @param item_public_token_create_request [ItemPublicTokenCreateRequest]
|
2560
2755
|
# @param [Hash] opts the optional parameters
|
2561
2756
|
# @return [ItemPublicTokenCreateResponse]
|
@@ -2565,7 +2760,7 @@ module Plaid
|
|
2565
2760
|
end
|
2566
2761
|
|
2567
2762
|
# Create public token
|
2568
|
-
# Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](/docs/quickstart) for more information.
|
2763
|
+
# Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
|
2569
2764
|
# @param item_public_token_create_request [ItemPublicTokenCreateRequest]
|
2570
2765
|
# @param [Hash] opts the optional parameters
|
2571
2766
|
# @return [Array<(ItemPublicTokenCreateResponse, Integer, Hash)>] ItemPublicTokenCreateResponse data, response status code and response headers
|
@@ -2880,7 +3075,7 @@ module Plaid
|
|
2880
3075
|
end
|
2881
3076
|
|
2882
3077
|
# Update Webhook URL
|
2883
|
-
# The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
|
3078
|
+
# The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
|
2884
3079
|
# @param item_webhook_update_request [ItemWebhookUpdateRequest]
|
2885
3080
|
# @param [Hash] opts the optional parameters
|
2886
3081
|
# @return [ItemWebhookUpdateResponse]
|
@@ -2890,7 +3085,7 @@ module Plaid
|
|
2890
3085
|
end
|
2891
3086
|
|
2892
3087
|
# Update Webhook URL
|
2893
|
-
# The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
|
3088
|
+
# The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
|
2894
3089
|
# @param item_webhook_update_request [ItemWebhookUpdateRequest]
|
2895
3090
|
# @param [Hash] opts the optional parameters
|
2896
3091
|
# @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
|
@@ -2945,7 +3140,7 @@ module Plaid
|
|
2945
3140
|
end
|
2946
3141
|
|
2947
3142
|
# Retrieve Liabilities data
|
2948
|
-
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `
|
3143
|
+
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
|
2949
3144
|
# @param liabilities_get_request [LiabilitiesGetRequest]
|
2950
3145
|
# @param [Hash] opts the optional parameters
|
2951
3146
|
# @return [LiabilitiesGetResponse]
|
@@ -2955,7 +3150,7 @@ module Plaid
|
|
2955
3150
|
end
|
2956
3151
|
|
2957
3152
|
# Retrieve Liabilities data
|
2958
|
-
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `
|
3153
|
+
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
|
2959
3154
|
# @param liabilities_get_request [LiabilitiesGetRequest]
|
2960
3155
|
# @param [Hash] opts the optional parameters
|
2961
3156
|
# @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
|
@@ -3140,7 +3335,7 @@ module Plaid
|
|
3140
3335
|
end
|
3141
3336
|
|
3142
3337
|
# Create a payment
|
3143
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments
|
3338
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
|
3144
3339
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
3145
3340
|
# @param [Hash] opts the optional parameters
|
3146
3341
|
# @return [PaymentInitiationPaymentCreateResponse]
|
@@ -3150,7 +3345,7 @@ module Plaid
|
|
3150
3345
|
end
|
3151
3346
|
|
3152
3347
|
# Create a payment
|
3153
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments
|
3348
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
|
3154
3349
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
3155
3350
|
# @param [Hash] opts the optional parameters
|
3156
3351
|
# @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
|
@@ -3724,6 +3919,71 @@ module Plaid
|
|
3724
3919
|
return data, status_code, headers
|
3725
3920
|
end
|
3726
3921
|
|
3922
|
+
# Create a bank transfer as a processor
|
3923
|
+
# Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
|
3924
|
+
# @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
|
3925
|
+
# @param [Hash] opts the optional parameters
|
3926
|
+
# @return [ProcessorBankTransferCreateResponse]
|
3927
|
+
def processor_bank_transfer_create(processor_bank_transfer_create_request, opts = {})
|
3928
|
+
data, _status_code, _headers = processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts)
|
3929
|
+
data
|
3930
|
+
end
|
3931
|
+
|
3932
|
+
# Create a bank transfer as a processor
|
3933
|
+
# Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
|
3934
|
+
# @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
|
3935
|
+
# @param [Hash] opts the optional parameters
|
3936
|
+
# @return [Array<(ProcessorBankTransferCreateResponse, Integer, Hash)>] ProcessorBankTransferCreateResponse data, response status code and response headers
|
3937
|
+
def processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts = {})
|
3938
|
+
if @api_client.config.debugging
|
3939
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_bank_transfer_create ...'
|
3940
|
+
end
|
3941
|
+
# verify the required parameter 'processor_bank_transfer_create_request' is set
|
3942
|
+
if @api_client.config.client_side_validation && processor_bank_transfer_create_request.nil?
|
3943
|
+
fail ArgumentError, "Missing the required parameter 'processor_bank_transfer_create_request' when calling PlaidApi.processor_bank_transfer_create"
|
3944
|
+
end
|
3945
|
+
# resource path
|
3946
|
+
local_var_path = '/processor/bank_transfer/create'
|
3947
|
+
|
3948
|
+
# query parameters
|
3949
|
+
query_params = opts[:query_params] || {}
|
3950
|
+
|
3951
|
+
# header parameters
|
3952
|
+
header_params = opts[:header_params] || {}
|
3953
|
+
# HTTP header 'Accept' (if needed)
|
3954
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3955
|
+
# HTTP header 'Content-Type'
|
3956
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3957
|
+
|
3958
|
+
# form parameters
|
3959
|
+
form_params = opts[:form_params] || {}
|
3960
|
+
|
3961
|
+
# http body (model)
|
3962
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_bank_transfer_create_request)
|
3963
|
+
|
3964
|
+
# return_type
|
3965
|
+
return_type = opts[:debug_return_type] || 'ProcessorBankTransferCreateResponse'
|
3966
|
+
|
3967
|
+
# auth_names
|
3968
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3969
|
+
|
3970
|
+
new_options = opts.merge(
|
3971
|
+
:operation => :"PlaidApi.processor_bank_transfer_create",
|
3972
|
+
:header_params => header_params,
|
3973
|
+
:query_params => query_params,
|
3974
|
+
:form_params => form_params,
|
3975
|
+
:body => post_body,
|
3976
|
+
:auth_names => auth_names,
|
3977
|
+
:return_type => return_type
|
3978
|
+
)
|
3979
|
+
|
3980
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3981
|
+
if @api_client.config.debugging
|
3982
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_bank_transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3983
|
+
end
|
3984
|
+
return data, status_code, headers
|
3985
|
+
end
|
3986
|
+
|
3727
3987
|
# Retrieve Identity data
|
3728
3988
|
# The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
|
3729
3989
|
# @param processor_identity_get_request [ProcessorIdentityGetRequest]
|
@@ -4049,6 +4309,71 @@ module Plaid
|
|
4049
4309
|
return data, status_code, headers
|
4050
4310
|
end
|
4051
4311
|
|
4312
|
+
# Manually fire an Income webhook
|
4313
|
+
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
|
4314
|
+
# @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
|
4315
|
+
# @param [Hash] opts the optional parameters
|
4316
|
+
# @return [SandboxIncomeFireWebhookResponse]
|
4317
|
+
def sandbox_income_fire_webhook(sandbox_income_fire_webhook_request, opts = {})
|
4318
|
+
data, _status_code, _headers = sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts)
|
4319
|
+
data
|
4320
|
+
end
|
4321
|
+
|
4322
|
+
# Manually fire an Income webhook
|
4323
|
+
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
|
4324
|
+
# @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
|
4325
|
+
# @param [Hash] opts the optional parameters
|
4326
|
+
# @return [Array<(SandboxIncomeFireWebhookResponse, Integer, Hash)>] SandboxIncomeFireWebhookResponse data, response status code and response headers
|
4327
|
+
def sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts = {})
|
4328
|
+
if @api_client.config.debugging
|
4329
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_income_fire_webhook ...'
|
4330
|
+
end
|
4331
|
+
# verify the required parameter 'sandbox_income_fire_webhook_request' is set
|
4332
|
+
if @api_client.config.client_side_validation && sandbox_income_fire_webhook_request.nil?
|
4333
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_income_fire_webhook_request' when calling PlaidApi.sandbox_income_fire_webhook"
|
4334
|
+
end
|
4335
|
+
# resource path
|
4336
|
+
local_var_path = '/sandbox/income/fire_webhook'
|
4337
|
+
|
4338
|
+
# query parameters
|
4339
|
+
query_params = opts[:query_params] || {}
|
4340
|
+
|
4341
|
+
# header parameters
|
4342
|
+
header_params = opts[:header_params] || {}
|
4343
|
+
# HTTP header 'Accept' (if needed)
|
4344
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4345
|
+
# HTTP header 'Content-Type'
|
4346
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4347
|
+
|
4348
|
+
# form parameters
|
4349
|
+
form_params = opts[:form_params] || {}
|
4350
|
+
|
4351
|
+
# http body (model)
|
4352
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_income_fire_webhook_request)
|
4353
|
+
|
4354
|
+
# return_type
|
4355
|
+
return_type = opts[:debug_return_type] || 'SandboxIncomeFireWebhookResponse'
|
4356
|
+
|
4357
|
+
# auth_names
|
4358
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4359
|
+
|
4360
|
+
new_options = opts.merge(
|
4361
|
+
:operation => :"PlaidApi.sandbox_income_fire_webhook",
|
4362
|
+
:header_params => header_params,
|
4363
|
+
:query_params => query_params,
|
4364
|
+
:form_params => form_params,
|
4365
|
+
:body => post_body,
|
4366
|
+
:auth_names => auth_names,
|
4367
|
+
:return_type => return_type
|
4368
|
+
)
|
4369
|
+
|
4370
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4371
|
+
if @api_client.config.debugging
|
4372
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_income_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4373
|
+
end
|
4374
|
+
return data, status_code, headers
|
4375
|
+
end
|
4376
|
+
|
4052
4377
|
# Fire a test webhook
|
4053
4378
|
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions `DEFAULT_UPDATE` webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.
|
4054
4379
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
@@ -4115,7 +4440,7 @@ module Plaid
|
|
4115
4440
|
end
|
4116
4441
|
|
4117
4442
|
# Force a Sandbox Item into an error state
|
4118
|
-
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
4443
|
+
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
4119
4444
|
# @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
|
4120
4445
|
# @param [Hash] opts the optional parameters
|
4121
4446
|
# @return [SandboxItemResetLoginResponse]
|
@@ -4125,7 +4450,7 @@ module Plaid
|
|
4125
4450
|
end
|
4126
4451
|
|
4127
4452
|
# Force a Sandbox Item into an error state
|
4128
|
-
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
4453
|
+
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
4129
4454
|
# @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
|
4130
4455
|
# @param [Hash] opts the optional parameters
|
4131
4456
|
# @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
|
@@ -4180,7 +4505,7 @@ module Plaid
|
|
4180
4505
|
end
|
4181
4506
|
|
4182
4507
|
# Set verification status for Sandbox account
|
4183
|
-
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](/docs/auth/coverage/testing#).
|
4508
|
+
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
|
4184
4509
|
# @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
|
4185
4510
|
# @param [Hash] opts the optional parameters
|
4186
4511
|
# @return [SandboxItemSetVerificationStatusResponse]
|
@@ -4190,7 +4515,7 @@ module Plaid
|
|
4190
4515
|
end
|
4191
4516
|
|
4192
4517
|
# Set verification status for Sandbox account
|
4193
|
-
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](/docs/auth/coverage/testing#).
|
4518
|
+
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
|
4194
4519
|
# @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
|
4195
4520
|
# @param [Hash] opts the optional parameters
|
4196
4521
|
# @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
|
@@ -4244,8 +4569,71 @@ module Plaid
|
|
4244
4569
|
return data, status_code, headers
|
4245
4570
|
end
|
4246
4571
|
|
4572
|
+
# Save the selected accounts when connecting to the Platypus Oauth institution
|
4573
|
+
# @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
|
4574
|
+
# @param [Hash] opts the optional parameters
|
4575
|
+
# @return [Object]
|
4576
|
+
def sandbox_oauth_select_accounts(sandbox_oauth_select_accounts_request, opts = {})
|
4577
|
+
data, _status_code, _headers = sandbox_oauth_select_accounts_with_http_info(sandbox_oauth_select_accounts_request, opts)
|
4578
|
+
data
|
4579
|
+
end
|
4580
|
+
|
4581
|
+
# Save the selected accounts when connecting to the Platypus Oauth institution
|
4582
|
+
# @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
|
4583
|
+
# @param [Hash] opts the optional parameters
|
4584
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
4585
|
+
def sandbox_oauth_select_accounts_with_http_info(sandbox_oauth_select_accounts_request, opts = {})
|
4586
|
+
if @api_client.config.debugging
|
4587
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_oauth_select_accounts ...'
|
4588
|
+
end
|
4589
|
+
# verify the required parameter 'sandbox_oauth_select_accounts_request' is set
|
4590
|
+
if @api_client.config.client_side_validation && sandbox_oauth_select_accounts_request.nil?
|
4591
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_oauth_select_accounts_request' when calling PlaidApi.sandbox_oauth_select_accounts"
|
4592
|
+
end
|
4593
|
+
# resource path
|
4594
|
+
local_var_path = '/sandbox/oauth/select_accounts'
|
4595
|
+
|
4596
|
+
# query parameters
|
4597
|
+
query_params = opts[:query_params] || {}
|
4598
|
+
|
4599
|
+
# header parameters
|
4600
|
+
header_params = opts[:header_params] || {}
|
4601
|
+
# HTTP header 'Accept' (if needed)
|
4602
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4603
|
+
# HTTP header 'Content-Type'
|
4604
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4605
|
+
|
4606
|
+
# form parameters
|
4607
|
+
form_params = opts[:form_params] || {}
|
4608
|
+
|
4609
|
+
# http body (model)
|
4610
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_oauth_select_accounts_request)
|
4611
|
+
|
4612
|
+
# return_type
|
4613
|
+
return_type = opts[:debug_return_type] || 'Object'
|
4614
|
+
|
4615
|
+
# auth_names
|
4616
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4617
|
+
|
4618
|
+
new_options = opts.merge(
|
4619
|
+
:operation => :"PlaidApi.sandbox_oauth_select_accounts",
|
4620
|
+
:header_params => header_params,
|
4621
|
+
:query_params => query_params,
|
4622
|
+
:form_params => form_params,
|
4623
|
+
:body => post_body,
|
4624
|
+
:auth_names => auth_names,
|
4625
|
+
:return_type => return_type
|
4626
|
+
)
|
4627
|
+
|
4628
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4629
|
+
if @api_client.config.debugging
|
4630
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_oauth_select_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4631
|
+
end
|
4632
|
+
return data, status_code, headers
|
4633
|
+
end
|
4634
|
+
|
4247
4635
|
# Create a test Item and processor token
|
4248
|
-
# Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](/docs/sandbox/user-custom) to generate a test account with custom data.
|
4636
|
+
# Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
|
4249
4637
|
# @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
|
4250
4638
|
# @param [Hash] opts the optional parameters
|
4251
4639
|
# @return [SandboxProcessorTokenCreateResponse]
|
@@ -4255,7 +4643,7 @@ module Plaid
|
|
4255
4643
|
end
|
4256
4644
|
|
4257
4645
|
# Create a test Item and processor token
|
4258
|
-
# Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](/docs/sandbox/user-custom) to generate a test account with custom data.
|
4646
|
+
# Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
|
4259
4647
|
# @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
|
4260
4648
|
# @param [Hash] opts the optional parameters
|
4261
4649
|
# @return [Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>] SandboxProcessorTokenCreateResponse data, response status code and response headers
|
@@ -4310,7 +4698,7 @@ module Plaid
|
|
4310
4698
|
end
|
4311
4699
|
|
4312
4700
|
# Create a test Item
|
4313
|
-
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](/docs/sandbox/user-custom) to generate a test account with custom data.
|
4701
|
+
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
|
4314
4702
|
# @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
|
4315
4703
|
# @param [Hash] opts the optional parameters
|
4316
4704
|
# @return [SandboxPublicTokenCreateResponse]
|
@@ -4320,7 +4708,7 @@ module Plaid
|
|
4320
4708
|
end
|
4321
4709
|
|
4322
4710
|
# Create a test Item
|
4323
|
-
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](/docs/sandbox/user-custom) to generate a test account with custom data.
|
4711
|
+
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
|
4324
4712
|
# @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
|
4325
4713
|
# @param [Hash] opts the optional parameters
|
4326
4714
|
# @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
|
@@ -4374,8 +4762,203 @@ module Plaid
|
|
4374
4762
|
return data, status_code, headers
|
4375
4763
|
end
|
4376
4764
|
|
4765
|
+
# Report whether you initiated an ACH transaction
|
4766
|
+
# After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
|
4767
|
+
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
4768
|
+
# @param [Hash] opts the optional parameters
|
4769
|
+
# @return [SignalDecisionReportResponse]
|
4770
|
+
def signal_decision_report(signal_decision_report_request, opts = {})
|
4771
|
+
data, _status_code, _headers = signal_decision_report_with_http_info(signal_decision_report_request, opts)
|
4772
|
+
data
|
4773
|
+
end
|
4774
|
+
|
4775
|
+
# Report whether you initiated an ACH transaction
|
4776
|
+
# After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
|
4777
|
+
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
4778
|
+
# @param [Hash] opts the optional parameters
|
4779
|
+
# @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
|
4780
|
+
def signal_decision_report_with_http_info(signal_decision_report_request, opts = {})
|
4781
|
+
if @api_client.config.debugging
|
4782
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.signal_decision_report ...'
|
4783
|
+
end
|
4784
|
+
# verify the required parameter 'signal_decision_report_request' is set
|
4785
|
+
if @api_client.config.client_side_validation && signal_decision_report_request.nil?
|
4786
|
+
fail ArgumentError, "Missing the required parameter 'signal_decision_report_request' when calling PlaidApi.signal_decision_report"
|
4787
|
+
end
|
4788
|
+
# resource path
|
4789
|
+
local_var_path = '/signal/decision/report'
|
4790
|
+
|
4791
|
+
# query parameters
|
4792
|
+
query_params = opts[:query_params] || {}
|
4793
|
+
|
4794
|
+
# header parameters
|
4795
|
+
header_params = opts[:header_params] || {}
|
4796
|
+
# HTTP header 'Accept' (if needed)
|
4797
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4798
|
+
# HTTP header 'Content-Type'
|
4799
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4800
|
+
|
4801
|
+
# form parameters
|
4802
|
+
form_params = opts[:form_params] || {}
|
4803
|
+
|
4804
|
+
# http body (model)
|
4805
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_decision_report_request)
|
4806
|
+
|
4807
|
+
# return_type
|
4808
|
+
return_type = opts[:debug_return_type] || 'SignalDecisionReportResponse'
|
4809
|
+
|
4810
|
+
# auth_names
|
4811
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4812
|
+
|
4813
|
+
new_options = opts.merge(
|
4814
|
+
:operation => :"PlaidApi.signal_decision_report",
|
4815
|
+
:header_params => header_params,
|
4816
|
+
:query_params => query_params,
|
4817
|
+
:form_params => form_params,
|
4818
|
+
:body => post_body,
|
4819
|
+
:auth_names => auth_names,
|
4820
|
+
:return_type => return_type
|
4821
|
+
)
|
4822
|
+
|
4823
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4824
|
+
if @api_client.config.debugging
|
4825
|
+
@api_client.config.logger.debug "API called: PlaidApi#signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4826
|
+
end
|
4827
|
+
return data, status_code, headers
|
4828
|
+
end
|
4829
|
+
|
4830
|
+
# Evaluate a planned ACH transaction
|
4831
|
+
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause.
|
4832
|
+
# @param request_body [Hash<String, Object>]
|
4833
|
+
# @param [Hash] opts the optional parameters
|
4834
|
+
# @return [SignalEvaluateResponse]
|
4835
|
+
def signal_evaluate(request_body, opts = {})
|
4836
|
+
data, _status_code, _headers = signal_evaluate_with_http_info(request_body, opts)
|
4837
|
+
data
|
4838
|
+
end
|
4839
|
+
|
4840
|
+
# Evaluate a planned ACH transaction
|
4841
|
+
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause.
|
4842
|
+
# @param request_body [Hash<String, Object>]
|
4843
|
+
# @param [Hash] opts the optional parameters
|
4844
|
+
# @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
|
4845
|
+
def signal_evaluate_with_http_info(request_body, opts = {})
|
4846
|
+
if @api_client.config.debugging
|
4847
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.signal_evaluate ...'
|
4848
|
+
end
|
4849
|
+
# verify the required parameter 'request_body' is set
|
4850
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
4851
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.signal_evaluate"
|
4852
|
+
end
|
4853
|
+
# resource path
|
4854
|
+
local_var_path = '/signal/evaluate'
|
4855
|
+
|
4856
|
+
# query parameters
|
4857
|
+
query_params = opts[:query_params] || {}
|
4858
|
+
|
4859
|
+
# header parameters
|
4860
|
+
header_params = opts[:header_params] || {}
|
4861
|
+
# HTTP header 'Accept' (if needed)
|
4862
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4863
|
+
# HTTP header 'Content-Type'
|
4864
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4865
|
+
|
4866
|
+
# form parameters
|
4867
|
+
form_params = opts[:form_params] || {}
|
4868
|
+
|
4869
|
+
# http body (model)
|
4870
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
4871
|
+
|
4872
|
+
# return_type
|
4873
|
+
return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'
|
4874
|
+
|
4875
|
+
# auth_names
|
4876
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4877
|
+
|
4878
|
+
new_options = opts.merge(
|
4879
|
+
:operation => :"PlaidApi.signal_evaluate",
|
4880
|
+
:header_params => header_params,
|
4881
|
+
:query_params => query_params,
|
4882
|
+
:form_params => form_params,
|
4883
|
+
:body => post_body,
|
4884
|
+
:auth_names => auth_names,
|
4885
|
+
:return_type => return_type
|
4886
|
+
)
|
4887
|
+
|
4888
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4889
|
+
if @api_client.config.debugging
|
4890
|
+
@api_client.config.logger.debug "API called: PlaidApi#signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4891
|
+
end
|
4892
|
+
return data, status_code, headers
|
4893
|
+
end
|
4894
|
+
|
4895
|
+
# Report a return for an ACH transaction
|
4896
|
+
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
4897
|
+
# @param signal_return_report_request [SignalReturnReportRequest]
|
4898
|
+
# @param [Hash] opts the optional parameters
|
4899
|
+
# @return [SignalReturnReportResponse]
|
4900
|
+
def signal_return_report(signal_return_report_request, opts = {})
|
4901
|
+
data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
|
4902
|
+
data
|
4903
|
+
end
|
4904
|
+
|
4905
|
+
# Report a return for an ACH transaction
|
4906
|
+
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
4907
|
+
# @param signal_return_report_request [SignalReturnReportRequest]
|
4908
|
+
# @param [Hash] opts the optional parameters
|
4909
|
+
# @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
|
4910
|
+
def signal_return_report_with_http_info(signal_return_report_request, opts = {})
|
4911
|
+
if @api_client.config.debugging
|
4912
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
|
4913
|
+
end
|
4914
|
+
# verify the required parameter 'signal_return_report_request' is set
|
4915
|
+
if @api_client.config.client_side_validation && signal_return_report_request.nil?
|
4916
|
+
fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
|
4917
|
+
end
|
4918
|
+
# resource path
|
4919
|
+
local_var_path = '/signal/return/report'
|
4920
|
+
|
4921
|
+
# query parameters
|
4922
|
+
query_params = opts[:query_params] || {}
|
4923
|
+
|
4924
|
+
# header parameters
|
4925
|
+
header_params = opts[:header_params] || {}
|
4926
|
+
# HTTP header 'Accept' (if needed)
|
4927
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4928
|
+
# HTTP header 'Content-Type'
|
4929
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4930
|
+
|
4931
|
+
# form parameters
|
4932
|
+
form_params = opts[:form_params] || {}
|
4933
|
+
|
4934
|
+
# http body (model)
|
4935
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
|
4936
|
+
|
4937
|
+
# return_type
|
4938
|
+
return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
|
4939
|
+
|
4940
|
+
# auth_names
|
4941
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4942
|
+
|
4943
|
+
new_options = opts.merge(
|
4944
|
+
:operation => :"PlaidApi.signal_return_report",
|
4945
|
+
:header_params => header_params,
|
4946
|
+
:query_params => query_params,
|
4947
|
+
:form_params => form_params,
|
4948
|
+
:body => post_body,
|
4949
|
+
:auth_names => auth_names,
|
4950
|
+
:return_type => return_type
|
4951
|
+
)
|
4952
|
+
|
4953
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4954
|
+
if @api_client.config.debugging
|
4955
|
+
@api_client.config.logger.debug "API called: PlaidApi#signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4956
|
+
end
|
4957
|
+
return data, status_code, headers
|
4958
|
+
end
|
4959
|
+
|
4377
4960
|
# Get transaction data
|
4378
|
-
# The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (
|
4961
|
+
# The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
|
4379
4962
|
# @param transactions_get_request [TransactionsGetRequest]
|
4380
4963
|
# @param [Hash] opts the optional parameters
|
4381
4964
|
# @return [TransactionsGetResponse]
|
@@ -4385,7 +4968,7 @@ module Plaid
|
|
4385
4968
|
end
|
4386
4969
|
|
4387
4970
|
# Get transaction data
|
4388
|
-
# The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (
|
4971
|
+
# The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
|
4389
4972
|
# @param transactions_get_request [TransactionsGetRequest]
|
4390
4973
|
# @param [Hash] opts the optional parameters
|
4391
4974
|
# @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
|
@@ -4440,7 +5023,7 @@ module Plaid
|
|
4440
5023
|
end
|
4441
5024
|
|
4442
5025
|
# Refresh transaction data
|
4443
|
-
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
5026
|
+
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
4444
5027
|
# @param transactions_refresh_request [TransactionsRefreshRequest]
|
4445
5028
|
# @param [Hash] opts the optional parameters
|
4446
5029
|
# @return [TransactionsRefreshResponse]
|
@@ -4450,7 +5033,7 @@ module Plaid
|
|
4450
5033
|
end
|
4451
5034
|
|
4452
5035
|
# Refresh transaction data
|
4453
|
-
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
5036
|
+
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
4454
5037
|
# @param transactions_refresh_request [TransactionsRefreshRequest]
|
4455
5038
|
# @param [Hash] opts the optional parameters
|
4456
5039
|
# @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
|