docs/PlaidApi.md in plaid-14.0.0.beta.3 vs docs/PlaidApi.md in plaid-14.0.0.beta.4

- old
+ new

@@ -61,10 +61,11 @@ | [**processor_auth_get**](PlaidApi.md#processor_auth_get) | **POST** /processor/auth/get | Retrieve Auth data | | [**processor_balance_get**](PlaidApi.md#processor_balance_get) | **POST** /processor/balance/get | Retrieve Balance data | | [**processor_identity_get**](PlaidApi.md#processor_identity_get) | **POST** /processor/identity/get | Retrieve Identity data | | [**processor_stripe_bank_account_token_create**](PlaidApi.md#processor_stripe_bank_account_token_create) | **POST** /processor/stripe/bank_account_token/create | Create Stripe bank account token | | [**processor_token_create**](PlaidApi.md#processor_token_create) | **POST** /processor/token/create | Create processor token | +| [**sandbox_bank_transfer_fire_webhook**](PlaidApi.md#sandbox_bank_transfer_fire_webhook) | **POST** /sandbox/bank_transfer/fire_webhook | Manually fire a Bank Transfer webhook | | [**sandbox_bank_transfer_simulate**](PlaidApi.md#sandbox_bank_transfer_simulate) | **POST** /sandbox/bank_transfer/simulate | Simulate a bank transfer event in Sandbox | | [**sandbox_item_fire_webhook**](PlaidApi.md#sandbox_item_fire_webhook) | **POST** /sandbox/item/fire_webhook | Fire a test webhook | | [**sandbox_item_reset_login**](PlaidApi.md#sandbox_item_reset_login) | **POST** /sandbox/item/reset_login | Force a Sandbox Item into an error state | | [**sandbox_item_set_verification_status**](PlaidApi.md#sandbox_item_set_verification_status) | **POST** /sandbox/item/set_verification_status | Set verification status for Sandbox account | | [**sandbox_processor_token_create**](PlaidApi.md#sandbox_processor_token_create) | **POST** /sandbox/processor_token/create | Create a test Item and processor token | @@ -88,23 +89,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new accounts_balance_get_request = Plaid::AccountsBalanceGetRequest.new({access_token: 'access_token_example'}) # AccountsBalanceGetRequest | @@ -159,33 +160,33 @@ > <AccountsGetResponse> accounts_get(accounts_get_request) Retrieve accounts -The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. +The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. ### Examples ```ruby require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new accounts_get_request = Plaid::AccountsGetRequest.new({access_token: 'access_token_example'}) # AccountsGetRequest | @@ -250,23 +251,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_audit_copy_create_request = Plaid::AssetReportAuditCopyCreateRequest.new({asset_report_token: 'asset_report_token_example', auditor_id: 'auditor_id_example'}) # AssetReportAuditCopyCreateRequest | @@ -331,23 +332,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_audit_copy_get_request = Plaid::AssetReportAuditCopyGetRequest.new({audit_copy_token: 'audit_copy_token_example'}) # AssetReportAuditCopyGetRequest | @@ -412,23 +413,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_audit_copy_remove_request = Plaid::AssetReportAuditCopyRemoveRequest.new({audit_copy_token: 'audit_copy_token_example'}) # AssetReportAuditCopyRemoveRequest | @@ -493,23 +494,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_create_request = Plaid::AssetReportCreateRequest.new({access_tokens: ['access_tokens_example'], days_requested: 37}) # AssetReportCreateRequest | @@ -574,23 +575,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_filter_request = Plaid::AssetReportFilterRequest.new({asset_report_token: 'asset_report_token_example', account_ids_to_exclude: ['account_ids_to_exclude_example']}) # AssetReportFilterRequest | @@ -655,23 +656,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_get_request = Plaid::AssetReportGetRequest.new({asset_report_token: 'asset_report_token_example'}) # AssetReportGetRequest | @@ -736,23 +737,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_pdf_get_request = Plaid::AssetReportPDFGetRequest.new({asset_report_token: 'asset_report_token_example'}) # AssetReportPDFGetRequest | @@ -817,23 +818,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_refresh_request = Plaid::AssetReportRefreshRequest.new({asset_report_token: 'asset_report_token_example'}) # AssetReportRefreshRequest | @@ -898,23 +899,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new asset_report_remove_request = Plaid::AssetReportRemoveRequest.new({asset_report_token: 'asset_report_token_example'}) # AssetReportRemoveRequest | @@ -979,23 +980,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new auth_get_request = Plaid::AuthGetRequest.new({access_token: 'access_token_example'}) # AuthGetRequest | @@ -1060,23 +1061,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_balance_get_request = Plaid::BankTransferBalanceGetRequest.new # BankTransferBalanceGetRequest | @@ -1141,23 +1142,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_cancel_request = Plaid::BankTransferCancelRequest.new({bank_transfer_id: 'bank_transfer_id_example'}) # BankTransferCancelRequest | @@ -1222,23 +1223,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_create_request = Plaid::BankTransferCreateRequest.new({idempotency_key: 'idempotency_key_example', access_token: 'access_token_example', account_id: 'account_id_example', type: Plaid::BankTransferType::DEBIT, network: Plaid::BankTransferNetwork::ACH, amount: 'amount_example', iso_currency_code: 'iso_currency_code_example', description: 'description_example', user: Plaid::BankTransferUser.new({legal_name: 'legal_name_example'})}) # BankTransferCreateRequest | @@ -1303,23 +1304,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_event_list_request = Plaid::BankTransferEventListRequest.new # BankTransferEventListRequest | @@ -1384,23 +1385,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_event_sync_request = Plaid::BankTransferEventSyncRequest.new({after_id: 37}) # BankTransferEventSyncRequest | @@ -1465,23 +1466,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_get_request = Plaid::BankTransferGetRequest.new({bank_transfer_id: 'bank_transfer_id_example'}) # BankTransferGetRequest | @@ -1546,23 +1547,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_list_request = Plaid::BankTransferListRequest.new # BankTransferListRequest | @@ -1627,23 +1628,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new bank_transfer_migrate_account_request = Plaid::BankTransferMigrateAccountRequest.new({account_number: 'account_number_example', routing_number: 'routing_number_example', account_type: 'account_type_example'}) # BankTransferMigrateAccountRequest | @@ -1772,23 +1773,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new payment_initiation_payment_token_create_request = Plaid::PaymentInitiationPaymentTokenCreateRequest.new({payment_id: 'payment_id_example'}) # PaymentInitiationPaymentTokenCreateRequest | @@ -1839,11 +1840,11 @@ - **Accept**: application/json ## deposit_switch_alt_create -> <DepositSwitchAltCreateResponse> deposit_switch_alt_create(opts) +> <DepositSwitchAltCreateResponse> deposit_switch_alt_create(deposit_switch_alt_create_request) Create a deposit switch when not using Plaid Exchange.' This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch. @@ -1853,49 +1854,47 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new -opts = { - deposit_switch_alt_create_request: Plaid::DepositSwitchAltCreateRequest.new({target_account: Plaid::DepositSwitchTargetAccount.new({account_number: 'account_number_example', routing_number: 'routing_number_example', account_name: 'account_name_example', account_subtype: 'checking'}), target_user: Plaid::DepositSwitchTargetUser.new({given_name: 'given_name_example', family_name: 'family_name_example', phone: 'phone_example', email: 'email_example'})}) # DepositSwitchAltCreateRequest | -} +deposit_switch_alt_create_request = Plaid::DepositSwitchAltCreateRequest.new({target_account: Plaid::DepositSwitchTargetAccount.new({account_number: 'account_number_example', routing_number: 'routing_number_example', account_name: 'account_name_example', account_subtype: 'checking'}), target_user: Plaid::DepositSwitchTargetUser.new({given_name: 'given_name_example', family_name: 'family_name_example', phone: 'phone_example', email: 'email_example'})}) # DepositSwitchAltCreateRequest | begin # Create a deposit switch when not using Plaid Exchange.' - result = api_instance.deposit_switch_alt_create(opts) + result = api_instance.deposit_switch_alt_create(deposit_switch_alt_create_request) p result rescue Plaid::ApiError => e puts "Error when calling PlaidApi->deposit_switch_alt_create: #{e}" end ``` #### Using the deposit_switch_alt_create_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<DepositSwitchAltCreateResponse>, Integer, Hash)> deposit_switch_alt_create_with_http_info(opts) +> <Array(<DepositSwitchAltCreateResponse>, Integer, Hash)> deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request) ```ruby begin # Create a deposit switch when not using Plaid Exchange.' - data, status_code, headers = api_instance.deposit_switch_alt_create_with_http_info(opts) + data, status_code, headers = api_instance.deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request) p status_code # => 2xx p headers # => { ... } p data # => <DepositSwitchAltCreateResponse> rescue Plaid::ApiError => e puts "Error when calling PlaidApi->deposit_switch_alt_create_with_http_info: #{e}" @@ -1904,11 +1903,11 @@ ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **deposit_switch_alt_create_request** | [**DepositSwitchAltCreateRequest**](DepositSwitchAltCreateRequest.md) | | [optional] | +| **deposit_switch_alt_create_request** | [**DepositSwitchAltCreateRequest**](DepositSwitchAltCreateRequest.md) | | | ### Return type [**DepositSwitchAltCreateResponse**](DepositSwitchAltCreateResponse.md) @@ -1936,23 +1935,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new deposit_switch_create_request = Plaid::DepositSwitchCreateRequest.new({target_access_token: 'target_access_token_example', target_account_id: 'target_account_id_example'}) # DepositSwitchCreateRequest | @@ -2017,23 +2016,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new deposit_switch_get_request = Plaid::DepositSwitchGetRequest.new({deposit_switch_id: 'deposit_switch_id_example'}) # DepositSwitchGetRequest | @@ -2098,23 +2097,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new deposit_switch_token_create_request = Plaid::DepositSwitchTokenCreateRequest.new({deposit_switch_id: 'deposit_switch_id_example'}) # DepositSwitchTokenCreateRequest | @@ -2179,23 +2178,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new opts = { employers_search_request: Plaid::EmployersSearchRequest.new({query: 'query_example', products: ['products_example']}) # EmployersSearchRequest | @@ -2262,23 +2261,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new identity_get_request = Plaid::IdentityGetRequest.new({access_token: 'access_token_example'}) # IdentityGetRequest | @@ -2343,23 +2342,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new opts = { income_verification_documents_download_request: Plaid::IncomeVerificationDocumentsDownloadRequest.new({income_verification_id: 'income_verification_id_example'}) # IncomeVerificationDocumentsDownloadRequest | @@ -2426,23 +2425,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new opts = { income_verification_paystub_get_request: Plaid::IncomeVerificationPaystubGetRequest.new({income_verification_id: 'income_verification_id_example'}) # IncomeVerificationPaystubGetRequest | @@ -2509,23 +2508,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new opts = { income_verification_summary_get_request: Plaid::IncomeVerificationSummaryGetRequest.new({income_verification_id: 'income_verification_id_example'}) # IncomeVerificationSummaryGetRequest | @@ -2592,23 +2591,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new institutions_get_request = Plaid::InstitutionsGetRequest.new({count: 37, offset: 37, country_codes: [Plaid::CountryCode::US]}) # InstitutionsGetRequest | @@ -2673,23 +2672,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new institutions_get_by_id_request = Plaid::InstitutionsGetByIdRequest.new({institution_id: 'institution_id_example', country_codes: [Plaid::CountryCode::US]}) # InstitutionsGetByIdRequest | @@ -2754,23 +2753,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new institutions_search_request = Plaid::InstitutionsSearchRequest.new({query: 'query_example', products: [Plaid::Products::ASSETS], country_codes: [Plaid::CountryCode::US]}) # InstitutionsSearchRequest | @@ -2835,23 +2834,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new investments_holdings_get_request = Plaid::InvestmentsHoldingsGetRequest.new({access_token: 'access_token_example'}) # InvestmentsHoldingsGetRequest | @@ -2916,23 +2915,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new investments_transactions_get_request = Plaid::InvestmentsTransactionsGetRequest.new({access_token: 'access_token_example', start_date: Date.today, end_date: Date.today}) # InvestmentsTransactionsGetRequest | @@ -2997,23 +2996,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new item_access_token_invalidate_request = Plaid::ItemAccessTokenInvalidateRequest.new({access_token: 'access_token_example'}) # ItemAccessTokenInvalidateRequest | @@ -3078,23 +3077,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new item_public_token_create_request = Plaid::ItemPublicTokenCreateRequest.new({access_token: 'access_token_example'}) # ItemPublicTokenCreateRequest | @@ -3159,23 +3158,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new item_get_request = Plaid::ItemGetRequest.new({access_token: 'access_token_example'}) # ItemGetRequest | @@ -3240,23 +3239,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new item_import_request = Plaid::ItemImportRequest.new({products: [Plaid::Products::ASSETS], user_auth: Plaid::ItemImportRequestUserAuth.new({user_id: 'user_id_example', auth_token: 'auth_token_example'})}) # ItemImportRequest | @@ -3321,23 +3320,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new item_public_token_exchange_request = Plaid::ItemPublicTokenExchangeRequest.new({public_token: 'public_token_example'}) # ItemPublicTokenExchangeRequest | @@ -3402,23 +3401,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new item_remove_request = Plaid::ItemRemoveRequest.new({access_token: 'access_token_example'}) # ItemRemoveRequest | @@ -3483,23 +3482,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new item_webhook_update_request = Plaid::ItemWebhookUpdateRequest.new({access_token: 'access_token_example', webhook: 'webhook_example'}) # ItemWebhookUpdateRequest | @@ -3564,23 +3563,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new liabilities_get_request = Plaid::LiabilitiesGetRequest.new({access_token: 'access_token_example'}) # LiabilitiesGetRequest | @@ -3645,23 +3644,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new link_token_create_request = Plaid::LinkTokenCreateRequest.new({client_name: 'client_name_example', language: 'language_example', country_codes: [Plaid::CountryCode::US], user: Plaid::LinkTokenCreateRequestUser.new({client_user_id: 'client_user_id_example'})}) # LinkTokenCreateRequest | @@ -3726,23 +3725,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new link_token_get_request = Plaid::LinkTokenGetRequest.new({link_token: 'link_token_example'}) # LinkTokenGetRequest | @@ -3807,23 +3806,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new payment_initiation_payment_create_request = Plaid::PaymentInitiationPaymentCreateRequest.new({recipient_id: 'recipient_id_example', reference: 'reference_example', amount: Plaid::Amount.new({currency: 'GBP', value: 3.56})}) # PaymentInitiationPaymentCreateRequest | @@ -3888,23 +3887,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new payment_initiation_payment_get_request = Plaid::PaymentInitiationPaymentGetRequest.new({payment_id: 'payment_id_example'}) # PaymentInitiationPaymentGetRequest | @@ -3969,23 +3968,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new payment_initiation_payment_list_request = Plaid::PaymentInitiationPaymentListRequest.new # PaymentInitiationPaymentListRequest | @@ -4050,23 +4049,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new payment_initiation_recipient_create_request = Plaid::PaymentInitiationRecipientCreateRequest.new({name: 'name_example'}) # PaymentInitiationRecipientCreateRequest | @@ -4131,23 +4130,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new payment_initiation_recipient_get_request = Plaid::PaymentInitiationRecipientGetRequest.new({recipient_id: 'recipient_id_example'}) # PaymentInitiationRecipientGetRequest | @@ -4212,23 +4211,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new payment_initiation_recipient_list_request = Plaid::PaymentInitiationRecipientListRequest.new # PaymentInitiationRecipientListRequest | @@ -4293,23 +4292,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new opts = { income_verification_create_request: Plaid::IncomeVerificationCreateRequest.new({webhook: 'webhook_example'}) # IncomeVerificationCreateRequest | @@ -4376,23 +4375,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new processor_apex_processor_token_create_request = Plaid::ProcessorApexProcessorTokenCreateRequest.new({access_token: 'access_token_example', account_id: 'account_id_example'}) # ProcessorApexProcessorTokenCreateRequest | @@ -4457,23 +4456,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new processor_auth_get_request = Plaid::ProcessorAuthGetRequest.new({processor_token: 'processor_token_example'}) # ProcessorAuthGetRequest | @@ -4538,23 +4537,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new processor_balance_get_request = Plaid::ProcessorBalanceGetRequest.new({processor_token: 'processor_token_example'}) # ProcessorBalanceGetRequest | The `/processor/balance/get` endpoint returns the real-time balance for the account associated with a given `processor_token`. The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account. Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of `null`. @@ -4619,23 +4618,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new processor_identity_get_request = Plaid::ProcessorIdentityGetRequest.new({processor_token: 'processor_token_example'}) # ProcessorIdentityGetRequest | @@ -4700,23 +4699,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new processor_stripe_bank_account_token_create_request = Plaid::ProcessorStripeBankAccountTokenCreateRequest.new({access_token: 'access_token_example', account_id: 'account_id_example'}) # ProcessorStripeBankAccountTokenCreateRequest | @@ -4781,23 +4780,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new processor_token_create_request = Plaid::ProcessorTokenCreateRequest.new({access_token: 'access_token_example', account_id: 'account_id_example', processor: 'processor_example'}) # ProcessorTokenCreateRequest | @@ -4846,10 +4845,91 @@ - **Content-Type**: application/json - **Accept**: application/json +## sandbox_bank_transfer_fire_webhook + +> <SandboxBankTransferFireWebhookResponse> sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request) + +Manually fire a Bank Transfer webhook + +Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment. + +### Examples + +```ruby +require 'time' +require 'plaid' +# setup authorization +Plaid.configure do |config| + # Configure API key authorization: clientId + config.api_key['clientId'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + # config.api_key_prefix['clientId'] = 'Bearer' + + # Configure API key authorization: plaidVersion + config.api_key['plaidVersion'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + # config.api_key_prefix['plaidVersion'] = 'Bearer' + + # Configure API key authorization: secret + config.api_key['secret'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + # config.api_key_prefix['secret'] = 'Bearer' +end + +api_instance = Plaid::PlaidApi.new +sandbox_bank_transfer_fire_webhook_request = Plaid::SandboxBankTransferFireWebhookRequest.new({webhook: 'webhook_example'}) # SandboxBankTransferFireWebhookRequest | + +begin + # Manually fire a Bank Transfer webhook + result = api_instance.sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request) + p result +rescue Plaid::ApiError => e + puts "Error when calling PlaidApi->sandbox_bank_transfer_fire_webhook: #{e}" +end +``` + +#### Using the sandbox_bank_transfer_fire_webhook_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<SandboxBankTransferFireWebhookResponse>, Integer, Hash)> sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request) + +```ruby +begin + # Manually fire a Bank Transfer webhook + data, status_code, headers = api_instance.sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request) + p status_code # => 2xx + p headers # => { ... } + p data # => <SandboxBankTransferFireWebhookResponse> +rescue Plaid::ApiError => e + puts "Error when calling PlaidApi->sandbox_bank_transfer_fire_webhook_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **sandbox_bank_transfer_fire_webhook_request** | [**SandboxBankTransferFireWebhookRequest**](SandboxBankTransferFireWebhookRequest.md) | | | + +### Return type + +[**SandboxBankTransferFireWebhookResponse**](SandboxBankTransferFireWebhookResponse.md) + +### Authorization + +[clientId](../README.md#clientId), [plaidVersion](../README.md#plaidVersion), [secret](../README.md#secret) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + ## sandbox_bank_transfer_simulate > <SandboxBankTransferSimulateResponse> sandbox_bank_transfer_simulate(sandbox_bank_transfer_simulate_request) Simulate a bank transfer event in Sandbox @@ -4862,23 +4942,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new sandbox_bank_transfer_simulate_request = Plaid::SandboxBankTransferSimulateRequest.new({bank_transfer_id: 'bank_transfer_id_example', event_type: 'event_type_example'}) # SandboxBankTransferSimulateRequest | @@ -4943,23 +5023,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new sandbox_item_fire_webhook_request = Plaid::SandboxItemFireWebhookRequest.new({access_token: 'access_token_example'}) # SandboxItemFireWebhookRequest | @@ -5024,23 +5104,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new sandbox_item_reset_login_request = Plaid::SandboxItemResetLoginRequest.new({access_token: 'access_token_example'}) # SandboxItemResetLoginRequest | @@ -5105,23 +5185,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new sandbox_item_set_verification_status_request = Plaid::SandboxItemSetVerificationStatusRequest.new({access_token: 'access_token_example', account_id: 'account_id_example', verification_status: 'automatically_verified'}) # SandboxItemSetVerificationStatusRequest | @@ -5186,23 +5266,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new opts = { sandbox_processor_token_create_request: Plaid::SandboxProcessorTokenCreateRequest.new({institution_id: 'institution_id_example'}) # SandboxProcessorTokenCreateRequest | @@ -5269,23 +5349,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new sandbox_public_token_create_request = Plaid::SandboxPublicTokenCreateRequest.new({institution_id: 'institution_id_example', initial_products: [Plaid::Products::ASSETS]}) # SandboxPublicTokenCreateRequest | @@ -5340,33 +5420,33 @@ > <TransactionsGetResponse> transactions_get(transactions_get_request) Get transaction data -The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/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](/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. 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`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/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. +The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/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](/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`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/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. ### Examples ```ruby require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new transactions_get_request = Plaid::TransactionsGetRequest.new({access_token: 'access_token_example', start_date: Date.today, end_date: Date.today}) # TransactionsGetRequest | @@ -5431,23 +5511,23 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new transactions_refresh_request = Plaid::TransactionsRefreshRequest.new({access_token: 'access_token_example'}) # TransactionsRefreshRequest | @@ -5512,22 +5592,22 @@ require 'time' require 'plaid' # setup authorization Plaid.configure do |config| # Configure API key authorization: clientId - config.api_key['PLAID-CLIENT-ID'] = 'YOUR API KEY' + config.api_key['clientId'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-CLIENT-ID'] = 'Bearer' + # config.api_key_prefix['clientId'] = 'Bearer' # Configure API key authorization: plaidVersion - config.api_key['Plaid-Version'] = 'YOUR API KEY' + config.api_key['plaidVersion'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['Plaid-Version'] = 'Bearer' + # config.api_key_prefix['plaidVersion'] = 'Bearer' # Configure API key authorization: secret - config.api_key['PLAID-SECRET'] = 'YOUR API KEY' + config.api_key['secret'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['PLAID-SECRET'] = 'Bearer' + # config.api_key_prefix['secret'] = 'Bearer' end api_instance = Plaid::PlaidApi.new webhook_verification_key_get_request = Plaid::WebhookVerificationKeyGetRequest.new({key_id: 'key_id_example'}) # WebhookVerificationKeyGetRequest |