class Plaid::PlaidApi
- Plaid::PlaidApi
- Reference
- Object
Defined in:
plaid/api/plaid_api.crConstructors
Instance Method Summary
-
#accounts_balance_get(*, accounts_balance_get_request : Plaid::AccountsBalanceGetRequest | Nil = nil) : AccountsGetResponse
Retrieve real-time balance data The
/accounts/balance/get
endpoint returns the real-time balance for each of an Item's accounts. -
#accounts_balance_get(*, accounts_balance_get_request : Plaid::AccountsBalanceGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve real-time balance data The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts.
-
#accounts_balance_get_with_http_info(*, accounts_balance_get_request : Plaid::AccountsBalanceGetRequest | Nil = nil) : Tuple(AccountsGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve real-time balance data The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts.
-
#accounts_get(*, accounts_get_request : Plaid::AccountsGetRequest | Nil = nil) : AccountsGetResponse
Retrieve accounts The
/accounts/get
endpoint can be used to retrieve a list of accounts associated with any linked Item. -
#accounts_get(*, accounts_get_request : Plaid::AccountsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve accounts The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item.
-
#accounts_get_with_http_info(*, accounts_get_request : Plaid::AccountsGetRequest | Nil = nil) : Tuple(AccountsGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve accounts The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item.
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#application_get(*, application_get_request : Plaid::ApplicationGetRequest | Nil = nil) : ApplicationGetResponse
Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences @required @param application_get_request [Plaid::ApplicationGetRequest?] @return [ApplicationGetResponse]
-
#application_get(*, application_get_request : Plaid::ApplicationGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences @required @param application_get_request [Plaid::ApplicationGetRequest?] @return nil
-
#application_get_with_http_info(*, application_get_request : Plaid::ApplicationGetRequest | Nil = nil) : Tuple(ApplicationGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences @required @param application_get_request [Plaid::ApplicationGetRequest?] @return [Tuple(ApplicationGetResponse, Integer, Hash)] ApplicationGetResponse, response status code and response headers
-
#asset_report_audit_copy_create(*, asset_report_audit_copy_create_request : Plaid::AssetReportAuditCopyCreateRequest | Nil = nil) : AssetReportAuditCopyCreateResponse
Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf.
-
#asset_report_audit_copy_create(*, asset_report_audit_copy_create_request : Plaid::AssetReportAuditCopyCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf.
-
#asset_report_audit_copy_create_with_http_info(*, asset_report_audit_copy_create_request : Plaid::AssetReportAuditCopyCreateRequest | Nil = nil) : Tuple(AssetReportAuditCopyCreateResponse, Int32, Hash(String, Array(String) | String))
Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf.
-
#asset_report_audit_copy_get(*, asset_report_audit_copy_get_request : Plaid::AssetReportAuditCopyGetRequest | Nil = nil) : AssetReportGetResponse
Retrieve an Asset Report Audit Copy
/asset_report/audit_copy/get
allows auditors to get a copy of an Asset Report that was previously shared via the/asset_report/audit_copy/create
endpoint. -
#asset_report_audit_copy_get(*, asset_report_audit_copy_get_request : Plaid::AssetReportAuditCopyGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve an Asset Report Audit Copy `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint.
-
#asset_report_audit_copy_get_with_http_info(*, asset_report_audit_copy_get_request : Plaid::AssetReportAuditCopyGetRequest | Nil = nil) : Tuple(AssetReportGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve an Asset Report Audit Copy `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint.
-
#asset_report_audit_copy_remove(*, asset_report_audit_copy_remove_request : Plaid::AssetReportAuditCopyRemoveRequest | Nil = nil) : AssetReportAuditCopyRemoveResponse
Remove Asset Report Audit Copy The
/asset_report/audit_copy/remove
endpoint allows you to remove an Audit Copy. -
#asset_report_audit_copy_remove(*, asset_report_audit_copy_remove_request : Plaid::AssetReportAuditCopyRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Remove Asset Report Audit Copy The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy.
-
#asset_report_audit_copy_remove_with_http_info(*, asset_report_audit_copy_remove_request : Plaid::AssetReportAuditCopyRemoveRequest | Nil = nil) : Tuple(AssetReportAuditCopyRemoveResponse, Int32, Hash(String, Array(String) | String))
Remove Asset Report Audit Copy The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy.
-
#asset_report_create(*, asset_report_create_request : Plaid::AssetReportCreateRequest | Nil = nil) : AssetReportCreateResponse
Create an Asset Report The
/asset_report/create
endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing theasset_report_token
return value to the/asset_report/get
or/asset_report/pdf/get
endpoints. -
#asset_report_create(*, asset_report_create_request : Plaid::AssetReportCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create an Asset Report The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints.
-
#asset_report_create_with_http_info(*, asset_report_create_request : Plaid::AssetReportCreateRequest | Nil = nil) : Tuple(AssetReportCreateResponse, Int32, Hash(String, Array(String) | String))
Create an Asset Report The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints.
-
#asset_report_filter(*, asset_report_filter_request : Plaid::AssetReportFilterRequest | Nil = nil) : AssetReportFilterResponse
Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item.
-
#asset_report_filter(*, asset_report_filter_request : Plaid::AssetReportFilterRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item.
-
#asset_report_filter_with_http_info(*, asset_report_filter_request : Plaid::AssetReportFilterRequest | Nil = nil) : Tuple(AssetReportFilterResponse, Int32, Hash(String, Array(String) | String))
Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item.
-
#asset_report_get(*, asset_report_get_request : Plaid::AssetReportGetRequest | Nil = nil) : AssetReportGetResponse
Retrieve an Asset Report The
/asset_report/get
endpoint retrieves the Asset Report in JSON format. -
#asset_report_get(*, asset_report_get_request : Plaid::AssetReportGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve an Asset Report The `/asset_report/get` endpoint retrieves the Asset Report in JSON format.
-
#asset_report_get_with_http_info(*, asset_report_get_request : Plaid::AssetReportGetRequest | Nil = nil) : Tuple(AssetReportGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve an Asset Report The `/asset_report/get` endpoint retrieves the Asset Report in JSON format.
-
#asset_report_pdf_get(*, asset_report_pdf_get_request : Plaid::AssetReportPDFGetRequest | Nil = nil) : File
Retrieve a PDF Asset Report The
/asset_report/pdf/get
endpoint retrieves the Asset Report in PDF format. -
#asset_report_pdf_get(*, asset_report_pdf_get_request : Plaid::AssetReportPDFGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a PDF Asset Report The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format.
-
#asset_report_pdf_get_with_http_info(*, asset_report_pdf_get_request : Plaid::AssetReportPDFGetRequest | Nil = nil) : Tuple(File, Int32, Hash(String, Array(String) | String))
Retrieve a PDF Asset Report The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format.
-
#asset_report_refresh(*, asset_report_refresh_request : Plaid::AssetReportRefreshRequest | Nil = nil) : AssetReportRefreshResponse
Refresh an Asset Report An Asset Report is an immutable snapshot of a user's assets.
-
#asset_report_refresh(*, asset_report_refresh_request : Plaid::AssetReportRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh an Asset Report An Asset Report is an immutable snapshot of a user's assets.
-
#asset_report_refresh_with_http_info(*, asset_report_refresh_request : Plaid::AssetReportRefreshRequest | Nil = nil) : Tuple(AssetReportRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh an Asset Report An Asset Report is an immutable snapshot of a user's assets.
-
#asset_report_remove(*, asset_report_remove_request : Plaid::AssetReportRemoveRequest | Nil = nil) : AssetReportRemoveResponse
Delete an Asset Report The
/item/remove
endpoint allows you to invalidate anaccess_token
, meaning you will not be able to create new Asset Reports with it. -
#asset_report_remove(*, asset_report_remove_request : Plaid::AssetReportRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Delete an Asset Report The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it.
-
#asset_report_remove_with_http_info(*, asset_report_remove_request : Plaid::AssetReportRemoveRequest | Nil = nil) : Tuple(AssetReportRemoveResponse, Int32, Hash(String, Array(String) | String))
Delete an Asset Report The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it.
-
#auth_get(*, auth_get_request : Plaid::AuthGetRequest | Nil = nil) : AuthGetResponse
Retrieve auth data The
/auth/get
endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. -
#auth_get(*, auth_get_request : Plaid::AuthGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve auth data The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.
-
#auth_get_with_http_info(*, auth_get_request : Plaid::AuthGetRequest | Nil = nil) : Tuple(AuthGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve auth data The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.
-
#bank_transfer_balance_get(*, bank_transfer_balance_get_request : Plaid::BankTransferBalanceGetRequest | Nil = nil) : BankTransferBalanceGetResponse
Get balance of your Bank Transfer account Use the
/bank_transfer/balance/get
endpoint to see the available balance in your bank transfer account. -
#bank_transfer_balance_get(*, bank_transfer_balance_get_request : Plaid::BankTransferBalanceGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get balance of your Bank Transfer account Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account.
-
#bank_transfer_balance_get_with_http_info(*, bank_transfer_balance_get_request : Plaid::BankTransferBalanceGetRequest | Nil = nil) : Tuple(BankTransferBalanceGetResponse, Int32, Hash(String, Array(String) | String))
Get balance of your Bank Transfer account Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account.
-
#bank_transfer_cancel(*, bank_transfer_cancel_request : Plaid::BankTransferCancelRequest | Nil = nil) : BankTransferCancelResponse
Cancel a bank transfer Use the
/bank_transfer/cancel
endpoint to cancel a bank transfer. -
#bank_transfer_cancel(*, bank_transfer_cancel_request : Plaid::BankTransferCancelRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Cancel a bank transfer Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer.
-
#bank_transfer_cancel_with_http_info(*, bank_transfer_cancel_request : Plaid::BankTransferCancelRequest | Nil = nil) : Tuple(BankTransferCancelResponse, Int32, Hash(String, Array(String) | String))
Cancel a bank transfer Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer.
-
#bank_transfer_create(*, bank_transfer_create_request : Plaid::BankTransferCreateRequest | Nil = nil) : BankTransferCreateResponse
Create a bank transfer Use the
/bank_transfer/create
endpoint to initiate a new bank transfer. -
#bank_transfer_create(*, bank_transfer_create_request : Plaid::BankTransferCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a bank transfer Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
-
#bank_transfer_create_with_http_info(*, bank_transfer_create_request : Plaid::BankTransferCreateRequest | Nil = nil) : Tuple(BankTransferCreateResponse, Int32, Hash(String, Array(String) | String))
Create a bank transfer Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
-
#bank_transfer_event_list(*, bank_transfer_event_list_request : Plaid::BankTransferEventListRequest | Nil = nil) : BankTransferEventListResponse
List bank transfer events Use the
/bank_transfer/event/list
endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. -
#bank_transfer_event_list(*, bank_transfer_event_list_request : Plaid::BankTransferEventListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List bank transfer events Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria.
-
#bank_transfer_event_list_with_http_info(*, bank_transfer_event_list_request : Plaid::BankTransferEventListRequest | Nil = nil) : Tuple(BankTransferEventListResponse, Int32, Hash(String, Array(String) | String))
List bank transfer events Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria.
-
#bank_transfer_event_sync(*, bank_transfer_event_sync_request : Plaid::BankTransferEventSyncRequest | Nil = nil) : BankTransferEventSyncResponse
Sync bank transfer events
/bank_transfer/event/sync
allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specificevent_id
. -
#bank_transfer_event_sync(*, bank_transfer_event_sync_request : Plaid::BankTransferEventSyncRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Sync bank transfer events `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`.
-
#bank_transfer_event_sync_with_http_info(*, bank_transfer_event_sync_request : Plaid::BankTransferEventSyncRequest | Nil = nil) : Tuple(BankTransferEventSyncResponse, Int32, Hash(String, Array(String) | String))
Sync bank transfer events `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`.
-
#bank_transfer_get(*, bank_transfer_get_request : Plaid::BankTransferGetRequest | Nil = nil) : BankTransferGetResponse
Retrieve a bank transfer The
/bank_transfer/get
fetches information about the bank transfer corresponding to the givenbank_transfer_id
. -
#bank_transfer_get(*, bank_transfer_get_request : Plaid::BankTransferGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a bank transfer The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
-
#bank_transfer_get_with_http_info(*, bank_transfer_get_request : Plaid::BankTransferGetRequest | Nil = nil) : Tuple(BankTransferGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a bank transfer The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
-
#bank_transfer_list(*, bank_transfer_list_request : Plaid::BankTransferListRequest | Nil = nil) : BankTransferListResponse
List bank transfers Use the
/bank_transfer/list
endpoint to see a list of all your bank transfers and their statuses. -
#bank_transfer_list(*, bank_transfer_list_request : Plaid::BankTransferListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List bank transfers Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses.
-
#bank_transfer_list_with_http_info(*, bank_transfer_list_request : Plaid::BankTransferListRequest | Nil = nil) : Tuple(BankTransferListResponse, Int32, Hash(String, Array(String) | String))
List bank transfers Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses.
-
#bank_transfer_migrate_account(*, bank_transfer_migrate_account_request : Plaid::BankTransferMigrateAccountRequest | Nil = nil) : BankTransferMigrateAccountResponse
Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the
/bank_transfer/migrate_account
endpoint to migrate known account and routing numbers to Plaid Items. -
#bank_transfer_migrate_account(*, bank_transfer_migrate_account_request : Plaid::BankTransferMigrateAccountRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items.
-
#bank_transfer_migrate_account_with_http_info(*, bank_transfer_migrate_account_request : Plaid::BankTransferMigrateAccountRequest | Nil = nil) : Tuple(BankTransferMigrateAccountResponse, Int32, Hash(String, Array(String) | String))
Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items.
-
#bank_transfer_sweep_get(*, bank_transfer_sweep_get_request : Plaid::BankTransferSweepGetRequest | Nil = nil) : BankTransferSweepGetResponse
Retrieve a sweep The
/bank_transfer/sweep/get
endpoint fetches information about the sweep corresponding to the givensweep_id
. -
#bank_transfer_sweep_get(*, bank_transfer_sweep_get_request : Plaid::BankTransferSweepGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a sweep The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
-
#bank_transfer_sweep_get_with_http_info(*, bank_transfer_sweep_get_request : Plaid::BankTransferSweepGetRequest | Nil = nil) : Tuple(BankTransferSweepGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a sweep The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
-
#bank_transfer_sweep_list(*, bank_transfer_sweep_list_request : Plaid::BankTransferSweepListRequest | Nil = nil) : BankTransferSweepListResponse
List sweeps The
/bank_transfer/sweep/list
endpoint fetches information about the sweeps matching the given filters. -
#bank_transfer_sweep_list(*, bank_transfer_sweep_list_request : Plaid::BankTransferSweepListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List sweeps The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
-
#bank_transfer_sweep_list_with_http_info(*, bank_transfer_sweep_list_request : Plaid::BankTransferSweepListRequest | Nil = nil) : Tuple(BankTransferSweepListResponse, Int32, Hash(String, Array(String) | String))
List sweeps The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
-
#base_report_get(*, base_report_get_request : Plaid::BaseReportGetRequest | Nil = nil) : BaseReportGetResponse
Retrieve a Base Report This endpoint allows the customer to retrieve a Base Report.
-
#base_report_get(*, base_report_get_request : Plaid::BaseReportGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a Base Report This endpoint allows the customer to retrieve a Base Report.
-
#base_report_get_with_http_info(*, base_report_get_request : Plaid::BaseReportGetRequest | Nil = nil) : Tuple(BaseReportGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a Base Report This endpoint allows the customer to retrieve a Base Report.
-
#beacon_report_create(*, beacon_report_create_request : Plaid::BeaconReportCreateRequest | Nil = nil) : BeaconReportCreateResponse
Create a Beacon Report Create a fraud report for a given Beacon User.
-
#beacon_report_create(*, beacon_report_create_request : Plaid::BeaconReportCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a Beacon Report Create a fraud report for a given Beacon User.
-
#beacon_report_create_with_http_info(*, beacon_report_create_request : Plaid::BeaconReportCreateRequest | Nil = nil) : Tuple(BeaconReportCreateResponse, Int32, Hash(String, Array(String) | String))
Create a Beacon Report Create a fraud report for a given Beacon User.
-
#beacon_report_get(*, beacon_report_get_request : Plaid::BeaconReportGetRequest | Nil = nil) : BeaconReportGetResponse
Get a Beacon Report Returns a Beacon report for a given Beacon report id.
-
#beacon_report_get(*, beacon_report_get_request : Plaid::BeaconReportGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get a Beacon Report Returns a Beacon report for a given Beacon report id.
-
#beacon_report_get_with_http_info(*, beacon_report_get_request : Plaid::BeaconReportGetRequest | Nil = nil) : Tuple(BeaconReportGetResponse, Int32, Hash(String, Array(String) | String))
Get a Beacon Report Returns a Beacon report for a given Beacon report id.
-
#beacon_report_list(*, beacon_report_list_request : Plaid::BeaconReportListRequest | Nil = nil) : BeaconReportListResponse
List Beacon Reports for a Beacon User Use the
/beacon/report/list
endpoint to view all Beacon Reports you created for a specific Beacon User. -
#beacon_report_list(*, beacon_report_list_request : Plaid::BeaconReportListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List Beacon Reports for a Beacon User Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User.
-
#beacon_report_list_with_http_info(*, beacon_report_list_request : Plaid::BeaconReportListRequest | Nil = nil) : Tuple(BeaconReportListResponse, Int32, Hash(String, Array(String) | String))
List Beacon Reports for a Beacon User Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User.
-
#beacon_report_syndication_list(*, beacon_report_syndication_list_request : Plaid::BeaconReportSyndicationListRequest | Nil = nil) : BeaconReportSyndicationListResponse
List Beacon Report Syndications for a Beacon User Use the
/beacon/report_syndication/list
endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. -
#beacon_report_syndication_list(*, beacon_report_syndication_list_request : Plaid::BeaconReportSyndicationListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List Beacon Report Syndications for a Beacon User Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User.
-
#beacon_report_syndication_list_with_http_info(*, beacon_report_syndication_list_request : Plaid::BeaconReportSyndicationListRequest | Nil = nil) : Tuple(BeaconReportSyndicationListResponse, Int32, Hash(String, Array(String) | String))
List Beacon Report Syndications for a Beacon User Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User.
-
#beacon_user_create(*, beacon_user_create_request : Plaid::BeaconUserCreateRequest | Nil = nil) : BeaconUserCreateResponse
Create a Beacon User Create and scan a Beacon User against your Beacon Program, according to your program's settings.
-
#beacon_user_create(*, beacon_user_create_request : Plaid::BeaconUserCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a Beacon User Create and scan a Beacon User against your Beacon Program, according to your program's settings.
-
#beacon_user_create_with_http_info(*, beacon_user_create_request : Plaid::BeaconUserCreateRequest | Nil = nil) : Tuple(BeaconUserCreateResponse, Int32, Hash(String, Array(String) | String))
Create a Beacon User Create and scan a Beacon User against your Beacon Program, according to your program's settings.
-
#beacon_user_get(*, beacon_user_get_request : Plaid::BeaconUserGetRequest | Nil = nil) : BeaconUserGetResponse
Get a Beacon User Fetch a Beacon User.
-
#beacon_user_get(*, beacon_user_get_request : Plaid::BeaconUserGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get a Beacon User Fetch a Beacon User.
-
#beacon_user_get_with_http_info(*, beacon_user_get_request : Plaid::BeaconUserGetRequest | Nil = nil) : Tuple(BeaconUserGetResponse, Int32, Hash(String, Array(String) | String))
Get a Beacon User Fetch a Beacon User.
-
#beacon_user_review(*, beacon_user_review_request : Plaid::BeaconUserReviewRequest | Nil = nil) : BeaconUserGetResponse
Review a Beacon User Update the status of a Beacon User.
-
#beacon_user_review(*, beacon_user_review_request : Plaid::BeaconUserReviewRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Review a Beacon User Update the status of a Beacon User.
-
#beacon_user_review_with_http_info(*, beacon_user_review_request : Plaid::BeaconUserReviewRequest | Nil = nil) : Tuple(BeaconUserGetResponse, Int32, Hash(String, Array(String) | String))
Review a Beacon User Update the status of a Beacon User.
-
#build_api_request_for_accounts_balance_get(*, accounts_balance_get_request : Plaid::AccountsBalanceGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_accounts_get(*, accounts_get_request : Plaid::AccountsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_application_get(*, application_get_request : Plaid::ApplicationGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_audit_copy_create(*, asset_report_audit_copy_create_request : Plaid::AssetReportAuditCopyCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_audit_copy_get(*, asset_report_audit_copy_get_request : Plaid::AssetReportAuditCopyGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_audit_copy_remove(*, asset_report_audit_copy_remove_request : Plaid::AssetReportAuditCopyRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_create(*, asset_report_create_request : Plaid::AssetReportCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_filter(*, asset_report_filter_request : Plaid::AssetReportFilterRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_get(*, asset_report_get_request : Plaid::AssetReportGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_pdf_get(*, asset_report_pdf_get_request : Plaid::AssetReportPDFGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_refresh(*, asset_report_refresh_request : Plaid::AssetReportRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_asset_report_remove(*, asset_report_remove_request : Plaid::AssetReportRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_auth_get(*, auth_get_request : Plaid::AuthGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_balance_get(*, bank_transfer_balance_get_request : Plaid::BankTransferBalanceGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_cancel(*, bank_transfer_cancel_request : Plaid::BankTransferCancelRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_create(*, bank_transfer_create_request : Plaid::BankTransferCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_event_list(*, bank_transfer_event_list_request : Plaid::BankTransferEventListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_event_sync(*, bank_transfer_event_sync_request : Plaid::BankTransferEventSyncRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_get(*, bank_transfer_get_request : Plaid::BankTransferGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_list(*, bank_transfer_list_request : Plaid::BankTransferListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_migrate_account(*, bank_transfer_migrate_account_request : Plaid::BankTransferMigrateAccountRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_sweep_get(*, bank_transfer_sweep_get_request : Plaid::BankTransferSweepGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_bank_transfer_sweep_list(*, bank_transfer_sweep_list_request : Plaid::BankTransferSweepListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_base_report_get(*, base_report_get_request : Plaid::BaseReportGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_beacon_report_create(*, beacon_report_create_request : Plaid::BeaconReportCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_beacon_report_get(*, beacon_report_get_request : Plaid::BeaconReportGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_beacon_report_list(*, beacon_report_list_request : Plaid::BeaconReportListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_beacon_report_syndication_list(*, beacon_report_syndication_list_request : Plaid::BeaconReportSyndicationListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_beacon_user_create(*, beacon_user_create_request : Plaid::BeaconUserCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_beacon_user_get(*, beacon_user_get_request : Plaid::BeaconUserGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_beacon_user_review(*, beacon_user_review_request : Plaid::BeaconUserReviewRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_categories_get(*, body : Object | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_cra_bank_income_get(*, cra_bank_income_get_request : Plaid::CraBankIncomeGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_create_payment_token(*, payment_initiation_payment_token_create_request : Plaid::PaymentInitiationPaymentTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_asset_report_freddie_mac_get(*, asset_report_freddie_get_request : Plaid::AssetReportFreddieGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_audit_copy_token_create(*, credit_audit_copy_token_create_request : Plaid::CreditAuditCopyTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_audit_copy_token_update(*, credit_audit_copy_token_update_request : Plaid::CreditAuditCopyTokenUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_bank_employment_get(*, credit_bank_employment_get_request : Plaid::CreditBankEmploymentGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_bank_income_get(*, credit_bank_income_get_request : Plaid::CreditBankIncomeGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_bank_income_pdf_get(*, credit_bank_income_pdf_get_request : Plaid::CreditBankIncomePDFGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_bank_income_refresh(*, credit_bank_income_refresh_request : Plaid::CreditBankIncomeRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_bank_income_webhook_update(*, credit_bank_income_webhook_update_request : Plaid::CreditBankIncomeWebhookUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_bank_statements_uploads_get(*, credit_bank_statements_uploads_get_request : Plaid::CreditBankStatementsUploadsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_employment_get(*, credit_employment_get_request : Plaid::CreditEmploymentGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_freddie_mac_reports_get(*, credit_freddie_mac_reports_get_request : Plaid::CreditFreddieMacReportsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_payroll_income_get(*, credit_payroll_income_get_request : Plaid::CreditPayrollIncomeGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_payroll_income_parsing_config_update(*, credit_payroll_income_parsing_config_update_request : Plaid::CreditPayrollIncomeParsingConfigUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_payroll_income_precheck(*, credit_payroll_income_precheck_request : Plaid::CreditPayrollIncomePrecheckRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_payroll_income_refresh(*, credit_payroll_income_refresh_request : Plaid::CreditPayrollIncomeRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_payroll_income_risk_signals_get(*, credit_payroll_income_risk_signals_get_request : Plaid::CreditPayrollIncomeRiskSignalsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_relay_create(*, credit_relay_create_request : Plaid::CreditRelayCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_relay_get(*, credit_relay_get_request : Plaid::CreditRelayGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_relay_pdf_get(*, credit_relay_pdf_get_request : Plaid::CreditRelayPDFGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_relay_refresh(*, credit_relay_refresh_request : Plaid::CreditRelayRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_relay_remove(*, credit_relay_remove_request : Plaid::CreditRelayRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_report_audit_copy_remove(*, credit_audit_copy_token_remove_request : Plaid::CreditAuditCopyTokenRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_credit_sessions_get(*, credit_sessions_get_request : Plaid::CreditSessionsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_dashboard_user_get(*, dashboard_user_get_request : Plaid::DashboardUserGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_dashboard_user_list(*, dashboard_user_list_request : Plaid::DashboardUserListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_deposit_switch_alt_create(*, deposit_switch_alt_create_request : Plaid::DepositSwitchAltCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_deposit_switch_create(*, deposit_switch_create_request : Plaid::DepositSwitchCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_deposit_switch_get(*, deposit_switch_get_request : Plaid::DepositSwitchGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_deposit_switch_token_create(*, deposit_switch_token_create_request : Plaid::DepositSwitchTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_employers_search(*, employers_search_request : Plaid::EmployersSearchRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_employment_verification_get(*, employment_verification_get_request : Plaid::EmploymentVerificationGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fdx_notifications(*, fdx_notification : Plaid::FDXNotification | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_identity_get(*, identity_get_request : Plaid::IdentityGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_identity_match(*, identity_match_request : Plaid::IdentityMatchRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_identity_refresh(*, identity_refresh_request : Plaid::IdentityRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_identity_verification_create(*, identity_verification_create_request : Plaid::IdentityVerificationCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_identity_verification_get(*, identity_verification_get_request : Plaid::IdentityVerificationGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_identity_verification_list(*, identity_verification_list_request : Plaid::IdentityVerificationListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_identity_verification_retry(*, identity_verification_retry_request : Plaid::IdentityVerificationRetryRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_income_verification_create(*, income_verification_create_request : Plaid::IncomeVerificationCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_income_verification_documents_download(*, income_verification_documents_download_request : Plaid::IncomeVerificationDocumentsDownloadRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_income_verification_paystubs_get(*, income_verification_paystubs_get_request : Plaid::IncomeVerificationPaystubsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_income_verification_precheck(*, income_verification_precheck_request : Plaid::IncomeVerificationPrecheckRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_income_verification_taxforms_get(*, income_verification_taxforms_get_request : Plaid::IncomeVerificationTaxformsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_institutions_get(*, institutions_get_request : Plaid::InstitutionsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_institutions_get_by_id(*, institutions_get_by_id_request : Plaid::InstitutionsGetByIdRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_institutions_search(*, institutions_search_request : Plaid::InstitutionsSearchRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_investments_auth_get(*, investments_auth_get_request : Plaid::InvestmentsAuthGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_investments_holdings_get(*, investments_holdings_get_request : Plaid::InvestmentsHoldingsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_investments_refresh(*, investments_refresh_request : Plaid::InvestmentsRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_investments_transactions_get(*, investments_transactions_get_request : Plaid::InvestmentsTransactionsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_access_token_invalidate(*, item_access_token_invalidate_request : Plaid::ItemAccessTokenInvalidateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_activity_list(*, item_activity_list_request : Plaid::ItemActivityListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_application_list(*, item_application_list_request : Plaid::ItemApplicationListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_application_scopes_update(*, item_application_scopes_update_request : Plaid::ItemApplicationScopesUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_application_unlink(*, item_application_unlink_request : Plaid::ItemApplicationUnlinkRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_create_public_token(*, item_public_token_create_request : Plaid::ItemPublicTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_get(*, item_get_request : Plaid::ItemGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_import(*, item_import_request : Plaid::ItemImportRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_public_token_exchange(*, item_public_token_exchange_request : Plaid::ItemPublicTokenExchangeRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_remove(*, item_remove_request : Plaid::ItemRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_item_webhook_update(*, item_webhook_update_request : Plaid::ItemWebhookUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_liabilities_get(*, liabilities_get_request : Plaid::LiabilitiesGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_link_delivery_create(*, link_delivery_create_request : Plaid::LinkDeliveryCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_link_delivery_get(*, link_delivery_get_request : Plaid::LinkDeliveryGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_link_oauth_correlation_id_exchange(*, link_o_auth_correlation_id_exchange_request : Plaid::LinkOAuthCorrelationIdExchangeRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_link_token_create(*, link_token_create_request : Plaid::LinkTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_link_token_get(*, link_token_get_request : Plaid::LinkTokenGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_partner_customer_create(*, partner_customer_create_request : Plaid::PartnerCustomerCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_partner_customer_enable(*, partner_customer_enable_request : Plaid::PartnerCustomerEnableRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_partner_customer_get(*, partner_customer_get_request : Plaid::PartnerCustomerGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_partner_customer_oauth_institutions_get(*, partner_customer_o_auth_institutions_get_request : Plaid::PartnerCustomerOAuthInstitutionsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_partner_customer_remove(*, partner_customer_remove_request : Plaid::PartnerCustomerRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_consent_create(*, payment_initiation_consent_create_request : Plaid::PaymentInitiationConsentCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_consent_get(*, payment_initiation_consent_get_request : Plaid::PaymentInitiationConsentGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_consent_payment_execute(*, payment_initiation_consent_payment_execute_request : Plaid::PaymentInitiationConsentPaymentExecuteRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_consent_revoke(*, payment_initiation_consent_revoke_request : Plaid::PaymentInitiationConsentRevokeRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_payment_create(*, payment_initiation_payment_create_request : Plaid::PaymentInitiationPaymentCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_payment_get(*, payment_initiation_payment_get_request : Plaid::PaymentInitiationPaymentGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_payment_list(*, payment_initiation_payment_list_request : Plaid::PaymentInitiationPaymentListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_payment_reverse(*, payment_initiation_payment_reverse_request : Plaid::PaymentInitiationPaymentReverseRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_recipient_create(*, payment_initiation_recipient_create_request : Plaid::PaymentInitiationRecipientCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_recipient_get(*, payment_initiation_recipient_get_request : Plaid::PaymentInitiationRecipientGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_initiation_recipient_list(*, payment_initiation_recipient_list_request : Plaid::PaymentInitiationRecipientListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_profile_create(*, payment_profile_create_request : Plaid::PaymentProfileCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_profile_get(*, payment_profile_get_request : Plaid::PaymentProfileGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_payment_profile_remove(*, payment_profile_remove_request : Plaid::PaymentProfileRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_account_get(*, processor_account_get_request : Plaid::ProcessorAccountGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_apex_processor_token_create(*, processor_apex_processor_token_create_request : Plaid::ProcessorApexProcessorTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_auth_get(*, processor_auth_get_request : Plaid::ProcessorAuthGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_balance_get(*, processor_balance_get_request : Plaid::ProcessorBalanceGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_bank_transfer_create(*, processor_bank_transfer_create_request : Plaid::ProcessorBankTransferCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_identity_get(*, processor_identity_get_request : Plaid::ProcessorIdentityGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_identity_match(*, processor_identity_match_request : Plaid::ProcessorIdentityMatchRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_signal_decision_report(*, processor_signal_decision_report_request : Plaid::ProcessorSignalDecisionReportRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_signal_evaluate(*, processor_signal_evaluate_request : Plaid::ProcessorSignalEvaluateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_signal_prepare(*, processor_signal_prepare_request : Plaid::ProcessorSignalPrepareRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_signal_return_report(*, processor_signal_return_report_request : Plaid::ProcessorSignalReturnReportRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_stripe_bank_account_token_create(*, processor_stripe_bank_account_token_create_request : Plaid::ProcessorStripeBankAccountTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_token_create(*, processor_token_create_request : Plaid::ProcessorTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_token_permissions_get(*, processor_token_permissions_get_request : Plaid::ProcessorTokenPermissionsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_token_permissions_set(*, processor_token_permissions_set_request : Plaid::ProcessorTokenPermissionsSetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_token_webhook_update(*, processor_token_webhook_update_request : Plaid::ProcessorTokenWebhookUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_transactions_get(*, processor_transactions_get_request : Plaid::ProcessorTransactionsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_transactions_recurring_get(*, processor_transactions_recurring_get_request : Plaid::ProcessorTransactionsRecurringGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_transactions_refresh(*, processor_transactions_refresh_request : Plaid::ProcessorTransactionsRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_processor_transactions_sync(*, processor_transactions_sync_request : Plaid::ProcessorTransactionsSyncRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_bank_income_fire_webhook(*, sandbox_bank_income_fire_webhook_request : Plaid::SandboxBankIncomeFireWebhookRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_bank_transfer_fire_webhook(*, sandbox_bank_transfer_fire_webhook_request : Plaid::SandboxBankTransferFireWebhookRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_bank_transfer_simulate(*, sandbox_bank_transfer_simulate_request : Plaid::SandboxBankTransferSimulateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_income_fire_webhook(*, sandbox_income_fire_webhook_request : Plaid::SandboxIncomeFireWebhookRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_item_fire_webhook(*, sandbox_item_fire_webhook_request : Plaid::SandboxItemFireWebhookRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_item_reset_login(*, sandbox_item_reset_login_request : Plaid::SandboxItemResetLoginRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_item_set_verification_status(*, sandbox_item_set_verification_status_request : Plaid::SandboxItemSetVerificationStatusRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_oauth_select_accounts(*, sandbox_oauth_select_accounts_request : Plaid::SandboxOauthSelectAccountsRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_payment_profile_reset_login(*, sandbox_payment_profile_reset_login_request : Plaid::SandboxPaymentProfileResetLoginRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_processor_token_create(*, sandbox_processor_token_create_request : Plaid::SandboxProcessorTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_public_token_create(*, sandbox_public_token_create_request : Plaid::SandboxPublicTokenCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_fire_webhook(*, sandbox_transfer_fire_webhook_request : Plaid::SandboxTransferFireWebhookRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_ledger_deposit_simulate(*, sandbox_transfer_ledger_deposit_simulate_request : Plaid::SandboxTransferLedgerDepositSimulateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_ledger_simulate_available(*, sandbox_transfer_ledger_simulate_available_request : Plaid::SandboxTransferLedgerSimulateAvailableRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_ledger_withdraw_simulate(*, sandbox_transfer_ledger_withdraw_simulate_request : Plaid::SandboxTransferLedgerWithdrawSimulateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_refund_simulate(*, sandbox_transfer_refund_simulate_request : Plaid::SandboxTransferRefundSimulateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_repayment_simulate(*, sandbox_transfer_repayment_simulate_request : Plaid::SandboxTransferRepaymentSimulateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_simulate(*, sandbox_transfer_simulate_request : Plaid::SandboxTransferSimulateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_sweep_simulate(*, sandbox_transfer_sweep_simulate_request : Plaid::SandboxTransferSweepSimulateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_test_clock_advance(*, sandbox_transfer_test_clock_advance_request : Plaid::SandboxTransferTestClockAdvanceRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_test_clock_create(*, sandbox_transfer_test_clock_create_request : Plaid::SandboxTransferTestClockCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_test_clock_get(*, sandbox_transfer_test_clock_get_request : Plaid::SandboxTransferTestClockGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_sandbox_transfer_test_clock_list(*, sandbox_transfer_test_clock_list_request : Plaid::SandboxTransferTestClockListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_signal_decision_report(*, signal_decision_report_request : Plaid::SignalDecisionReportRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_signal_evaluate(*, signal_evaluate_request : Plaid::SignalEvaluateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_signal_prepare(*, signal_prepare_request : Plaid::SignalPrepareRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_signal_return_report(*, signal_return_report_request : Plaid::SignalReturnReportRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_statements_download(*, statements_download_request : Plaid::StatementsDownloadRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_statements_list(*, statements_list_request : Plaid::StatementsListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_enhance(*, transactions_enhance_get_request : Plaid::TransactionsEnhanceGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_enrich(*, transactions_enrich_request : Plaid::TransactionsEnrichRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_get(*, transactions_get_request : Plaid::TransactionsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_recurring_get(*, transactions_recurring_get_request : Plaid::TransactionsRecurringGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_refresh(*, transactions_refresh_request : Plaid::TransactionsRefreshRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_rules_create(*, transactions_rules_create_request : Plaid::TransactionsRulesCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_rules_list(*, transactions_rules_list_request : Plaid::TransactionsRulesListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_rules_remove(*, transactions_rules_remove_request : Plaid::TransactionsRulesRemoveRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_sync(*, transactions_sync_request : Plaid::TransactionsSyncRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transactions_user_insights_get(*, transactions_user_insights_get_request : Plaid::TransactionsUserInsightsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_authorization_create(*, transfer_authorization_create_request : Plaid::TransferAuthorizationCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_balance_get(*, transfer_balance_get_request : Plaid::TransferBalanceGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_cancel(*, transfer_cancel_request : Plaid::TransferCancelRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_capabilities_get(*, transfer_capabilities_get_request : Plaid::TransferCapabilitiesGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_configuration_get(*, transfer_configuration_get_request : Plaid::TransferConfigurationGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_create(*, transfer_create_request : Plaid::TransferCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_diligence_document_upload(*, transfer_diligence_document_upload_request : Plaid::TransferDiligenceDocumentUploadRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_diligence_submit(*, transfer_diligence_submit_request : Plaid::TransferDiligenceSubmitRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_event_list(*, transfer_event_list_request : Plaid::TransferEventListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_event_sync(*, transfer_event_sync_request : Plaid::TransferEventSyncRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_get(*, transfer_get_request : Plaid::TransferGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_intent_create(*, transfer_intent_create_request : Plaid::TransferIntentCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_intent_get(*, transfer_intent_get_request : Plaid::TransferIntentGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_ledger_deposit(*, transfer_ledger_deposit_request : Plaid::TransferLedgerDepositRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_ledger_distribute(*, transfer_ledger_distribute_request : Plaid::TransferLedgerDistributeRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_ledger_get(*, transfer_ledger_get_request : Plaid::TransferLedgerGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_ledger_withdraw(*, transfer_ledger_withdraw_request : Plaid::TransferLedgerWithdrawRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_list(*, transfer_list_request : Plaid::TransferListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_metrics_get(*, transfer_metrics_get_request : Plaid::TransferMetricsGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_migrate_account(*, transfer_migrate_account_request : Plaid::TransferMigrateAccountRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_originator_create(*, transfer_originator_create_request : Plaid::TransferOriginatorCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_originator_funding_account_update(*, transfer_originator_funding_account_update_request : Plaid::TransferOriginatorFundingAccountUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_originator_get(*, transfer_originator_get_request : Plaid::TransferOriginatorGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_originator_list(*, transfer_originator_list_request : Plaid::TransferOriginatorListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_questionnaire_create(*, transfer_questionnaire_create_request : Plaid::TransferQuestionnaireCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_recurring_cancel(*, transfer_recurring_cancel_request : Plaid::TransferRecurringCancelRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_recurring_create(*, transfer_recurring_create_request : Plaid::TransferRecurringCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_recurring_get(*, transfer_recurring_get_request : Plaid::TransferRecurringGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_recurring_list(*, transfer_recurring_list_request : Plaid::TransferRecurringListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_refund_cancel(*, transfer_refund_cancel_request : Plaid::TransferRefundCancelRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_refund_create(*, transfer_refund_create_request : Plaid::TransferRefundCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_refund_get(*, transfer_refund_get_request : Plaid::TransferRefundGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_repayment_list(*, transfer_repayment_list_request : Plaid::TransferRepaymentListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_repayment_return_list(*, transfer_repayment_return_list_request : Plaid::TransferRepaymentReturnListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_sweep_get(*, transfer_sweep_get_request : Plaid::TransferSweepGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_transfer_sweep_list(*, transfer_sweep_list_request : Plaid::TransferSweepListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_user_create(*, user_create_request : Plaid::UserCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_user_update(*, user_update_request : Plaid::UserUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_wallet_create(*, wallet_create_request : Plaid::WalletCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_wallet_get(*, wallet_get_request : Plaid::WalletGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_wallet_list(*, wallet_list_request : Plaid::WalletListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_wallet_transaction_execute(*, wallet_transaction_execute_request : Plaid::WalletTransactionExecuteRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_wallet_transaction_get(*, wallet_transaction_get_request : Plaid::WalletTransactionGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_wallet_transaction_list(*, wallet_transaction_list_request : Plaid::WalletTransactionListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_create(*, watchlist_screening_entity_create_request : Plaid::WatchlistScreeningEntityCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_get(*, watchlist_screening_entity_get_request : Plaid::WatchlistScreeningEntityGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_history_list(*, watchlist_screening_entity_history_list_request : Plaid::WatchlistScreeningEntityHistoryListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_hit_list(*, watchlist_screening_entity_hit_list_request : Plaid::WatchlistScreeningEntityHitListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_list(*, watchlist_screening_entity_list_request : Plaid::WatchlistScreeningEntityListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_program_get(*, watchlist_screening_entity_program_get_request : Plaid::WatchlistScreeningEntityProgramGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_program_list(*, watchlist_screening_entity_program_list_request : Plaid::WatchlistScreeningEntityProgramListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_review_create(*, watchlist_screening_entity_review_create_request : Plaid::WatchlistScreeningEntityReviewCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_review_list(*, watchlist_screening_entity_review_list_request : Plaid::WatchlistScreeningEntityReviewListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_entity_update(*, watchlist_screening_entity_update_request : Plaid::WatchlistScreeningEntityUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_create(*, watchlist_screening_individual_create_request : Plaid::WatchlistScreeningIndividualCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_get(*, watchlist_screening_individual_get_request : Plaid::WatchlistScreeningIndividualGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_history_list(*, watchlist_screening_individual_history_list_request : Plaid::WatchlistScreeningIndividualHistoryListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_hit_list(*, watchlist_screening_individual_hit_list_request : Plaid::WatchlistScreeningIndividualHitListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_list(*, watchlist_screening_individual_list_request : Plaid::WatchlistScreeningIndividualListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_program_get(*, watchlist_screening_individual_program_get_request : Plaid::WatchlistScreeningIndividualProgramGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_program_list(*, watchlist_screening_individual_program_list_request : Plaid::WatchlistScreeningIndividualProgramListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_review_create(*, watchlist_screening_individual_review_create_request : Plaid::WatchlistScreeningIndividualReviewCreateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_review_list(*, watchlist_screening_individual_review_list_request : Plaid::WatchlistScreeningIndividualReviewListRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watchlist_screening_individual_update(*, watchlist_screening_individual_update_request : Plaid::WatchlistScreeningIndividualUpdateRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_webhook_verification_key_get(*, webhook_verification_key_get_request : Plaid::WebhookVerificationKeyGetRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#categories_get(*, body : Object | Nil = nil) : CategoriesGetResponse
Get categories Send a request to the
/categories/get
endpoint to get detailed information on categories returned by Plaid. -
#categories_get(*, body : Object | Nil = nil, &block : Crest::Response -> ) : Nil
Get categories Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid.
-
#categories_get_with_http_info(*, body : Object | Nil = nil) : Tuple(CategoriesGetResponse, Int32, Hash(String, Array(String) | String))
Get categories Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid.
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
-
#cra_bank_income_get(*, cra_bank_income_get_request : Plaid::CraBankIncomeGetRequest | Nil = nil) : CraBankIncomeGetResponse
Retrieve information from the bank accounts used for income verification
/cra/bank_income/get
returns the bank income report(s) for a specified user. -
#cra_bank_income_get(*, cra_bank_income_get_request : Plaid::CraBankIncomeGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve information from the bank accounts used for income verification `/cra/bank_income/get` returns the bank income report(s) for a specified user.
-
#cra_bank_income_get_with_http_info(*, cra_bank_income_get_request : Plaid::CraBankIncomeGetRequest | Nil = nil) : Tuple(CraBankIncomeGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve information from the bank accounts used for income verification `/cra/bank_income/get` returns the bank income report(s) for a specified user.
-
#create_payment_token(*, payment_initiation_payment_token_create_request : Plaid::PaymentInitiationPaymentTokenCreateRequest | Nil = nil) : PaymentInitiationPaymentTokenCreateResponse
Create payment token The
/payment_initiation/payment/token/create
endpoint has been deprecated. -
#create_payment_token(*, payment_initiation_payment_token_create_request : Plaid::PaymentInitiationPaymentTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create payment token The `/payment_initiation/payment/token/create` endpoint has been deprecated.
-
#create_payment_token_with_http_info(*, payment_initiation_payment_token_create_request : Plaid::PaymentInitiationPaymentTokenCreateRequest | Nil = nil) : Tuple(PaymentInitiationPaymentTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create payment token The `/payment_initiation/payment/token/create` endpoint has been deprecated.
-
#credit_asset_report_freddie_mac_get(*, asset_report_freddie_get_request : Plaid::AssetReportFreddieGetRequest | Nil = nil) : AssetReportFreddieGetResponse
Retrieve an Asset Report with Freddie Mac format.
-
#credit_asset_report_freddie_mac_get(*, asset_report_freddie_get_request : Plaid::AssetReportFreddieGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve an Asset Report with Freddie Mac format.
-
#credit_asset_report_freddie_mac_get_with_http_info(*, asset_report_freddie_get_request : Plaid::AssetReportFreddieGetRequest | Nil = nil) : Tuple(AssetReportFreddieGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve an Asset Report with Freddie Mac format.
-
#credit_audit_copy_token_create(*, credit_audit_copy_token_create_request : Plaid::CreditAuditCopyTokenCreateRequest | Nil = nil) : CreditAuditCopyTokenCreateResponse
Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE).
-
#credit_audit_copy_token_create(*, credit_audit_copy_token_create_request : Plaid::CreditAuditCopyTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE).
-
#credit_audit_copy_token_create_with_http_info(*, credit_audit_copy_token_create_request : Plaid::CreditAuditCopyTokenCreateRequest | Nil = nil) : Tuple(CreditAuditCopyTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE).
-
#credit_audit_copy_token_update(*, credit_audit_copy_token_update_request : Plaid::CreditAuditCopyTokenUpdateRequest | Nil = nil) : CreditAuditCopyTokenUpdateResponse
Update an Audit Copy Token The
/credit/audit_copy_token/update
endpoint updates an existing Audit Copy Token by adding the report tokens in thereport_tokens
field to theaudit_copy_token
. -
#credit_audit_copy_token_update(*, credit_audit_copy_token_update_request : Plaid::CreditAuditCopyTokenUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update an Audit Copy Token The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`.
-
#credit_audit_copy_token_update_with_http_info(*, credit_audit_copy_token_update_request : Plaid::CreditAuditCopyTokenUpdateRequest | Nil = nil) : Tuple(CreditAuditCopyTokenUpdateResponse, Int32, Hash(String, Array(String) | String))
Update an Audit Copy Token The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`.
-
#credit_bank_employment_get(*, credit_bank_employment_get_request : Plaid::CreditBankEmploymentGetRequest | Nil = nil) : CreditBankEmploymentGetResponse
Retrieve information from the bank accounts used for employment verification
/credit/bank_employment/get
returns the employment report(s) derived from bank transaction data for a specified user. -
#credit_bank_employment_get(*, credit_bank_employment_get_request : Plaid::CreditBankEmploymentGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve information from the bank accounts used for employment verification `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
-
#credit_bank_employment_get_with_http_info(*, credit_bank_employment_get_request : Plaid::CreditBankEmploymentGetRequest | Nil = nil) : Tuple(CreditBankEmploymentGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve information from the bank accounts used for employment verification `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
-
#credit_bank_income_get(*, credit_bank_income_get_request : Plaid::CreditBankIncomeGetRequest | Nil = nil) : CreditBankIncomeGetResponse
Retrieve information from the bank accounts used for income verification
/credit/bank_income/get
returns the bank income report(s) for a specified user. -
#credit_bank_income_get(*, credit_bank_income_get_request : Plaid::CreditBankIncomeGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve information from the bank accounts used for income verification `/credit/bank_income/get` returns the bank income report(s) for a specified user.
-
#credit_bank_income_get_with_http_info(*, credit_bank_income_get_request : Plaid::CreditBankIncomeGetRequest | Nil = nil) : Tuple(CreditBankIncomeGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve information from the bank accounts used for income verification `/credit/bank_income/get` returns the bank income report(s) for a specified user.
-
#credit_bank_income_pdf_get(*, credit_bank_income_pdf_get_request : Plaid::CreditBankIncomePDFGetRequest | Nil = nil) : File
Retrieve information from the bank accounts used for income verification in PDF format
/credit/bank_income/pdf/get
returns the most recent bank income report for a specified user in PDF format. -
#credit_bank_income_pdf_get(*, credit_bank_income_pdf_get_request : Plaid::CreditBankIncomePDFGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve information from the bank accounts used for income verification in PDF format `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
-
#credit_bank_income_pdf_get_with_http_info(*, credit_bank_income_pdf_get_request : Plaid::CreditBankIncomePDFGetRequest | Nil = nil) : Tuple(File, Int32, Hash(String, Array(String) | String))
Retrieve information from the bank accounts used for income verification in PDF format `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
-
#credit_bank_income_refresh(*, credit_bank_income_refresh_request : Plaid::CreditBankIncomeRefreshRequest | Nil = nil) : CreditBankIncomeRefreshResponse
Refresh a user's bank income information
/credit/bank_income/refresh
refreshes the bank income report data for a specific user. -
#credit_bank_income_refresh(*, credit_bank_income_refresh_request : Plaid::CreditBankIncomeRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh a user's bank income information `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
-
#credit_bank_income_refresh_with_http_info(*, credit_bank_income_refresh_request : Plaid::CreditBankIncomeRefreshRequest | Nil = nil) : Tuple(CreditBankIncomeRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh a user's bank income information `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
-
#credit_bank_income_webhook_update(*, credit_bank_income_webhook_update_request : Plaid::CreditBankIncomeWebhookUpdateRequest | Nil = nil) : CreditBankIncomeWebhookUpdateResponse
Subscribe and unsubscribe to proactive notifications for a user's income profile
/credit/bank_income/webhook/update
allows you to subscribe or unsubscribe a user for income webhook notifications. -
#credit_bank_income_webhook_update(*, credit_bank_income_webhook_update_request : Plaid::CreditBankIncomeWebhookUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Subscribe and unsubscribe to proactive notifications for a user's income profile `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications.
-
#credit_bank_income_webhook_update_with_http_info(*, credit_bank_income_webhook_update_request : Plaid::CreditBankIncomeWebhookUpdateRequest | Nil = nil) : Tuple(CreditBankIncomeWebhookUpdateResponse, Int32, Hash(String, Array(String) | String))
Subscribe and unsubscribe to proactive notifications for a user's income profile `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications.
-
#credit_bank_statements_uploads_get(*, credit_bank_statements_uploads_get_request : Plaid::CreditBankStatementsUploadsGetRequest | Nil = nil) : CreditBankStatementsUploadsGetResponse
Retrieve data for a user's uploaded bank statements
/credit/bank_statements/uploads/get
returns parsed data from bank statements uploaded by users as part of the Document Income flow. -
#credit_bank_statements_uploads_get(*, credit_bank_statements_uploads_get_request : Plaid::CreditBankStatementsUploadsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve data for a user's uploaded bank statements `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow.
-
#credit_bank_statements_uploads_get_with_http_info(*, credit_bank_statements_uploads_get_request : Plaid::CreditBankStatementsUploadsGetRequest | Nil = nil) : Tuple(CreditBankStatementsUploadsGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve data for a user's uploaded bank statements `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow.
-
#credit_employment_get(*, credit_employment_get_request : Plaid::CreditEmploymentGetRequest | Nil = nil) : CreditEmploymentGetResponse
Retrieve a summary of an individual's employment information
/credit/employment/get
returns a list of items with employment information from a user's payroll provider that was verified by an end user. -
#credit_employment_get(*, credit_employment_get_request : Plaid::CreditEmploymentGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a summary of an individual's employment information `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user.
-
#credit_employment_get_with_http_info(*, credit_employment_get_request : Plaid::CreditEmploymentGetRequest | Nil = nil) : Tuple(CreditEmploymentGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a summary of an individual's employment information `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user.
-
#credit_freddie_mac_reports_get(*, credit_freddie_mac_reports_get_request : Plaid::CreditFreddieMacReportsGetRequest | Nil = nil) : CreditFreddieMacReportsGetResponse
Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available.
-
#credit_freddie_mac_reports_get(*, credit_freddie_mac_reports_get_request : Plaid::CreditFreddieMacReportsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available.
-
#credit_freddie_mac_reports_get_with_http_info(*, credit_freddie_mac_reports_get_request : Plaid::CreditFreddieMacReportsGetRequest | Nil = nil) : Tuple(CreditFreddieMacReportsGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available.
-
#credit_payroll_income_get(*, credit_payroll_income_get_request : Plaid::CreditPayrollIncomeGetRequest | Nil = nil) : CreditPayrollIncomeGetResponse
Retrieve a user's payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
-
#credit_payroll_income_get(*, credit_payroll_income_get_request : Plaid::CreditPayrollIncomeGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a user's payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
-
#credit_payroll_income_get_with_http_info(*, credit_payroll_income_get_request : Plaid::CreditPayrollIncomeGetRequest | Nil = nil) : Tuple(CreditPayrollIncomeGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a user's payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
-
#credit_payroll_income_parsing_config_update(*, credit_payroll_income_parsing_config_update_request : Plaid::CreditPayrollIncomeParsingConfigUpdateRequest | Nil = nil) : CreditPayrollIncomeParsingConfigUpdateResponse
Update the parsing configuration for a document income verification
/credit/payroll_income/parsing_config/update
updates the parsing configuration for a document income verification. -
#credit_payroll_income_parsing_config_update(*, credit_payroll_income_parsing_config_update_request : Plaid::CreditPayrollIncomeParsingConfigUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update the parsing configuration for a document income verification `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.
-
#credit_payroll_income_parsing_config_update_with_http_info(*, credit_payroll_income_parsing_config_update_request : Plaid::CreditPayrollIncomeParsingConfigUpdateRequest | Nil = nil) : Tuple(CreditPayrollIncomeParsingConfigUpdateResponse, Int32, Hash(String, Array(String) | String))
Update the parsing configuration for a document income verification `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.
-
#credit_payroll_income_precheck(*, credit_payroll_income_precheck_request : Plaid::CreditPayrollIncomePrecheckRequest | Nil = nil) : CreditPayrollIncomePrecheckResponse
Check income verification eligibility and optimize conversion
/credit/payroll_income/precheck
is an optional endpoint that can be called before initializing a Link session for income verification. -
#credit_payroll_income_precheck(*, credit_payroll_income_precheck_request : Plaid::CreditPayrollIncomePrecheckRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Check income verification eligibility and optimize conversion `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification.
-
#credit_payroll_income_precheck_with_http_info(*, credit_payroll_income_precheck_request : Plaid::CreditPayrollIncomePrecheckRequest | Nil = nil) : Tuple(CreditPayrollIncomePrecheckResponse, Int32, Hash(String, Array(String) | String))
Check income verification eligibility and optimize conversion `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification.
-
#credit_payroll_income_refresh(*, credit_payroll_income_refresh_request : Plaid::CreditPayrollIncomeRefreshRequest | Nil = nil) : CreditPayrollIncomeRefreshResponse
Refresh a digital payroll income verification
/credit/payroll_income/refresh
refreshes a given digital payroll income verification. -
#credit_payroll_income_refresh(*, credit_payroll_income_refresh_request : Plaid::CreditPayrollIncomeRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh a digital payroll income verification `/credit/payroll_income/refresh` refreshes a given digital payroll income verification.
-
#credit_payroll_income_refresh_with_http_info(*, credit_payroll_income_refresh_request : Plaid::CreditPayrollIncomeRefreshRequest | Nil = nil) : Tuple(CreditPayrollIncomeRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh a digital payroll income verification `/credit/payroll_income/refresh` refreshes a given digital payroll income verification.
-
#credit_payroll_income_risk_signals_get(*, credit_payroll_income_risk_signals_get_request : Plaid::CreditPayrollIncomeRiskSignalsGetRequest | Nil = nil) : CreditPayrollIncomeRiskSignalsGetResponse
Retrieve fraud insights for a user's manually uploaded document(s).
-
#credit_payroll_income_risk_signals_get(*, credit_payroll_income_risk_signals_get_request : Plaid::CreditPayrollIncomeRiskSignalsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve fraud insights for a user's manually uploaded document(s).
-
#credit_payroll_income_risk_signals_get_with_http_info(*, credit_payroll_income_risk_signals_get_request : Plaid::CreditPayrollIncomeRiskSignalsGetRequest | Nil = nil) : Tuple(CreditPayrollIncomeRiskSignalsGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve fraud insights for a user's manually uploaded document(s).
-
#credit_relay_create(*, credit_relay_create_request : Plaid::CreditRelayCreateRequest | Nil = nil) : CreditRelayCreateResponse
Create a relay token to share an Asset Report with a partner client (beta) Plaid can share an Asset Report directly with a participating third party on your behalf.
-
#credit_relay_create(*, credit_relay_create_request : Plaid::CreditRelayCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a relay token to share an Asset Report with a partner client (beta) Plaid can share an Asset Report directly with a participating third party on your behalf.
-
#credit_relay_create_with_http_info(*, credit_relay_create_request : Plaid::CreditRelayCreateRequest | Nil = nil) : Tuple(CreditRelayCreateResponse, Int32, Hash(String, Array(String) | String))
Create a relay token to share an Asset Report with a partner client (beta) Plaid can share an Asset Report directly with a participating third party on your behalf.
-
#credit_relay_get(*, credit_relay_get_request : Plaid::CreditRelayGetRequest | Nil = nil) : AssetReportGetResponse
Retrieve the reports associated with a relay token that was shared with you (beta)
/credit/relay/get
allows third parties to receive a report that was shared with them, using arelay_token
that was created by the report owner. -
#credit_relay_get(*, credit_relay_get_request : Plaid::CreditRelayGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve the reports associated with a relay token that was shared with you (beta) `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.
-
#credit_relay_get_with_http_info(*, credit_relay_get_request : Plaid::CreditRelayGetRequest | Nil = nil) : Tuple(AssetReportGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve the reports associated with a relay token that was shared with you (beta) `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.
-
#credit_relay_pdf_get(*, credit_relay_pdf_get_request : Plaid::CreditRelayPDFGetRequest | Nil = nil) : File
Retrieve the pdf reports associated with a relay token that was shared with you (beta)
/credit/relay/pdf/get
allows third parties to receive a pdf report that was shared with them, using arelay_token
that was created by the report owner. -
#credit_relay_pdf_get(*, credit_relay_pdf_get_request : Plaid::CreditRelayPDFGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve the pdf reports associated with a relay token that was shared with you (beta) `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner.
-
#credit_relay_pdf_get_with_http_info(*, credit_relay_pdf_get_request : Plaid::CreditRelayPDFGetRequest | Nil = nil) : Tuple(File, Int32, Hash(String, Array(String) | String))
Retrieve the pdf reports associated with a relay token that was shared with you (beta) `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner.
-
#credit_relay_refresh(*, credit_relay_refresh_request : Plaid::CreditRelayRefreshRequest | Nil = nil) : CreditRelayRefreshResponse
Refresh a report of a relay token (beta) The
/credit/relay/refresh
endpoint allows third parties to refresh a report that was relayed to them, using arelay_token
that was created by the report owner. -
#credit_relay_refresh(*, credit_relay_refresh_request : Plaid::CreditRelayRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh a report of a relay token (beta) The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner.
-
#credit_relay_refresh_with_http_info(*, credit_relay_refresh_request : Plaid::CreditRelayRefreshRequest | Nil = nil) : Tuple(CreditRelayRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh a report of a relay token (beta) The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner.
-
#credit_relay_remove(*, credit_relay_remove_request : Plaid::CreditRelayRemoveRequest | Nil = nil) : CreditRelayRemoveResponse
Remove relay token (beta) The
/credit/relay/remove
endpoint allows you to invalidate arelay_token
. -
#credit_relay_remove(*, credit_relay_remove_request : Plaid::CreditRelayRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Remove relay token (beta) The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`.
-
#credit_relay_remove_with_http_info(*, credit_relay_remove_request : Plaid::CreditRelayRemoveRequest | Nil = nil) : Tuple(CreditRelayRemoveResponse, Int32, Hash(String, Array(String) | String))
Remove relay token (beta) The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`.
-
#credit_report_audit_copy_remove(*, credit_audit_copy_token_remove_request : Plaid::CreditAuditCopyTokenRemoveRequest | Nil = nil) : CreditAuditCopyTokenRemoveResponse
Remove an Audit Copy token The
/credit/audit_copy_token/remove
endpoint allows you to remove an Audit Copy. -
#credit_report_audit_copy_remove(*, credit_audit_copy_token_remove_request : Plaid::CreditAuditCopyTokenRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Remove an Audit Copy token The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy.
-
#credit_report_audit_copy_remove_with_http_info(*, credit_audit_copy_token_remove_request : Plaid::CreditAuditCopyTokenRemoveRequest | Nil = nil) : Tuple(CreditAuditCopyTokenRemoveResponse, Int32, Hash(String, Array(String) | String))
Remove an Audit Copy token The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy.
-
#credit_sessions_get(*, credit_sessions_get_request : Plaid::CreditSessionsGetRequest | Nil = nil) : CreditSessionsGetResponse
Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow.
-
#credit_sessions_get(*, credit_sessions_get_request : Plaid::CreditSessionsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow.
-
#credit_sessions_get_with_http_info(*, credit_sessions_get_request : Plaid::CreditSessionsGetRequest | Nil = nil) : Tuple(CreditSessionsGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow.
-
#dashboard_user_get(*, dashboard_user_get_request : Plaid::DashboardUserGetRequest | Nil = nil) : DashboardUserGetResponse
Retrieve a dashboard user Retrieve information about a dashboard user.
-
#dashboard_user_get(*, dashboard_user_get_request : Plaid::DashboardUserGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a dashboard user Retrieve information about a dashboard user.
-
#dashboard_user_get_with_http_info(*, dashboard_user_get_request : Plaid::DashboardUserGetRequest | Nil = nil) : Tuple(DashboardUserGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a dashboard user Retrieve information about a dashboard user.
-
#dashboard_user_list(*, dashboard_user_list_request : Plaid::DashboardUserListRequest | Nil = nil) : DashboardUserListResponse
List dashboard users List all dashboard users associated with your account.
-
#dashboard_user_list(*, dashboard_user_list_request : Plaid::DashboardUserListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List dashboard users List all dashboard users associated with your account.
-
#dashboard_user_list_with_http_info(*, dashboard_user_list_request : Plaid::DashboardUserListRequest | Nil = nil) : Tuple(DashboardUserListResponse, Int32, Hash(String, Array(String) | String))
List dashboard users List all dashboard users associated with your account.
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#deposit_switch_alt_create(*, deposit_switch_alt_create_request : Plaid::DepositSwitchAltCreateRequest | Nil = nil) : DepositSwitchAltCreateResponse
Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to
/deposit_switch/create
for customers who have not yet fully integrated with Plaid Exchange. -
#deposit_switch_alt_create(*, deposit_switch_alt_create_request : Plaid::DepositSwitchAltCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange.
-
#deposit_switch_alt_create_with_http_info(*, deposit_switch_alt_create_request : Plaid::DepositSwitchAltCreateRequest | Nil = nil) : Tuple(DepositSwitchAltCreateResponse, Int32, Hash(String, Array(String) | String))
Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange.
-
#deposit_switch_create(*, deposit_switch_create_request : Plaid::DepositSwitchCreateRequest | Nil = nil) : DepositSwitchCreateResponse
Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
-
#deposit_switch_create(*, deposit_switch_create_request : Plaid::DepositSwitchCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
-
#deposit_switch_create_with_http_info(*, deposit_switch_create_request : Plaid::DepositSwitchCreateRequest | Nil = nil) : Tuple(DepositSwitchCreateResponse, Int32, Hash(String, Array(String) | String))
Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
-
#deposit_switch_get(*, deposit_switch_get_request : Plaid::DepositSwitchGetRequest | Nil = nil) : DepositSwitchGetResponse
Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch.
-
#deposit_switch_get(*, deposit_switch_get_request : Plaid::DepositSwitchGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch.
-
#deposit_switch_get_with_http_info(*, deposit_switch_get_request : Plaid::DepositSwitchGetRequest | Nil = nil) : Tuple(DepositSwitchGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch.
-
#deposit_switch_token_create(*, deposit_switch_token_create_request : Plaid::DepositSwitchTokenCreateRequest | Nil = nil) : DepositSwitchTokenCreateResponse
Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch.
-
#deposit_switch_token_create(*, deposit_switch_token_create_request : Plaid::DepositSwitchTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch.
-
#deposit_switch_token_create_with_http_info(*, deposit_switch_token_create_request : Plaid::DepositSwitchTokenCreateRequest | Nil = nil) : Tuple(DepositSwitchTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch.
-
#employers_search(*, employers_search_request : Plaid::EmployersSearchRequest | Nil = nil) : EmployersSearchResponse
Search employer database
/employers/search
allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. -
#employers_search(*, employers_search_request : Plaid::EmployersSearchRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Search employer database `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch.
-
#employers_search_with_http_info(*, employers_search_request : Plaid::EmployersSearchRequest | Nil = nil) : Tuple(EmployersSearchResponse, Int32, Hash(String, Array(String) | String))
Search employer database `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch.
-
#employment_verification_get(*, employment_verification_get_request : Plaid::EmploymentVerificationGetRequest | Nil = nil) : EmploymentVerificationGetResponse
(Deprecated) Retrieve a summary of an individual's employment information
/employment/verification/get
returns a list of employments through a user payroll that was verified by an end user. -
#employment_verification_get(*, employment_verification_get_request : Plaid::EmploymentVerificationGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
(Deprecated) Retrieve a summary of an individual's employment information `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
-
#employment_verification_get_with_http_info(*, employment_verification_get_request : Plaid::EmploymentVerificationGetRequest | Nil = nil) : Tuple(EmploymentVerificationGetResponse, Int32, Hash(String, Array(String) | String))
(Deprecated) Retrieve a summary of an individual's employment information `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
-
#fdx_notifications(*, fdx_notification : Plaid::FDXNotification | Nil = nil) : Nil
Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications @required @param fdx_notification [Plaid::FDXNotification?] @return [Nil]
-
#fdx_notifications(*, fdx_notification : Plaid::FDXNotification | Nil = nil, &block : Crest::Response -> ) : Nil
Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications @required @param fdx_notification [Plaid::FDXNotification?] @return nil
-
#fdx_notifications_with_http_info(*, fdx_notification : Plaid::FDXNotification | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))
Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications @required @param fdx_notification [Plaid::FDXNotification?] @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
-
#identity_get(*, identity_get_request : Plaid::IdentityGetRequest | Nil = nil) : IdentityGetResponse
Retrieve identity data The
/identity/get
endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. -
#identity_get(*, identity_get_request : Plaid::IdentityGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve identity data The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
-
#identity_get_with_http_info(*, identity_get_request : Plaid::IdentityGetRequest | Nil = nil) : Tuple(IdentityGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve identity data The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
-
#identity_match(*, identity_match_request : Plaid::IdentityMatchRequest | Nil = nil) : IdentityMatchResponse
Retrieve identity match score The
/identity/match
endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. -
#identity_match(*, identity_match_request : Plaid::IdentityMatchRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve identity match score The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.
-
#identity_match_with_http_info(*, identity_match_request : Plaid::IdentityMatchRequest | Nil = nil) : Tuple(IdentityMatchResponse, Int32, Hash(String, Array(String) | String))
Retrieve identity match score The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.
-
#identity_refresh(*, identity_refresh_request : Plaid::IdentityRefreshRequest | Nil = nil) : IdentityRefreshResponse
Refresh identity data
/identity/refresh
is an optional endpoint for users of the Identity product. -
#identity_refresh(*, identity_refresh_request : Plaid::IdentityRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh identity data `/identity/refresh` is an optional endpoint for users of the Identity product.
-
#identity_refresh_with_http_info(*, identity_refresh_request : Plaid::IdentityRefreshRequest | Nil = nil) : Tuple(IdentityRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh identity data `/identity/refresh` is an optional endpoint for users of the Identity product.
-
#identity_verification_create(*, identity_verification_create_request : Plaid::IdentityVerificationCreateRequest | Nil = nil) : IdentityVerificationCreateResponse
Create a new identity verification Create a new Identity Verification for the user specified by the
client_user_id
field. -
#identity_verification_create(*, identity_verification_create_request : Plaid::IdentityVerificationCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a new identity verification Create a new Identity Verification for the user specified by the `client_user_id` field.
-
#identity_verification_create_with_http_info(*, identity_verification_create_request : Plaid::IdentityVerificationCreateRequest | Nil = nil) : Tuple(IdentityVerificationCreateResponse, Int32, Hash(String, Array(String) | String))
Create a new identity verification Create a new Identity Verification for the user specified by the `client_user_id` field.
-
#identity_verification_get(*, identity_verification_get_request : Plaid::IdentityVerificationGetRequest | Nil = nil) : IdentityVerificationGetResponse
Retrieve Identity Verification Retrieve a previously created identity verification.
-
#identity_verification_get(*, identity_verification_get_request : Plaid::IdentityVerificationGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve Identity Verification Retrieve a previously created identity verification.
-
#identity_verification_get_with_http_info(*, identity_verification_get_request : Plaid::IdentityVerificationGetRequest | Nil = nil) : Tuple(IdentityVerificationGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve Identity Verification Retrieve a previously created identity verification.
-
#identity_verification_list(*, identity_verification_list_request : Plaid::IdentityVerificationListRequest | Nil = nil) : IdentityVerificationListResponse
List Identity Verifications Filter and list Identity Verifications created by your account @required @param identity_verification_list_request [Plaid::IdentityVerificationListRequest?] @return [IdentityVerificationListResponse]
-
#identity_verification_list(*, identity_verification_list_request : Plaid::IdentityVerificationListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List Identity Verifications Filter and list Identity Verifications created by your account @required @param identity_verification_list_request [Plaid::IdentityVerificationListRequest?] @return nil
-
#identity_verification_list_with_http_info(*, identity_verification_list_request : Plaid::IdentityVerificationListRequest | Nil = nil) : Tuple(IdentityVerificationListResponse, Int32, Hash(String, Array(String) | String))
List Identity Verifications Filter and list Identity Verifications created by your account @required @param identity_verification_list_request [Plaid::IdentityVerificationListRequest?] @return [Tuple(IdentityVerificationListResponse, Integer, Hash)] IdentityVerificationListResponse, response status code and response headers
-
#identity_verification_retry(*, identity_verification_retry_request : Plaid::IdentityVerificationRetryRequest | Nil = nil) : IdentityVerificationRetryResponse
Retry an Identity Verification Allow a customer to retry their identity verification @required @param identity_verification_retry_request [Plaid::IdentityVerificationRetryRequest?] @return [IdentityVerificationRetryResponse]
-
#identity_verification_retry(*, identity_verification_retry_request : Plaid::IdentityVerificationRetryRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retry an Identity Verification Allow a customer to retry their identity verification @required @param identity_verification_retry_request [Plaid::IdentityVerificationRetryRequest?] @return nil
-
#identity_verification_retry_with_http_info(*, identity_verification_retry_request : Plaid::IdentityVerificationRetryRequest | Nil = nil) : Tuple(IdentityVerificationRetryResponse, Int32, Hash(String, Array(String) | String))
Retry an Identity Verification Allow a customer to retry their identity verification @required @param identity_verification_retry_request [Plaid::IdentityVerificationRetryRequest?] @return [Tuple(IdentityVerificationRetryResponse, Integer, Hash)] IdentityVerificationRetryResponse, response status code and response headers
-
#income_verification_create(*, income_verification_create_request : Plaid::IncomeVerificationCreateRequest | Nil = nil) : IncomeVerificationCreateResponse
(Deprecated) Create an income verification instance
/income/verification/create
begins the income verification process by returning anincome_verification_id
. -
#income_verification_create(*, income_verification_create_request : Plaid::IncomeVerificationCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
(Deprecated) Create an income verification instance `/income/verification/create` begins the income verification process by returning an `income_verification_id`.
-
#income_verification_create_with_http_info(*, income_verification_create_request : Plaid::IncomeVerificationCreateRequest | Nil = nil) : Tuple(IncomeVerificationCreateResponse, Int32, Hash(String, Array(String) | String))
(Deprecated) Create an income verification instance `/income/verification/create` begins the income verification process by returning an `income_verification_id`.
-
#income_verification_documents_download(*, income_verification_documents_download_request : Plaid::IncomeVerificationDocumentsDownloadRequest | Nil = nil) : File
(Deprecated) Download the original documents used for income verification
/income/verification/documents/download
provides the ability to download the source documents associated with the verification. -
#income_verification_documents_download(*, income_verification_documents_download_request : Plaid::IncomeVerificationDocumentsDownloadRequest | Nil = nil, &block : Crest::Response -> ) : Nil
(Deprecated) Download the original documents used for income verification `/income/verification/documents/download` provides the ability to download the source documents associated with the verification.
-
#income_verification_documents_download_with_http_info(*, income_verification_documents_download_request : Plaid::IncomeVerificationDocumentsDownloadRequest | Nil = nil) : Tuple(File, Int32, Hash(String, Array(String) | String))
(Deprecated) Download the original documents used for income verification `/income/verification/documents/download` provides the ability to download the source documents associated with the verification.
-
#income_verification_paystubs_get(*, income_verification_paystubs_get_request : Plaid::IncomeVerificationPaystubsGetRequest | Nil = nil) : IncomeVerificationPaystubsGetResponse
(Deprecated) Retrieve information from the paystubs used for income verification
/income/verification/paystubs/get
returns the information collected from the paystubs that were used to verify an end user's income. -
#income_verification_paystubs_get(*, income_verification_paystubs_get_request : Plaid::IncomeVerificationPaystubsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
(Deprecated) Retrieve information from the paystubs used for income verification `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income.
-
#income_verification_paystubs_get_with_http_info(*, income_verification_paystubs_get_request : Plaid::IncomeVerificationPaystubsGetRequest | Nil = nil) : Tuple(IncomeVerificationPaystubsGetResponse, Int32, Hash(String, Array(String) | String))
(Deprecated) Retrieve information from the paystubs used for income verification `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income.
-
#income_verification_precheck(*, income_verification_precheck_request : Plaid::IncomeVerificationPrecheckRequest | Nil = nil) : IncomeVerificationPrecheckResponse
(Deprecated) Check digital income verification eligibility and optimize conversion
/income/verification/precheck
is an optional endpoint that can be called before initializing a Link session for income verification. -
#income_verification_precheck(*, income_verification_precheck_request : Plaid::IncomeVerificationPrecheckRequest | Nil = nil, &block : Crest::Response -> ) : Nil
(Deprecated) Check digital income verification eligibility and optimize conversion `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification.
-
#income_verification_precheck_with_http_info(*, income_verification_precheck_request : Plaid::IncomeVerificationPrecheckRequest | Nil = nil) : Tuple(IncomeVerificationPrecheckResponse, Int32, Hash(String, Array(String) | String))
(Deprecated) Check digital income verification eligibility and optimize conversion `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification.
-
#income_verification_taxforms_get(*, income_verification_taxforms_get_request : Plaid::IncomeVerificationTaxformsGetRequest | Nil = nil) : IncomeVerificationTaxformsGetResponse
(Deprecated) Retrieve information from the tax documents used for income verification
/income/verification/taxforms/get
returns the information collected from forms that were used to verify an end user''s income. -
#income_verification_taxforms_get(*, income_verification_taxforms_get_request : Plaid::IncomeVerificationTaxformsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
(Deprecated) Retrieve information from the tax documents used for income verification `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income.
-
#income_verification_taxforms_get_with_http_info(*, income_verification_taxforms_get_request : Plaid::IncomeVerificationTaxformsGetRequest | Nil = nil) : Tuple(IncomeVerificationTaxformsGetResponse, Int32, Hash(String, Array(String) | String))
(Deprecated) Retrieve information from the tax documents used for income verification `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income.
-
#institutions_get(*, institutions_get_request : Plaid::InstitutionsGetRequest | Nil = nil) : InstitutionsGetResponse
Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid.
-
#institutions_get(*, institutions_get_request : Plaid::InstitutionsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid.
-
#institutions_get_by_id(*, institutions_get_by_id_request : Plaid::InstitutionsGetByIdRequest | Nil = nil) : InstitutionsGetByIdResponse
Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
-
#institutions_get_by_id(*, institutions_get_by_id_request : Plaid::InstitutionsGetByIdRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
-
#institutions_get_by_id_with_http_info(*, institutions_get_by_id_request : Plaid::InstitutionsGetByIdRequest | Nil = nil) : Tuple(InstitutionsGetByIdResponse, Int32, Hash(String, Array(String) | String))
Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
-
#institutions_get_with_http_info(*, institutions_get_request : Plaid::InstitutionsGetRequest | Nil = nil) : Tuple(InstitutionsGetResponse, Int32, Hash(String, Array(String) | String))
Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid.
-
#institutions_search(*, institutions_search_request : Plaid::InstitutionsSearchRequest | Nil = nil) : InstitutionsSearchResponse
Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
-
#institutions_search(*, institutions_search_request : Plaid::InstitutionsSearchRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
-
#institutions_search_with_http_info(*, institutions_search_request : Plaid::InstitutionsSearchRequest | Nil = nil) : Tuple(InstitutionsSearchResponse, Int32, Hash(String, Array(String) | String))
Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
-
#investments_auth_get(*, investments_auth_get_request : Plaid::InvestmentsAuthGetRequest | Nil = nil) : InvestmentsAuthGetResponse
Get data needed to authorize an investments transfer The
/investments/auth/get
endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings @required @param investments_auth_get_request [Plaid::InvestmentsAuthGetRequest?] @return [InvestmentsAuthGetResponse] -
#investments_auth_get(*, investments_auth_get_request : Plaid::InvestmentsAuthGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get data needed to authorize an investments transfer The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings @required @param investments_auth_get_request [Plaid::InvestmentsAuthGetRequest?] @return nil
-
#investments_auth_get_with_http_info(*, investments_auth_get_request : Plaid::InvestmentsAuthGetRequest | Nil = nil) : Tuple(InvestmentsAuthGetResponse, Int32, Hash(String, Array(String) | String))
Get data needed to authorize an investments transfer The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings @required @param investments_auth_get_request [Plaid::InvestmentsAuthGetRequest?] @return [Tuple(InvestmentsAuthGetResponse, Integer, Hash)] InvestmentsAuthGetResponse, response status code and response headers
-
#investments_holdings_get(*, investments_holdings_get_request : Plaid::InvestmentsHoldingsGetRequest | Nil = nil) : InvestmentsHoldingsGetResponse
Get Investment holdings The
/investments/holdings/get
endpoint allows developers to receive user-authorized stock position data forinvestment
-type accounts. -
#investments_holdings_get(*, investments_holdings_get_request : Plaid::InvestmentsHoldingsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get Investment holdings The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
-
#investments_holdings_get_with_http_info(*, investments_holdings_get_request : Plaid::InvestmentsHoldingsGetRequest | Nil = nil) : Tuple(InvestmentsHoldingsGetResponse, Int32, Hash(String, Array(String) | String))
Get Investment holdings The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
-
#investments_refresh(*, investments_refresh_request : Plaid::InvestmentsRefreshRequest | Nil = nil) : InvestmentsRefreshResponse
Refresh investment data
/investments/refresh
is an optional endpoint for users of the Investments product. -
#investments_refresh(*, investments_refresh_request : Plaid::InvestmentsRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh investment data `/investments/refresh` is an optional endpoint for users of the Investments product.
-
#investments_refresh_with_http_info(*, investments_refresh_request : Plaid::InvestmentsRefreshRequest | Nil = nil) : Tuple(InvestmentsRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh investment data `/investments/refresh` is an optional endpoint for users of the Investments product.
-
#investments_transactions_get(*, investments_transactions_get_request : Plaid::InvestmentsTransactionsGetRequest | Nil = nil) : InvestmentsTransactionsGetResponse
Get investment transactions The
/investments/transactions/get
endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. -
#investments_transactions_get(*, investments_transactions_get_request : Plaid::InvestmentsTransactionsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get investment transactions The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts.
-
#investments_transactions_get_with_http_info(*, investments_transactions_get_request : Plaid::InvestmentsTransactionsGetRequest | Nil = nil) : Tuple(InvestmentsTransactionsGetResponse, Int32, Hash(String, Array(String) | String))
Get investment transactions The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts.
-
#item_access_token_invalidate(*, item_access_token_invalidate_request : Plaid::ItemAccessTokenInvalidateRequest | Nil = nil) : ItemAccessTokenInvalidateResponse
Invalidate access_token By default, the
access_token
associated with an Item does not expire and should be stored in a persistent, secure manner. -
#item_access_token_invalidate(*, item_access_token_invalidate_request : Plaid::ItemAccessTokenInvalidateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Invalidate access_token By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner.
-
#item_access_token_invalidate_with_http_info(*, item_access_token_invalidate_request : Plaid::ItemAccessTokenInvalidateRequest | Nil = nil) : Tuple(ItemAccessTokenInvalidateResponse, Int32, Hash(String, Array(String) | String))
Invalidate access_token By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner.
-
#item_activity_list(*, item_activity_list_request : Plaid::ItemActivityListRequest | Nil = nil) : ItemActivityListResponse
List a historical log of user consent events List a historical log of user consent events @required @param item_activity_list_request [Plaid::ItemActivityListRequest?] @return [ItemActivityListResponse]
-
#item_activity_list(*, item_activity_list_request : Plaid::ItemActivityListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List a historical log of user consent events List a historical log of user consent events @required @param item_activity_list_request [Plaid::ItemActivityListRequest?] @return nil
-
#item_activity_list_with_http_info(*, item_activity_list_request : Plaid::ItemActivityListRequest | Nil = nil) : Tuple(ItemActivityListResponse, Int32, Hash(String, Array(String) | String))
List a historical log of user consent events List a historical log of user consent events @required @param item_activity_list_request [Plaid::ItemActivityListRequest?] @return [Tuple(ItemActivityListResponse, Integer, Hash)] ItemActivityListResponse, response status code and response headers
-
#item_application_list(*, item_application_list_request : Plaid::ItemApplicationListRequest | Nil = nil) : ItemApplicationListResponse
List a user’s connected applications List a user’s connected applications @required @param item_application_list_request [Plaid::ItemApplicationListRequest?] @return [ItemApplicationListResponse]
-
#item_application_list(*, item_application_list_request : Plaid::ItemApplicationListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List a user’s connected applications List a user’s connected applications @required @param item_application_list_request [Plaid::ItemApplicationListRequest?] @return nil
-
#item_application_list_with_http_info(*, item_application_list_request : Plaid::ItemApplicationListRequest | Nil = nil) : Tuple(ItemApplicationListResponse, Int32, Hash(String, Array(String) | String))
List a user’s connected applications List a user’s connected applications @required @param item_application_list_request [Plaid::ItemApplicationListRequest?] @return [Tuple(ItemApplicationListResponse, Integer, Hash)] ItemApplicationListResponse, response status code and response headers
-
#item_application_scopes_update(*, item_application_scopes_update_request : Plaid::ItemApplicationScopesUpdateRequest | Nil = nil) : ItemApplicationScopesUpdateResponse
Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application.
-
#item_application_scopes_update(*, item_application_scopes_update_request : Plaid::ItemApplicationScopesUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application.
-
#item_application_scopes_update_with_http_info(*, item_application_scopes_update_request : Plaid::ItemApplicationScopesUpdateRequest | Nil = nil) : Tuple(ItemApplicationScopesUpdateResponse, Int32, Hash(String, Array(String) | String))
Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application.
-
#item_application_unlink(*, item_application_unlink_request : Plaid::ItemApplicationUnlinkRequest | Nil = nil) : ItemApplicationUnlinkResponse
Unlink a user’s connected application Unlink a user’s connected application.
-
#item_application_unlink(*, item_application_unlink_request : Plaid::ItemApplicationUnlinkRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Unlink a user’s connected application Unlink a user’s connected application.
-
#item_application_unlink_with_http_info(*, item_application_unlink_request : Plaid::ItemApplicationUnlinkRequest | Nil = nil) : Tuple(ItemApplicationUnlinkResponse, Int32, Hash(String, Array(String) | String))
Unlink a user’s connected application Unlink a user’s connected application.
-
#item_create_public_token(*, item_public_token_create_request : Plaid::ItemPublicTokenCreateRequest | Nil = nil) : ItemPublicTokenCreateResponse
Create public token Note: As of July 2020, the
/item/public_token/create
endpoint is deprecated. -
#item_create_public_token(*, item_public_token_create_request : Plaid::ItemPublicTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create public token Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated.
-
#item_create_public_token_with_http_info(*, item_public_token_create_request : Plaid::ItemPublicTokenCreateRequest | Nil = nil) : Tuple(ItemPublicTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create public token Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated.
-
#item_get(*, item_get_request : Plaid::ItemGetRequest | Nil = nil) : ItemGetResponse
Retrieve an Item Returns information about the status of an Item.
-
#item_get(*, item_get_request : Plaid::ItemGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve an Item Returns information about the status of an Item.
-
#item_get_with_http_info(*, item_get_request : Plaid::ItemGetRequest | Nil = nil) : Tuple(ItemGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve an Item Returns information about the status of an Item.
-
#item_import(*, item_import_request : Plaid::ItemImportRequest | Nil = nil) : ItemImportResponse
Import Item
/item/import
creates an Item via your Plaid Exchange Integration and returns anaccess_token
. -
#item_import(*, item_import_request : Plaid::ItemImportRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Import Item `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`.
-
#item_import_with_http_info(*, item_import_request : Plaid::ItemImportRequest | Nil = nil) : Tuple(ItemImportResponse, Int32, Hash(String, Array(String) | String))
Import Item `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`.
-
#item_public_token_exchange(*, item_public_token_exchange_request : Plaid::ItemPublicTokenExchangeRequest | Nil = nil) : ItemPublicTokenExchangeResponse
Exchange public token for an access token Exchange a Link
public_token
for an APIaccess_token
. -
#item_public_token_exchange(*, item_public_token_exchange_request : Plaid::ItemPublicTokenExchangeRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Exchange public token for an access token Exchange a Link `public_token` for an API `access_token`.
-
#item_public_token_exchange_with_http_info(*, item_public_token_exchange_request : Plaid::ItemPublicTokenExchangeRequest | Nil = nil) : Tuple(ItemPublicTokenExchangeResponse, Int32, Hash(String, Array(String) | String))
Exchange public token for an access token Exchange a Link `public_token` for an API `access_token`.
-
#item_remove(*, item_remove_request : Plaid::ItemRemoveRequest | Nil = nil) : ItemRemoveResponse
Remove an Item The
/item/remove
endpoint allows you to remove an Item. -
#item_remove(*, item_remove_request : Plaid::ItemRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Remove an Item The `/item/remove` endpoint allows you to remove an Item.
-
#item_remove_with_http_info(*, item_remove_request : Plaid::ItemRemoveRequest | Nil = nil) : Tuple(ItemRemoveResponse, Int32, Hash(String, Array(String) | String))
Remove an Item The `/item/remove` endpoint allows you to remove an Item.
-
#item_webhook_update(*, item_webhook_update_request : Plaid::ItemWebhookUpdateRequest | Nil = nil) : ItemWebhookUpdateResponse
Update Webhook URL The POST
/item/webhook/update
allows you to update the webhook URL associated with an Item. -
#item_webhook_update(*, item_webhook_update_request : Plaid::ItemWebhookUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update Webhook URL The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item.
-
#item_webhook_update_with_http_info(*, item_webhook_update_request : Plaid::ItemWebhookUpdateRequest | Nil = nil) : Tuple(ItemWebhookUpdateResponse, Int32, Hash(String, Array(String) | String))
Update Webhook URL The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item.
-
#liabilities_get(*, liabilities_get_request : Plaid::LiabilitiesGetRequest | Nil = nil) : LiabilitiesGetResponse
Retrieve Liabilities data The
/liabilities/get
endpoint returns various details about an Item with loan or credit accounts. -
#liabilities_get(*, liabilities_get_request : Plaid::LiabilitiesGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve Liabilities data The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts.
-
#liabilities_get_with_http_info(*, liabilities_get_request : Plaid::LiabilitiesGetRequest | Nil = nil) : Tuple(LiabilitiesGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve Liabilities data The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts.
-
#link_delivery_create(*, link_delivery_create_request : Plaid::LinkDeliveryCreateRequest | Nil = nil) : LinkDeliveryCreateResponse
Create Hosted Link session Use the
/link_delivery/create
endpoint to create a Hosted Link session. -
#link_delivery_create(*, link_delivery_create_request : Plaid::LinkDeliveryCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create Hosted Link session Use the `/link_delivery/create` endpoint to create a Hosted Link session.
-
#link_delivery_create_with_http_info(*, link_delivery_create_request : Plaid::LinkDeliveryCreateRequest | Nil = nil) : Tuple(LinkDeliveryCreateResponse, Int32, Hash(String, Array(String) | String))
Create Hosted Link session Use the `/link_delivery/create` endpoint to create a Hosted Link session.
-
#link_delivery_get(*, link_delivery_get_request : Plaid::LinkDeliveryGetRequest | Nil = nil) : LinkDeliveryGetResponse
Get Hosted Link session Use the
/link_delivery/get
endpoint to get the status of a Hosted Link session. -
#link_delivery_get(*, link_delivery_get_request : Plaid::LinkDeliveryGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get Hosted Link session Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session.
-
#link_delivery_get_with_http_info(*, link_delivery_get_request : Plaid::LinkDeliveryGetRequest | Nil = nil) : Tuple(LinkDeliveryGetResponse, Int32, Hash(String, Array(String) | String))
Get Hosted Link session Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session.
-
#link_oauth_correlation_id_exchange(*, link_o_auth_correlation_id_exchange_request : Plaid::LinkOAuthCorrelationIdExchangeRequest | Nil = nil) : LinkOAuthCorrelationIdExchangeResponse
Exchange the Link Correlation Id for a Link Token Exchange an OAuth
link_correlation_id
for the correspondinglink_token
. -
#link_oauth_correlation_id_exchange(*, link_o_auth_correlation_id_exchange_request : Plaid::LinkOAuthCorrelationIdExchangeRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Exchange the Link Correlation Id for a Link Token Exchange an OAuth `link_correlation_id` for the corresponding `link_token`.
-
#link_oauth_correlation_id_exchange_with_http_info(*, link_o_auth_correlation_id_exchange_request : Plaid::LinkOAuthCorrelationIdExchangeRequest | Nil = nil) : Tuple(LinkOAuthCorrelationIdExchangeResponse, Int32, Hash(String, Array(String) | String))
Exchange the Link Correlation Id for a Link Token Exchange an OAuth `link_correlation_id` for the corresponding `link_token`.
-
#link_token_create(*, link_token_create_request : Plaid::LinkTokenCreateRequest | Nil = nil) : LinkTokenCreateResponse
Create Link Token The
/link/token/create
endpoint creates alink_token
, which is required as a parameter when initializing Link. -
#link_token_create(*, link_token_create_request : Plaid::LinkTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create Link Token The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link.
-
#link_token_create_with_http_info(*, link_token_create_request : Plaid::LinkTokenCreateRequest | Nil = nil) : Tuple(LinkTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create Link Token The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link.
-
#link_token_get(*, link_token_get_request : Plaid::LinkTokenGetRequest | Nil = nil) : LinkTokenGetResponse
Get Link Token The
/link/token/get
endpoint gets information about a previously-createdlink_token
using the/link/token/create
endpoint. -
#link_token_get(*, link_token_get_request : Plaid::LinkTokenGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get Link Token The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint.
-
#link_token_get_with_http_info(*, link_token_get_request : Plaid::LinkTokenGetRequest | Nil = nil) : Tuple(LinkTokenGetResponse, Int32, Hash(String, Array(String) | String))
Get Link Token The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint.
-
#partner_customer_create(*, partner_customer_create_request : Plaid::PartnerCustomerCreateRequest | Nil = nil) : PartnerCustomerCreateResponse
Creates a new end customer for a Plaid reseller.
-
#partner_customer_create(*, partner_customer_create_request : Plaid::PartnerCustomerCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Creates a new end customer for a Plaid reseller.
-
#partner_customer_create_with_http_info(*, partner_customer_create_request : Plaid::PartnerCustomerCreateRequest | Nil = nil) : Tuple(PartnerCustomerCreateResponse, Int32, Hash(String, Array(String) | String))
Creates a new end customer for a Plaid reseller.
-
#partner_customer_enable(*, partner_customer_enable_request : Plaid::PartnerCustomerEnableRequest | Nil = nil) : PartnerCustomerEnableResponse
Enables a Plaid reseller's end customer in the Production environment.
-
#partner_customer_enable(*, partner_customer_enable_request : Plaid::PartnerCustomerEnableRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Enables a Plaid reseller's end customer in the Production environment.
-
#partner_customer_enable_with_http_info(*, partner_customer_enable_request : Plaid::PartnerCustomerEnableRequest | Nil = nil) : Tuple(PartnerCustomerEnableResponse, Int32, Hash(String, Array(String) | String))
Enables a Plaid reseller's end customer in the Production environment.
-
#partner_customer_get(*, partner_customer_get_request : Plaid::PartnerCustomerGetRequest | Nil = nil) : PartnerCustomerGetResponse
Returns a Plaid reseller's end customer.
-
#partner_customer_get(*, partner_customer_get_request : Plaid::PartnerCustomerGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Returns a Plaid reseller's end customer.
-
#partner_customer_get_with_http_info(*, partner_customer_get_request : Plaid::PartnerCustomerGetRequest | Nil = nil) : Tuple(PartnerCustomerGetResponse, Int32, Hash(String, Array(String) | String))
Returns a Plaid reseller's end customer.
-
#partner_customer_oauth_institutions_get(*, partner_customer_o_auth_institutions_get_request : Plaid::PartnerCustomerOAuthInstitutionsGetRequest | Nil = nil) : PartnerCustomerOAuthInstitutionsGetResponse
Returns OAuth-institution registration information for a given end customer.
-
#partner_customer_oauth_institutions_get(*, partner_customer_o_auth_institutions_get_request : Plaid::PartnerCustomerOAuthInstitutionsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Returns OAuth-institution registration information for a given end customer.
-
#partner_customer_oauth_institutions_get_with_http_info(*, partner_customer_o_auth_institutions_get_request : Plaid::PartnerCustomerOAuthInstitutionsGetRequest | Nil = nil) : Tuple(PartnerCustomerOAuthInstitutionsGetResponse, Int32, Hash(String, Array(String) | String))
Returns OAuth-institution registration information for a given end customer.
-
#partner_customer_remove(*, partner_customer_remove_request : Plaid::PartnerCustomerRemoveRequest | Nil = nil) : PartnerCustomerRemoveResponse
Removes a Plaid reseller's end customer.
-
#partner_customer_remove(*, partner_customer_remove_request : Plaid::PartnerCustomerRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Removes a Plaid reseller's end customer.
-
#partner_customer_remove_with_http_info(*, partner_customer_remove_request : Plaid::PartnerCustomerRemoveRequest | Nil = nil) : Tuple(PartnerCustomerRemoveResponse, Int32, Hash(String, Array(String) | String))
Removes a Plaid reseller's end customer.
-
#payment_initiation_consent_create(*, payment_initiation_consent_create_request : Plaid::PaymentInitiationConsentCreateRequest | Nil = nil) : PaymentInitiationConsentCreateResponse
Create payment consent The
/payment_initiation/consent/create
endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. -
#payment_initiation_consent_create(*, payment_initiation_consent_create_request : Plaid::PaymentInitiationConsentCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create payment consent The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user.
-
#payment_initiation_consent_create_with_http_info(*, payment_initiation_consent_create_request : Plaid::PaymentInitiationConsentCreateRequest | Nil = nil) : Tuple(PaymentInitiationConsentCreateResponse, Int32, Hash(String, Array(String) | String))
Create payment consent The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user.
-
#payment_initiation_consent_get(*, payment_initiation_consent_get_request : Plaid::PaymentInitiationConsentGetRequest | Nil = nil) : Plaid::PaymentInitiationConsentGetResponse
Get payment consent The
/payment_initiation/consent/get
endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints. -
#payment_initiation_consent_get(*, payment_initiation_consent_get_request : Plaid::PaymentInitiationConsentGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get payment consent The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.
-
#payment_initiation_consent_get_with_http_info(*, payment_initiation_consent_get_request : Plaid::PaymentInitiationConsentGetRequest | Nil = nil) : Tuple(Plaid::PaymentInitiationConsentGetResponse, Int32, Hash(String, Array(String) | String))
Get payment consent The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.
-
#payment_initiation_consent_payment_execute(*, payment_initiation_consent_payment_execute_request : Plaid::PaymentInitiationConsentPaymentExecuteRequest | Nil = nil) : PaymentInitiationConsentPaymentExecuteResponse
Execute a single payment using consent The
/payment_initiation/consent/payment/execute
endpoint can be used to execute payments using payment consent. -
#payment_initiation_consent_payment_execute(*, payment_initiation_consent_payment_execute_request : Plaid::PaymentInitiationConsentPaymentExecuteRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Execute a single payment using consent The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent.
-
#payment_initiation_consent_payment_execute_with_http_info(*, payment_initiation_consent_payment_execute_request : Plaid::PaymentInitiationConsentPaymentExecuteRequest | Nil = nil) : Tuple(PaymentInitiationConsentPaymentExecuteResponse, Int32, Hash(String, Array(String) | String))
Execute a single payment using consent The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent.
-
#payment_initiation_consent_revoke(*, payment_initiation_consent_revoke_request : Plaid::PaymentInitiationConsentRevokeRequest | Nil = nil) : PaymentInitiationConsentRevokeResponse
Revoke payment consent The
/payment_initiation/consent/revoke
endpoint can be used to revoke the payment consent. -
#payment_initiation_consent_revoke(*, payment_initiation_consent_revoke_request : Plaid::PaymentInitiationConsentRevokeRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Revoke payment consent The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent.
-
#payment_initiation_consent_revoke_with_http_info(*, payment_initiation_consent_revoke_request : Plaid::PaymentInitiationConsentRevokeRequest | Nil = nil) : Tuple(PaymentInitiationConsentRevokeResponse, Int32, Hash(String, Array(String) | String))
Revoke payment consent The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent.
-
#payment_initiation_payment_create(*, payment_initiation_payment_create_request : Plaid::PaymentInitiationPaymentCreateRequest | Nil = nil) : PaymentInitiationPaymentCreateResponse
Create a payment After creating a payment recipient, you can use the
/payment_initiation/payment/create
endpoint to create a payment to that recipient. -
#payment_initiation_payment_create(*, payment_initiation_payment_create_request : Plaid::PaymentInitiationPaymentCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a payment After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient.
-
#payment_initiation_payment_create_with_http_info(*, payment_initiation_payment_create_request : Plaid::PaymentInitiationPaymentCreateRequest | Nil = nil) : Tuple(PaymentInitiationPaymentCreateResponse, Int32, Hash(String, Array(String) | String))
Create a payment After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient.
-
#payment_initiation_payment_get(*, payment_initiation_payment_get_request : Plaid::PaymentInitiationPaymentGetRequest | Nil = nil) : Plaid::PaymentInitiationPaymentGetResponse
Get payment details The
/payment_initiation/payment/get
endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. -
#payment_initiation_payment_get(*, payment_initiation_payment_get_request : Plaid::PaymentInitiationPaymentGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get payment details The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount.
-
#payment_initiation_payment_get_with_http_info(*, payment_initiation_payment_get_request : Plaid::PaymentInitiationPaymentGetRequest | Nil = nil) : Tuple(Plaid::PaymentInitiationPaymentGetResponse, Int32, Hash(String, Array(String) | String))
Get payment details The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount.
-
#payment_initiation_payment_list(*, payment_initiation_payment_list_request : Plaid::PaymentInitiationPaymentListRequest | Nil = nil) : PaymentInitiationPaymentListResponse
List payments The
/payment_initiation/payment/list
endpoint can be used to retrieve all created payments. -
#payment_initiation_payment_list(*, payment_initiation_payment_list_request : Plaid::PaymentInitiationPaymentListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List payments The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments.
-
#payment_initiation_payment_list_with_http_info(*, payment_initiation_payment_list_request : Plaid::PaymentInitiationPaymentListRequest | Nil = nil) : Tuple(PaymentInitiationPaymentListResponse, Int32, Hash(String, Array(String) | String))
List payments The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments.
-
#payment_initiation_payment_reverse(*, payment_initiation_payment_reverse_request : Plaid::PaymentInitiationPaymentReverseRequest | Nil = nil) : PaymentInitiationPaymentReverseResponse
Reverse an existing payment Reverse a settled payment from a Plaid virtual account.
-
#payment_initiation_payment_reverse(*, payment_initiation_payment_reverse_request : Plaid::PaymentInitiationPaymentReverseRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Reverse an existing payment Reverse a settled payment from a Plaid virtual account.
-
#payment_initiation_payment_reverse_with_http_info(*, payment_initiation_payment_reverse_request : Plaid::PaymentInitiationPaymentReverseRequest | Nil = nil) : Tuple(PaymentInitiationPaymentReverseResponse, Int32, Hash(String, Array(String) | String))
Reverse an existing payment Reverse a settled payment from a Plaid virtual account.
-
#payment_initiation_recipient_create(*, payment_initiation_recipient_create_request : Plaid::PaymentInitiationRecipientCreateRequest | Nil = nil) : PaymentInitiationRecipientCreateResponse
Create payment recipient Create a payment recipient for payment initiation.
-
#payment_initiation_recipient_create(*, payment_initiation_recipient_create_request : Plaid::PaymentInitiationRecipientCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create payment recipient Create a payment recipient for payment initiation.
-
#payment_initiation_recipient_create_with_http_info(*, payment_initiation_recipient_create_request : Plaid::PaymentInitiationRecipientCreateRequest | Nil = nil) : Tuple(PaymentInitiationRecipientCreateResponse, Int32, Hash(String, Array(String) | String))
Create payment recipient Create a payment recipient for payment initiation.
-
#payment_initiation_recipient_get(*, payment_initiation_recipient_get_request : Plaid::PaymentInitiationRecipientGetRequest | Nil = nil) : Plaid::PaymentInitiationRecipientGetResponse
Get payment recipient Get details about a payment recipient you have previously created.
-
#payment_initiation_recipient_get(*, payment_initiation_recipient_get_request : Plaid::PaymentInitiationRecipientGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get payment recipient Get details about a payment recipient you have previously created.
-
#payment_initiation_recipient_get_with_http_info(*, payment_initiation_recipient_get_request : Plaid::PaymentInitiationRecipientGetRequest | Nil = nil) : Tuple(Plaid::PaymentInitiationRecipientGetResponse, Int32, Hash(String, Array(String) | String))
Get payment recipient Get details about a payment recipient you have previously created.
-
#payment_initiation_recipient_list(*, payment_initiation_recipient_list_request : Plaid::PaymentInitiationRecipientListRequest | Nil = nil) : PaymentInitiationRecipientListResponse
List payment recipients The
/payment_initiation/recipient/list
endpoint list the payment recipients that you have previously created. -
#payment_initiation_recipient_list(*, payment_initiation_recipient_list_request : Plaid::PaymentInitiationRecipientListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List payment recipients The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
-
#payment_initiation_recipient_list_with_http_info(*, payment_initiation_recipient_list_request : Plaid::PaymentInitiationRecipientListRequest | Nil = nil) : Tuple(PaymentInitiationRecipientListResponse, Int32, Hash(String, Array(String) | String))
List payment recipients The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
-
#payment_profile_create(*, payment_profile_create_request : Plaid::PaymentProfileCreateRequest | Nil = nil) : PaymentProfileCreateResponse
Create payment profile Use
/payment_profile/create
endpoint to create a new payment profile. -
#payment_profile_create(*, payment_profile_create_request : Plaid::PaymentProfileCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create payment profile Use `/payment_profile/create` endpoint to create a new payment profile.
-
#payment_profile_create_with_http_info(*, payment_profile_create_request : Plaid::PaymentProfileCreateRequest | Nil = nil) : Tuple(PaymentProfileCreateResponse, Int32, Hash(String, Array(String) | String))
Create payment profile Use `/payment_profile/create` endpoint to create a new payment profile.
-
#payment_profile_get(*, payment_profile_get_request : Plaid::PaymentProfileGetRequest | Nil = nil) : PaymentProfileGetResponse
Get payment profile Use
/payment_profile/get
endpoint to get the status of a given Payment Profile. -
#payment_profile_get(*, payment_profile_get_request : Plaid::PaymentProfileGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get payment profile Use `/payment_profile/get` endpoint to get the status of a given Payment Profile.
-
#payment_profile_get_with_http_info(*, payment_profile_get_request : Plaid::PaymentProfileGetRequest | Nil = nil) : Tuple(PaymentProfileGetResponse, Int32, Hash(String, Array(String) | String))
Get payment profile Use `/payment_profile/get` endpoint to get the status of a given Payment Profile.
-
#payment_profile_remove(*, payment_profile_remove_request : Plaid::PaymentProfileRemoveRequest | Nil = nil) : PaymentProfileRemoveResponse
Remove payment profile Use the
/payment_profile/remove
endpoint to remove a given Payment Profile. -
#payment_profile_remove(*, payment_profile_remove_request : Plaid::PaymentProfileRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Remove payment profile Use the `/payment_profile/remove` endpoint to remove a given Payment Profile.
-
#payment_profile_remove_with_http_info(*, payment_profile_remove_request : Plaid::PaymentProfileRemoveRequest | Nil = nil) : Tuple(PaymentProfileRemoveResponse, Int32, Hash(String, Array(String) | String))
Remove payment profile Use the `/payment_profile/remove` endpoint to remove a given Payment Profile.
-
#processor_account_get(*, processor_account_get_request : Plaid::ProcessorAccountGetRequest | Nil = nil) : ProcessorAccountGetResponse
Retrieve the account associated with a processor token This endpoint returns the account associated with a given processor token.
-
#processor_account_get(*, processor_account_get_request : Plaid::ProcessorAccountGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve the account associated with a processor token This endpoint returns the account associated with a given processor token.
-
#processor_account_get_with_http_info(*, processor_account_get_request : Plaid::ProcessorAccountGetRequest | Nil = nil) : Tuple(ProcessorAccountGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve the account associated with a processor token This endpoint returns the account associated with a given processor token.
-
#processor_apex_processor_token_create(*, processor_apex_processor_token_create_request : Plaid::ProcessorApexProcessorTokenCreateRequest | Nil = nil) : ProcessorTokenCreateResponse
Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
-
#processor_apex_processor_token_create(*, processor_apex_processor_token_create_request : Plaid::ProcessorApexProcessorTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
-
#processor_apex_processor_token_create_with_http_info(*, processor_apex_processor_token_create_request : Plaid::ProcessorApexProcessorTokenCreateRequest | Nil = nil) : Tuple(ProcessorTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
-
#processor_auth_get(*, processor_auth_get_request : Plaid::ProcessorAuthGetRequest | Nil = nil) : ProcessorAuthGetResponse
Retrieve Auth data The
/processor/auth/get
endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a givenprocessor_token
. -
#processor_auth_get(*, processor_auth_get_request : Plaid::ProcessorAuthGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve Auth data The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`.
-
#processor_auth_get_with_http_info(*, processor_auth_get_request : Plaid::ProcessorAuthGetRequest | Nil = nil) : Tuple(ProcessorAuthGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve Auth data The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`.
-
#processor_balance_get(*, processor_balance_get_request : Plaid::ProcessorBalanceGetRequest | Nil = nil) : ProcessorBalanceGetResponse
Retrieve Balance data The
/processor/balance/get
endpoint returns the real-time balance for each of an Item's accounts. -
#processor_balance_get(*, processor_balance_get_request : Plaid::ProcessorBalanceGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve Balance data The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts.
-
#processor_balance_get_with_http_info(*, processor_balance_get_request : Plaid::ProcessorBalanceGetRequest | Nil = nil) : Tuple(ProcessorBalanceGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve Balance data The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts.
-
#processor_bank_transfer_create(*, processor_bank_transfer_create_request : Plaid::ProcessorBankTransferCreateRequest | Nil = nil) : ProcessorBankTransferCreateResponse
Create a bank transfer as a processor Use the
/processor/bank_transfer/create
endpoint to initiate a new bank transfer as a processor @required @param processor_bank_transfer_create_request [Plaid::ProcessorBankTransferCreateRequest?] @return [ProcessorBankTransferCreateResponse] -
#processor_bank_transfer_create(*, processor_bank_transfer_create_request : Plaid::ProcessorBankTransferCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a bank transfer as a processor Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor @required @param processor_bank_transfer_create_request [Plaid::ProcessorBankTransferCreateRequest?] @return nil
-
#processor_bank_transfer_create_with_http_info(*, processor_bank_transfer_create_request : Plaid::ProcessorBankTransferCreateRequest | Nil = nil) : Tuple(ProcessorBankTransferCreateResponse, Int32, Hash(String, Array(String) | String))
Create a bank transfer as a processor Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor @required @param processor_bank_transfer_create_request [Plaid::ProcessorBankTransferCreateRequest?] @return [Tuple(ProcessorBankTransferCreateResponse, Integer, Hash)] ProcessorBankTransferCreateResponse, response status code and response headers
-
#processor_identity_get(*, processor_identity_get_request : Plaid::ProcessorIdentityGetRequest | Nil = nil) : ProcessorIdentityGetResponse
Retrieve Identity data The
/processor/identity/get
endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. -
#processor_identity_get(*, processor_identity_get_request : Plaid::ProcessorIdentityGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve Identity data The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
-
#processor_identity_get_with_http_info(*, processor_identity_get_request : Plaid::ProcessorIdentityGetRequest | Nil = nil) : Tuple(ProcessorIdentityGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve Identity data The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
-
#processor_identity_match(*, processor_identity_match_request : Plaid::ProcessorIdentityMatchRequest | Nil = nil) : ProcessorIdentityMatchResponse
Retrieve identity match score The
/processor/identity/match
endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. -
#processor_identity_match(*, processor_identity_match_request : Plaid::ProcessorIdentityMatchRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve identity match score The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.
-
#processor_identity_match_with_http_info(*, processor_identity_match_request : Plaid::ProcessorIdentityMatchRequest | Nil = nil) : Tuple(ProcessorIdentityMatchResponse, Int32, Hash(String, Array(String) | String))
Retrieve identity match score The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.
-
#processor_signal_decision_report(*, processor_signal_decision_report_request : Plaid::ProcessorSignalDecisionReportRequest | Nil = nil) : ProcessorSignalDecisionReportResponse
Report whether you initiated an ACH transaction After calling
/processor/signal/evaluate
, call/processor/signal/decision/report
to report whether the transaction was initiated. -
#processor_signal_decision_report(*, processor_signal_decision_report_request : Plaid::ProcessorSignalDecisionReportRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Report whether you initiated an ACH transaction After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated.
-
#processor_signal_decision_report_with_http_info(*, processor_signal_decision_report_request : Plaid::ProcessorSignalDecisionReportRequest | Nil = nil) : Tuple(ProcessorSignalDecisionReportResponse, Int32, Hash(String, Array(String) | String))
Report whether you initiated an ACH transaction After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated.
-
#processor_signal_evaluate(*, processor_signal_evaluate_request : Plaid::ProcessorSignalEvaluateRequest | Nil = nil) : ProcessorSignalEvaluateResponse
Evaluate a planned ACH transaction Use
/processor/signal/evaluate
to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. -
#processor_signal_evaluate(*, processor_signal_evaluate_request : Plaid::ProcessorSignalEvaluateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Evaluate a planned ACH transaction Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.
-
#processor_signal_evaluate_with_http_info(*, processor_signal_evaluate_request : Plaid::ProcessorSignalEvaluateRequest | Nil = nil) : Tuple(ProcessorSignalEvaluateResponse, Int32, Hash(String, Array(String) | String))
Evaluate a planned ACH transaction Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.
-
#processor_signal_prepare(*, processor_signal_prepare_request : Plaid::ProcessorSignalPrepareRequest | Nil = nil) : ProcessorSignalPrepareResponse
Opt-in a processor token to Signal When a processor token is not initialized with Signal, call
/processor/signal/prepare
to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score. -
#processor_signal_prepare(*, processor_signal_prepare_request : Plaid::ProcessorSignalPrepareRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Opt-in a processor token to Signal When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score.
-
#processor_signal_prepare_with_http_info(*, processor_signal_prepare_request : Plaid::ProcessorSignalPrepareRequest | Nil = nil) : Tuple(ProcessorSignalPrepareResponse, Int32, Hash(String, Array(String) | String))
Opt-in a processor token to Signal When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score.
-
#processor_signal_return_report(*, processor_signal_return_report_request : Plaid::ProcessorSignalReturnReportRequest | Nil = nil) : ProcessorSignalReturnReportResponse
Report a return for an ACH transaction Call the
/processor/signal/return/report
endpoint to report a returned transaction that was previously sent to the/processor/signal/evaluate
endpoint. -
#processor_signal_return_report(*, processor_signal_return_report_request : Plaid::ProcessorSignalReturnReportRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Report a return for an ACH transaction Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint.
-
#processor_signal_return_report_with_http_info(*, processor_signal_return_report_request : Plaid::ProcessorSignalReturnReportRequest | Nil = nil) : Tuple(ProcessorSignalReturnReportResponse, Int32, Hash(String, Array(String) | String))
Report a return for an ACH transaction Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint.
-
#processor_stripe_bank_account_token_create(*, processor_stripe_bank_account_token_create_request : Plaid::ProcessorStripeBankAccountTokenCreateRequest | Nil = nil) : ProcessorStripeBankAccountTokenCreateResponse
Create Stripe bank account token Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
-
#processor_stripe_bank_account_token_create(*, processor_stripe_bank_account_token_create_request : Plaid::ProcessorStripeBankAccountTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create Stripe bank account token Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
-
#processor_stripe_bank_account_token_create_with_http_info(*, processor_stripe_bank_account_token_create_request : Plaid::ProcessorStripeBankAccountTokenCreateRequest | Nil = nil) : Tuple(ProcessorStripeBankAccountTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create Stripe bank account token Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations.
-
#processor_token_create(*, processor_token_create_request : Plaid::ProcessorTokenCreateRequest | Nil = nil) : ProcessorTokenCreateResponse
Create processor token Used to create a token suitable for sending to one of Plaid's partners to enable integrations.
-
#processor_token_create(*, processor_token_create_request : Plaid::ProcessorTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create processor token Used to create a token suitable for sending to one of Plaid's partners to enable integrations.
-
#processor_token_create_with_http_info(*, processor_token_create_request : Plaid::ProcessorTokenCreateRequest | Nil = nil) : Tuple(ProcessorTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create processor token Used to create a token suitable for sending to one of Plaid's partners to enable integrations.
-
#processor_token_permissions_get(*, processor_token_permissions_get_request : Plaid::ProcessorTokenPermissionsGetRequest | Nil = nil) : ProcessorTokenPermissionsGetResponse
Get a processor token's product permissions Used to get a processor token's product permissions.
-
#processor_token_permissions_get(*, processor_token_permissions_get_request : Plaid::ProcessorTokenPermissionsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get a processor token's product permissions Used to get a processor token's product permissions.
-
#processor_token_permissions_get_with_http_info(*, processor_token_permissions_get_request : Plaid::ProcessorTokenPermissionsGetRequest | Nil = nil) : Tuple(ProcessorTokenPermissionsGetResponse, Int32, Hash(String, Array(String) | String))
Get a processor token's product permissions Used to get a processor token's product permissions.
-
#processor_token_permissions_set(*, processor_token_permissions_set_request : Plaid::ProcessorTokenPermissionsSetRequest | Nil = nil) : ProcessorTokenPermissionsSetResponse
Control a processor's access to products Used to control a processor's access to products on the given processor token.
-
#processor_token_permissions_set(*, processor_token_permissions_set_request : Plaid::ProcessorTokenPermissionsSetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Control a processor's access to products Used to control a processor's access to products on the given processor token.
-
#processor_token_permissions_set_with_http_info(*, processor_token_permissions_set_request : Plaid::ProcessorTokenPermissionsSetRequest | Nil = nil) : Tuple(ProcessorTokenPermissionsSetResponse, Int32, Hash(String, Array(String) | String))
Control a processor's access to products Used to control a processor's access to products on the given processor token.
-
#processor_token_webhook_update(*, processor_token_webhook_update_request : Plaid::ProcessorTokenWebhookUpdateRequest | Nil = nil) : ProcessorTokenWebhookUpdateResponse
Update a processor token's webhook URL This endpoint allows you, the processor, to update the webhook URL associated with a processor token.
-
#processor_token_webhook_update(*, processor_token_webhook_update_request : Plaid::ProcessorTokenWebhookUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update a processor token's webhook URL This endpoint allows you, the processor, to update the webhook URL associated with a processor token.
-
#processor_token_webhook_update_with_http_info(*, processor_token_webhook_update_request : Plaid::ProcessorTokenWebhookUpdateRequest | Nil = nil) : Tuple(ProcessorTokenWebhookUpdateResponse, Int32, Hash(String, Array(String) | String))
Update a processor token's webhook URL This endpoint allows you, the processor, to update the webhook URL associated with a processor token.
-
#processor_transactions_get(*, processor_transactions_get_request : Plaid::ProcessorTransactionsGetRequest | Nil = nil) : ProcessorTransactionsGetResponse
Get transaction data The
/processor/transactions/get
endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtypestudent
; coverage may be limited). -
#processor_transactions_get(*, processor_transactions_get_request : Plaid::ProcessorTransactionsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get transaction data The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited).
-
#processor_transactions_get_with_http_info(*, processor_transactions_get_request : Plaid::ProcessorTransactionsGetRequest | Nil = nil) : Tuple(ProcessorTransactionsGetResponse, Int32, Hash(String, Array(String) | String))
Get transaction data The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited).
-
#processor_transactions_recurring_get(*, processor_transactions_recurring_get_request : Plaid::ProcessorTransactionsRecurringGetRequest | Nil = nil) : ProcessorTransactionsRecurringGetResponse
Fetch recurring transaction streams The
/processor/transactions/recurring/get
endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. -
#processor_transactions_recurring_get(*, processor_transactions_recurring_get_request : Plaid::ProcessorTransactionsRecurringGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch recurring transaction streams The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts.
-
#processor_transactions_recurring_get_with_http_info(*, processor_transactions_recurring_get_request : Plaid::ProcessorTransactionsRecurringGetRequest | Nil = nil) : Tuple(ProcessorTransactionsRecurringGetResponse, Int32, Hash(String, Array(String) | String))
Fetch recurring transaction streams The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts.
-
#processor_transactions_refresh(*, processor_transactions_refresh_request : Plaid::ProcessorTransactionsRefreshRequest | Nil = nil) : ProcessorTransactionsRefreshResponse
Refresh transaction data
/processor/transactions/refresh
is an optional endpoint for users of the Transactions product. -
#processor_transactions_refresh(*, processor_transactions_refresh_request : Plaid::ProcessorTransactionsRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh transaction data `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product.
-
#processor_transactions_refresh_with_http_info(*, processor_transactions_refresh_request : Plaid::ProcessorTransactionsRefreshRequest | Nil = nil) : Tuple(ProcessorTransactionsRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh transaction data `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product.
-
#processor_transactions_sync(*, processor_transactions_sync_request : Plaid::ProcessorTransactionsSyncRequest | Nil = nil) : ProcessorTransactionsSyncResponse
Get incremental transaction updates on a processor token This endpoint replaces
/processor/transactions/get
and its associated webhooks for most common use-cases. -
#processor_transactions_sync(*, processor_transactions_sync_request : Plaid::ProcessorTransactionsSyncRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get incremental transaction updates on a processor token This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases.
-
#processor_transactions_sync_with_http_info(*, processor_transactions_sync_request : Plaid::ProcessorTransactionsSyncRequest | Nil = nil) : Tuple(ProcessorTransactionsSyncResponse, Int32, Hash(String, Array(String) | String))
Get incremental transaction updates on a processor token This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases.
-
#sandbox_bank_income_fire_webhook(*, sandbox_bank_income_fire_webhook_request : Plaid::SandboxBankIncomeFireWebhookRequest | Nil = nil) : SandboxBankIncomeFireWebhookResponse
Manually fire a bank income webhook in sandbox Use the
/sandbox/bank_income/fire_webhook
endpoint to manually trigger a Bank Income webhook in the Sandbox environment. -
#sandbox_bank_income_fire_webhook(*, sandbox_bank_income_fire_webhook_request : Plaid::SandboxBankIncomeFireWebhookRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Manually fire a bank income webhook in sandbox Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
-
#sandbox_bank_income_fire_webhook_with_http_info(*, sandbox_bank_income_fire_webhook_request : Plaid::SandboxBankIncomeFireWebhookRequest | Nil = nil) : Tuple(SandboxBankIncomeFireWebhookResponse, Int32, Hash(String, Array(String) | String))
Manually fire a bank income webhook in sandbox Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
-
#sandbox_bank_transfer_fire_webhook(*, sandbox_bank_transfer_fire_webhook_request : Plaid::SandboxBankTransferFireWebhookRequest | Nil = nil) : SandboxBankTransferFireWebhookResponse
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. -
#sandbox_bank_transfer_fire_webhook(*, sandbox_bank_transfer_fire_webhook_request : Plaid::SandboxBankTransferFireWebhookRequest | Nil = nil, &block : Crest::Response -> ) : Nil
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.
-
#sandbox_bank_transfer_fire_webhook_with_http_info(*, sandbox_bank_transfer_fire_webhook_request : Plaid::SandboxBankTransferFireWebhookRequest | Nil = nil) : Tuple(SandboxBankTransferFireWebhookResponse, Int32, Hash(String, Array(String) | String))
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.
-
#sandbox_bank_transfer_simulate(*, sandbox_bank_transfer_simulate_request : Plaid::SandboxBankTransferSimulateRequest | Nil = nil) : SandboxBankTransferSimulateResponse
Simulate a bank transfer event in Sandbox Use the
/sandbox/bank_transfer/simulate
endpoint to simulate a bank transfer event in the Sandbox environment. -
#sandbox_bank_transfer_simulate(*, sandbox_bank_transfer_simulate_request : Plaid::SandboxBankTransferSimulateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Simulate a bank transfer event in Sandbox Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment.
-
#sandbox_bank_transfer_simulate_with_http_info(*, sandbox_bank_transfer_simulate_request : Plaid::SandboxBankTransferSimulateRequest | Nil = nil) : Tuple(SandboxBankTransferSimulateResponse, Int32, Hash(String, Array(String) | String))
Simulate a bank transfer event in Sandbox Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment.
-
#sandbox_income_fire_webhook(*, sandbox_income_fire_webhook_request : Plaid::SandboxIncomeFireWebhookRequest | Nil = nil) : SandboxIncomeFireWebhookResponse
Manually fire an Income webhook Use the
/sandbox/income/fire_webhook
endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment. -
#sandbox_income_fire_webhook(*, sandbox_income_fire_webhook_request : Plaid::SandboxIncomeFireWebhookRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Manually fire an Income webhook Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
-
#sandbox_income_fire_webhook_with_http_info(*, sandbox_income_fire_webhook_request : Plaid::SandboxIncomeFireWebhookRequest | Nil = nil) : Tuple(SandboxIncomeFireWebhookResponse, Int32, Hash(String, Array(String) | String))
Manually fire an Income webhook Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
-
#sandbox_item_fire_webhook(*, sandbox_item_fire_webhook_request : Plaid::SandboxItemFireWebhookRequest | Nil = nil) : SandboxItemFireWebhookResponse
Fire a test webhook The
/sandbox/item/fire_webhook
endpoint is used to test that code correctly handles webhooks. -
#sandbox_item_fire_webhook(*, sandbox_item_fire_webhook_request : Plaid::SandboxItemFireWebhookRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Fire a test webhook The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks.
-
#sandbox_item_fire_webhook_with_http_info(*, sandbox_item_fire_webhook_request : Plaid::SandboxItemFireWebhookRequest | Nil = nil) : Tuple(SandboxItemFireWebhookResponse, Int32, Hash(String, Array(String) | String))
Fire a test webhook The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks.
-
#sandbox_item_reset_login(*, sandbox_item_reset_login_request : Plaid::SandboxItemResetLoginRequest | Nil = nil) : SandboxItemResetLoginResponse
Force a Sandbox Item into an error state
/sandbox/item/reset_login/
forces an Item into anITEM_LOGIN_REQUIRED
state in order to simulate an Item whose login is no longer valid. -
#sandbox_item_reset_login(*, sandbox_item_reset_login_request : Plaid::SandboxItemResetLoginRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Force a Sandbox Item into an error state `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid.
-
#sandbox_item_reset_login_with_http_info(*, sandbox_item_reset_login_request : Plaid::SandboxItemResetLoginRequest | Nil = nil) : Tuple(SandboxItemResetLoginResponse, Int32, Hash(String, Array(String) | String))
Force a Sandbox Item into an error state `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid.
-
#sandbox_item_set_verification_status(*, sandbox_item_set_verification_status_request : Plaid::SandboxItemSetVerificationStatusRequest | Nil = nil) : SandboxItemSetVerificationStatusResponse
Set verification status for Sandbox account The
/sandbox/item/set_verification_status
endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. -
#sandbox_item_set_verification_status(*, sandbox_item_set_verification_status_request : Plaid::SandboxItemSetVerificationStatusRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Set verification status for Sandbox account The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.
-
#sandbox_item_set_verification_status_with_http_info(*, sandbox_item_set_verification_status_request : Plaid::SandboxItemSetVerificationStatusRequest | Nil = nil) : Tuple(SandboxItemSetVerificationStatusResponse, Int32, Hash(String, Array(String) | String))
Set verification status for Sandbox account The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.
-
#sandbox_oauth_select_accounts(*, sandbox_oauth_select_accounts_request : Plaid::SandboxOauthSelectAccountsRequest | Nil = nil) : Hash(String, Object)
Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution @required @param sandbox_oauth_select_accounts_request [Plaid::SandboxOauthSelectAccountsRequest?] @return [Hash(String, Object)]
-
#sandbox_oauth_select_accounts(*, sandbox_oauth_select_accounts_request : Plaid::SandboxOauthSelectAccountsRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution @required @param sandbox_oauth_select_accounts_request [Plaid::SandboxOauthSelectAccountsRequest?] @return nil
-
#sandbox_oauth_select_accounts_with_http_info(*, sandbox_oauth_select_accounts_request : Plaid::SandboxOauthSelectAccountsRequest | Nil = nil) : Tuple(Hash(String, Object), Int32, Hash(String, Array(String) | String))
Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution @required @param sandbox_oauth_select_accounts_request [Plaid::SandboxOauthSelectAccountsRequest?] @return [Tuple(Hash(String, Object), Integer, Hash)] Hash(String, Object), response status code and response headers
-
#sandbox_payment_profile_reset_login(*, sandbox_payment_profile_reset_login_request : Plaid::SandboxPaymentProfileResetLoginRequest | Nil = nil) : SandboxPaymentProfileResetLoginResponse
Reset the login of a Payment Profile
/sandbox/payment_profile/reset_login/
forces a Payment Profile into a state where the login is no longer valid. -
#sandbox_payment_profile_reset_login(*, sandbox_payment_profile_reset_login_request : Plaid::SandboxPaymentProfileResetLoginRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Reset the login of a Payment Profile `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid.
-
#sandbox_payment_profile_reset_login_with_http_info(*, sandbox_payment_profile_reset_login_request : Plaid::SandboxPaymentProfileResetLoginRequest | Nil = nil) : Tuple(SandboxPaymentProfileResetLoginResponse, Int32, Hash(String, Array(String) | String))
Reset the login of a Payment Profile `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid.
-
#sandbox_processor_token_create(*, sandbox_processor_token_create_request : Plaid::SandboxProcessorTokenCreateRequest | Nil = nil) : SandboxProcessorTokenCreateResponse
Create a test Item and processor token Use the
/sandbox/processor_token/create
endpoint to create a validprocessor_token
for an arbitrary institution ID and test credentials. -
#sandbox_processor_token_create(*, sandbox_processor_token_create_request : Plaid::SandboxProcessorTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a test Item and processor token Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials.
-
#sandbox_processor_token_create_with_http_info(*, sandbox_processor_token_create_request : Plaid::SandboxProcessorTokenCreateRequest | Nil = nil) : Tuple(SandboxProcessorTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create a test Item and processor token Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials.
-
#sandbox_public_token_create(*, sandbox_public_token_create_request : Plaid::SandboxPublicTokenCreateRequest | Nil = nil) : SandboxPublicTokenCreateResponse
Create a test Item Use the
/sandbox/public_token/create
endpoint to create a validpublic_token
for an arbitrary institution ID, initial products, and test credentials. -
#sandbox_public_token_create(*, sandbox_public_token_create_request : Plaid::SandboxPublicTokenCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a test Item Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials.
-
#sandbox_public_token_create_with_http_info(*, sandbox_public_token_create_request : Plaid::SandboxPublicTokenCreateRequest | Nil = nil) : Tuple(SandboxPublicTokenCreateResponse, Int32, Hash(String, Array(String) | String))
Create a test Item Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials.
-
#sandbox_transfer_fire_webhook(*, sandbox_transfer_fire_webhook_request : Plaid::SandboxTransferFireWebhookRequest | Nil = nil) : SandboxTransferFireWebhookResponse
Manually fire a Transfer webhook Use the
/sandbox/transfer/fire_webhook
endpoint to manually trigger aTRANSFER_EVENTS_UPDATE
webhook in the Sandbox environment. -
#sandbox_transfer_fire_webhook(*, sandbox_transfer_fire_webhook_request : Plaid::SandboxTransferFireWebhookRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Manually fire a Transfer webhook Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment.
-
#sandbox_transfer_fire_webhook_with_http_info(*, sandbox_transfer_fire_webhook_request : Plaid::SandboxTransferFireWebhookRequest | Nil = nil) : Tuple(SandboxTransferFireWebhookResponse, Int32, Hash(String, Array(String) | String))
Manually fire a Transfer webhook Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment.
-
#sandbox_transfer_ledger_deposit_simulate(*, sandbox_transfer_ledger_deposit_simulate_request : Plaid::SandboxTransferLedgerDepositSimulateRequest | Nil = nil) : SandboxTransferLedgerDepositSimulateResponse
Simulate a ledger deposit event in Sandbox Use the
/sandbox/transfer/ledger/deposit/simulate
endpoint to simulate a ledger deposit event in the Sandbox environment. -
#sandbox_transfer_ledger_deposit_simulate(*, sandbox_transfer_ledger_deposit_simulate_request : Plaid::SandboxTransferLedgerDepositSimulateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Simulate a ledger deposit event in Sandbox Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment.
-
#sandbox_transfer_ledger_deposit_simulate_with_http_info(*, sandbox_transfer_ledger_deposit_simulate_request : Plaid::SandboxTransferLedgerDepositSimulateRequest | Nil = nil) : Tuple(SandboxTransferLedgerDepositSimulateResponse, Int32, Hash(String, Array(String) | String))
Simulate a ledger deposit event in Sandbox Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment.
-
#sandbox_transfer_ledger_simulate_available(*, sandbox_transfer_ledger_simulate_available_request : Plaid::SandboxTransferLedgerSimulateAvailableRequest | Nil = nil) : SandboxTransferLedgerSimulateAvailableResponse
Simulate converting pending balance to available balance Use the
/sandbox/transfer/ledger/simulate_available
endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment. -
#sandbox_transfer_ledger_simulate_available(*, sandbox_transfer_ledger_simulate_available_request : Plaid::SandboxTransferLedgerSimulateAvailableRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Simulate converting pending balance to available balance Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.
-
#sandbox_transfer_ledger_simulate_available_with_http_info(*, sandbox_transfer_ledger_simulate_available_request : Plaid::SandboxTransferLedgerSimulateAvailableRequest | Nil = nil) : Tuple(SandboxTransferLedgerSimulateAvailableResponse, Int32, Hash(String, Array(String) | String))
Simulate converting pending balance to available balance Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.
-
#sandbox_transfer_ledger_withdraw_simulate(*, sandbox_transfer_ledger_withdraw_simulate_request : Plaid::SandboxTransferLedgerWithdrawSimulateRequest | Nil = nil) : SandboxTransferLedgerWithdrawSimulateResponse
Simulate a ledger withdraw event in Sandbox Use the
/sandbox/transfer/ledger/withdraw/simulate
endpoint to simulate a ledger withdraw event in the Sandbox environment. -
#sandbox_transfer_ledger_withdraw_simulate(*, sandbox_transfer_ledger_withdraw_simulate_request : Plaid::SandboxTransferLedgerWithdrawSimulateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Simulate a ledger withdraw event in Sandbox Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment.
-
#sandbox_transfer_ledger_withdraw_simulate_with_http_info(*, sandbox_transfer_ledger_withdraw_simulate_request : Plaid::SandboxTransferLedgerWithdrawSimulateRequest | Nil = nil) : Tuple(SandboxTransferLedgerWithdrawSimulateResponse, Int32, Hash(String, Array(String) | String))
Simulate a ledger withdraw event in Sandbox Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment.
-
#sandbox_transfer_refund_simulate(*, sandbox_transfer_refund_simulate_request : Plaid::SandboxTransferRefundSimulateRequest | Nil = nil) : SandboxTransferRefundSimulateResponse
Simulate a refund event in Sandbox Use the
/sandbox/transfer/refund/simulate
endpoint to simulate a refund event in the Sandbox environment. -
#sandbox_transfer_refund_simulate(*, sandbox_transfer_refund_simulate_request : Plaid::SandboxTransferRefundSimulateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Simulate a refund event in Sandbox Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment.
-
#sandbox_transfer_refund_simulate_with_http_info(*, sandbox_transfer_refund_simulate_request : Plaid::SandboxTransferRefundSimulateRequest | Nil = nil) : Tuple(SandboxTransferRefundSimulateResponse, Int32, Hash(String, Array(String) | String))
Simulate a refund event in Sandbox Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment.
-
#sandbox_transfer_repayment_simulate(*, sandbox_transfer_repayment_simulate_request : Plaid::SandboxTransferRepaymentSimulateRequest | Nil = nil) : SandboxTransferRepaymentSimulateResponse
Trigger the creation of a repayment Use the
/sandbox/transfer/repayment/simulate
endpoint to trigger the creation of a repayment. -
#sandbox_transfer_repayment_simulate(*, sandbox_transfer_repayment_simulate_request : Plaid::SandboxTransferRepaymentSimulateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Trigger the creation of a repayment Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment.
-
#sandbox_transfer_repayment_simulate_with_http_info(*, sandbox_transfer_repayment_simulate_request : Plaid::SandboxTransferRepaymentSimulateRequest | Nil = nil) : Tuple(SandboxTransferRepaymentSimulateResponse, Int32, Hash(String, Array(String) | String))
Trigger the creation of a repayment Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment.
-
#sandbox_transfer_simulate(*, sandbox_transfer_simulate_request : Plaid::SandboxTransferSimulateRequest | Nil = nil) : SandboxTransferSimulateResponse
Simulate a transfer event in Sandbox Use the
/sandbox/transfer/simulate
endpoint to simulate a transfer event in the Sandbox environment. -
#sandbox_transfer_simulate(*, sandbox_transfer_simulate_request : Plaid::SandboxTransferSimulateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Simulate a transfer event in Sandbox Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment.
-
#sandbox_transfer_simulate_with_http_info(*, sandbox_transfer_simulate_request : Plaid::SandboxTransferSimulateRequest | Nil = nil) : Tuple(SandboxTransferSimulateResponse, Int32, Hash(String, Array(String) | String))
Simulate a transfer event in Sandbox Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment.
-
#sandbox_transfer_sweep_simulate(*, sandbox_transfer_sweep_simulate_request : Plaid::SandboxTransferSweepSimulateRequest | Nil = nil) : SandboxTransferSweepSimulateResponse
Simulate creating a sweep Use the
/sandbox/transfer/sweep/simulate
endpoint to create a sweep and associated events in the Sandbox environment. -
#sandbox_transfer_sweep_simulate(*, sandbox_transfer_sweep_simulate_request : Plaid::SandboxTransferSweepSimulateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Simulate creating a sweep Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.
-
#sandbox_transfer_sweep_simulate_with_http_info(*, sandbox_transfer_sweep_simulate_request : Plaid::SandboxTransferSweepSimulateRequest | Nil = nil) : Tuple(SandboxTransferSweepSimulateResponse, Int32, Hash(String, Array(String) | String))
Simulate creating a sweep Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.
-
#sandbox_transfer_test_clock_advance(*, sandbox_transfer_test_clock_advance_request : Plaid::SandboxTransferTestClockAdvanceRequest | Nil = nil) : SandboxTransferTestClockAdvanceResponse
Advance a test clock Use the
/sandbox/transfer/test_clock/advance
endpoint to advance atest_clock
in the Sandbox environment. -
#sandbox_transfer_test_clock_advance(*, sandbox_transfer_test_clock_advance_request : Plaid::SandboxTransferTestClockAdvanceRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Advance a test clock Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment.
-
#sandbox_transfer_test_clock_advance_with_http_info(*, sandbox_transfer_test_clock_advance_request : Plaid::SandboxTransferTestClockAdvanceRequest | Nil = nil) : Tuple(SandboxTransferTestClockAdvanceResponse, Int32, Hash(String, Array(String) | String))
Advance a test clock Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment.
-
#sandbox_transfer_test_clock_create(*, sandbox_transfer_test_clock_create_request : Plaid::SandboxTransferTestClockCreateRequest | Nil = nil) : SandboxTransferTestClockCreateResponse
Create a test clock Use the
/sandbox/transfer/test_clock/create
endpoint to create atest_clock
in the Sandbox environment. -
#sandbox_transfer_test_clock_create(*, sandbox_transfer_test_clock_create_request : Plaid::SandboxTransferTestClockCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a test clock Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment.
-
#sandbox_transfer_test_clock_create_with_http_info(*, sandbox_transfer_test_clock_create_request : Plaid::SandboxTransferTestClockCreateRequest | Nil = nil) : Tuple(SandboxTransferTestClockCreateResponse, Int32, Hash(String, Array(String) | String))
Create a test clock Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment.
-
#sandbox_transfer_test_clock_get(*, sandbox_transfer_test_clock_get_request : Plaid::SandboxTransferTestClockGetRequest | Nil = nil) : SandboxTransferTestClockGetResponse
Get a test clock Use the
/sandbox/transfer/test_clock/get
endpoint to get atest_clock
in the Sandbox environment. -
#sandbox_transfer_test_clock_get(*, sandbox_transfer_test_clock_get_request : Plaid::SandboxTransferTestClockGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get a test clock Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment.
-
#sandbox_transfer_test_clock_get_with_http_info(*, sandbox_transfer_test_clock_get_request : Plaid::SandboxTransferTestClockGetRequest | Nil = nil) : Tuple(SandboxTransferTestClockGetResponse, Int32, Hash(String, Array(String) | String))
Get a test clock Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment.
-
#sandbox_transfer_test_clock_list(*, sandbox_transfer_test_clock_list_request : Plaid::SandboxTransferTestClockListRequest | Nil = nil) : SandboxTransferTestClockListResponse
List test clocks Use the
/sandbox/transfer/test_clock/list
endpoint to see a list of all your test clocks in the Sandbox environment, by ascendingvirtual_time
. -
#sandbox_transfer_test_clock_list(*, sandbox_transfer_test_clock_list_request : Plaid::SandboxTransferTestClockListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List test clocks Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`.
-
#sandbox_transfer_test_clock_list_with_http_info(*, sandbox_transfer_test_clock_list_request : Plaid::SandboxTransferTestClockListRequest | Nil = nil) : Tuple(SandboxTransferTestClockListResponse, Int32, Hash(String, Array(String) | String))
List test clocks Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`.
-
#signal_decision_report(*, signal_decision_report_request : Plaid::SignalDecisionReportRequest | Nil = nil) : SignalDecisionReportResponse
Report whether you initiated an ACH transaction After calling
/signal/evaluate
, call/signal/decision/report
to report whether the transaction was initiated. -
#signal_decision_report(*, signal_decision_report_request : Plaid::SignalDecisionReportRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Report whether you initiated an ACH transaction After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated.
-
#signal_decision_report_with_http_info(*, signal_decision_report_request : Plaid::SignalDecisionReportRequest | Nil = nil) : Tuple(SignalDecisionReportResponse, Int32, Hash(String, Array(String) | String))
Report whether you initiated an ACH transaction After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated.
-
#signal_evaluate(*, signal_evaluate_request : Plaid::SignalEvaluateRequest | Nil = nil) : SignalEvaluateResponse
Evaluate a planned ACH transaction Use
/signal/evaluate
to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. -
#signal_evaluate(*, signal_evaluate_request : Plaid::SignalEvaluateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Evaluate a planned ACH transaction Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.
-
#signal_evaluate_with_http_info(*, signal_evaluate_request : Plaid::SignalEvaluateRequest | Nil = nil) : Tuple(SignalEvaluateResponse, Int32, Hash(String, Array(String) | String))
Evaluate a planned ACH transaction Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.
-
#signal_prepare(*, signal_prepare_request : Plaid::SignalPrepareRequest | Nil = nil) : SignalPrepareResponse
Opt-in an Item to Signal When Link is not initialized with Signal, call
/signal/prepare
to opt-in that Item to the Signal data collection process, developing a Signal score. -
#signal_prepare(*, signal_prepare_request : Plaid::SignalPrepareRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Opt-in an Item to Signal When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score.
-
#signal_prepare_with_http_info(*, signal_prepare_request : Plaid::SignalPrepareRequest | Nil = nil) : Tuple(SignalPrepareResponse, Int32, Hash(String, Array(String) | String))
Opt-in an Item to Signal When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score.
-
#signal_return_report(*, signal_return_report_request : Plaid::SignalReturnReportRequest | Nil = nil) : SignalReturnReportResponse
Report a return for an ACH transaction Call the
/signal/return/report
endpoint to report a returned transaction that was previously sent to the/signal/evaluate
endpoint. -
#signal_return_report(*, signal_return_report_request : Plaid::SignalReturnReportRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Report a return for an ACH transaction Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint.
-
#signal_return_report_with_http_info(*, signal_return_report_request : Plaid::SignalReturnReportRequest | Nil = nil) : Tuple(SignalReturnReportResponse, Int32, Hash(String, Array(String) | String))
Report a return for an ACH transaction Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint.
-
#statements_download(*, statements_download_request : Plaid::StatementsDownloadRequest | Nil = nil) : File
Retrieve a single statement.
-
#statements_download(*, statements_download_request : Plaid::StatementsDownloadRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a single statement.
-
#statements_download_with_http_info(*, statements_download_request : Plaid::StatementsDownloadRequest | Nil = nil) : Tuple(File, Int32, Hash(String, Array(String) | String))
Retrieve a single statement.
-
#statements_list(*, statements_list_request : Plaid::StatementsListRequest | Nil = nil) : StatementsListResponse
Retrieve a list of all statements associated with the provided item.
-
#statements_list(*, statements_list_request : Plaid::StatementsListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of all statements associated with the provided item.
-
#statements_list_with_http_info(*, statements_list_request : Plaid::StatementsListRequest | Nil = nil) : Tuple(StatementsListResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of all statements associated with the provided item.
-
#transactions_enhance(*, transactions_enhance_get_request : Plaid::TransactionsEnhanceGetRequest | Nil = nil) : TransactionsEnhanceGetResponse
enhance locally-held transaction data The
/beta/transactions/v1/enhance
endpoint enriches raw transaction data provided directly by clients. -
#transactions_enhance(*, transactions_enhance_get_request : Plaid::TransactionsEnhanceGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
enhance locally-held transaction data The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients.
-
#transactions_enhance_with_http_info(*, transactions_enhance_get_request : Plaid::TransactionsEnhanceGetRequest | Nil = nil) : Tuple(TransactionsEnhanceGetResponse, Int32, Hash(String, Array(String) | String))
enhance locally-held transaction data The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients.
-
#transactions_enrich(*, transactions_enrich_request : Plaid::TransactionsEnrichRequest | Nil = nil) : TransactionsEnrichResponse
Enrich locally-held transaction data The
/transactions/enrich
endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. -
#transactions_enrich(*, transactions_enrich_request : Plaid::TransactionsEnrichRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Enrich locally-held transaction data The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
-
#transactions_enrich_with_http_info(*, transactions_enrich_request : Plaid::TransactionsEnrichRequest | Nil = nil) : Tuple(TransactionsEnrichResponse, Int32, Hash(String, Array(String) | String))
Enrich locally-held transaction data The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
-
#transactions_get(*, transactions_get_request : Plaid::TransactionsGetRequest | Nil = nil) : TransactionsGetResponse
Get transaction data Note: All new implementations are encouraged to use
/transactions/sync
rather than/transactions/get
. -
#transactions_get(*, transactions_get_request : Plaid::TransactionsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get transaction data Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`.
-
#transactions_get_with_http_info(*, transactions_get_request : Plaid::TransactionsGetRequest | Nil = nil) : Tuple(TransactionsGetResponse, Int32, Hash(String, Array(String) | String))
Get transaction data Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`.
-
#transactions_recurring_get(*, transactions_recurring_get_request : Plaid::TransactionsRecurringGetRequest | Nil = nil) : TransactionsRecurringGetResponse
Fetch recurring transaction streams The
/transactions/recurring/get
endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. -
#transactions_recurring_get(*, transactions_recurring_get_request : Plaid::TransactionsRecurringGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch recurring transaction streams The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts.
-
#transactions_recurring_get_with_http_info(*, transactions_recurring_get_request : Plaid::TransactionsRecurringGetRequest | Nil = nil) : Tuple(TransactionsRecurringGetResponse, Int32, Hash(String, Array(String) | String))
Fetch recurring transaction streams The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts.
-
#transactions_refresh(*, transactions_refresh_request : Plaid::TransactionsRefreshRequest | Nil = nil) : TransactionsRefreshResponse
Refresh transaction data
/transactions/refresh
is an optional endpoint for users of the Transactions product. -
#transactions_refresh(*, transactions_refresh_request : Plaid::TransactionsRefreshRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Refresh transaction data `/transactions/refresh` is an optional endpoint for users of the Transactions product.
-
#transactions_refresh_with_http_info(*, transactions_refresh_request : Plaid::TransactionsRefreshRequest | Nil = nil) : Tuple(TransactionsRefreshResponse, Int32, Hash(String, Array(String) | String))
Refresh transaction data `/transactions/refresh` is an optional endpoint for users of the Transactions product.
-
#transactions_rules_create(*, transactions_rules_create_request : Plaid::TransactionsRulesCreateRequest | Nil = nil) : TransactionsRulesCreateResponse
Create transaction category rule The
/transactions/rules/v1/create
endpoint creates transaction categorization rules. -
#transactions_rules_create(*, transactions_rules_create_request : Plaid::TransactionsRulesCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create transaction category rule The `/transactions/rules/v1/create` endpoint creates transaction categorization rules.
-
#transactions_rules_create_with_http_info(*, transactions_rules_create_request : Plaid::TransactionsRulesCreateRequest | Nil = nil) : Tuple(TransactionsRulesCreateResponse, Int32, Hash(String, Array(String) | String))
Create transaction category rule The `/transactions/rules/v1/create` endpoint creates transaction categorization rules.
-
#transactions_rules_list(*, transactions_rules_list_request : Plaid::TransactionsRulesListRequest | Nil = nil) : TransactionsRulesListResponse
Return a list of rules created for the Item associated with the access token.
-
#transactions_rules_list(*, transactions_rules_list_request : Plaid::TransactionsRulesListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Return a list of rules created for the Item associated with the access token.
-
#transactions_rules_list_with_http_info(*, transactions_rules_list_request : Plaid::TransactionsRulesListRequest | Nil = nil) : Tuple(TransactionsRulesListResponse, Int32, Hash(String, Array(String) | String))
Return a list of rules created for the Item associated with the access token.
-
#transactions_rules_remove(*, transactions_rules_remove_request : Plaid::TransactionsRulesRemoveRequest | Nil = nil) : TransactionsRulesRemoveResponse
Remove transaction rule The
/transactions/rules/v1/remove
endpoint is used to remove a transaction rule. -
#transactions_rules_remove(*, transactions_rules_remove_request : Plaid::TransactionsRulesRemoveRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Remove transaction rule The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
-
#transactions_rules_remove_with_http_info(*, transactions_rules_remove_request : Plaid::TransactionsRulesRemoveRequest | Nil = nil) : Tuple(TransactionsRulesRemoveResponse, Int32, Hash(String, Array(String) | String))
Remove transaction rule The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
-
#transactions_sync(*, transactions_sync_request : Plaid::TransactionsSyncRequest | Nil = nil) : TransactionsSyncResponse
Get incremental transaction updates on an Item The
/transactions/sync
endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. -
#transactions_sync(*, transactions_sync_request : Plaid::TransactionsSyncRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get incremental transaction updates on an Item The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen.
-
#transactions_sync_with_http_info(*, transactions_sync_request : Plaid::TransactionsSyncRequest | Nil = nil) : Tuple(TransactionsSyncResponse, Int32, Hash(String, Array(String) | String))
Get incremental transaction updates on an Item The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen.
-
#transactions_user_insights_get(*, transactions_user_insights_get_request : Plaid::TransactionsUserInsightsGetRequest | Nil = nil) : TransactionsUserInsightsGetResponse
Obtain user insights based on transactions sent through /transactions/enrich The
/beta/transactions/user_insights/v1/get
gets user insights for clients who have enriched data with/transactions/enrich
. -
#transactions_user_insights_get(*, transactions_user_insights_get_request : Plaid::TransactionsUserInsightsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Obtain user insights based on transactions sent through /transactions/enrich The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`.
-
#transactions_user_insights_get_with_http_info(*, transactions_user_insights_get_request : Plaid::TransactionsUserInsightsGetRequest | Nil = nil) : Tuple(TransactionsUserInsightsGetResponse, Int32, Hash(String, Array(String) | String))
Obtain user insights based on transactions sent through /transactions/enrich The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`.
-
#transfer_authorization_create(*, transfer_authorization_create_request : Plaid::TransferAuthorizationCreateRequest | Nil = nil) : TransferAuthorizationCreateResponse
Create a transfer authorization Use the
/transfer/authorization/create
endpoint to authorize a transfer. -
#transfer_authorization_create(*, transfer_authorization_create_request : Plaid::TransferAuthorizationCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a transfer authorization Use the `/transfer/authorization/create` endpoint to authorize a transfer.
-
#transfer_authorization_create_with_http_info(*, transfer_authorization_create_request : Plaid::TransferAuthorizationCreateRequest | Nil = nil) : Tuple(TransferAuthorizationCreateResponse, Int32, Hash(String, Array(String) | String))
Create a transfer authorization Use the `/transfer/authorization/create` endpoint to authorize a transfer.
-
#transfer_balance_get(*, transfer_balance_get_request : Plaid::TransferBalanceGetRequest | Nil = nil) : TransferBalanceGetResponse
Retrieve a balance held with Plaid Use the
/transfer/balance/get
endpoint to view a balance held with Plaid. -
#transfer_balance_get(*, transfer_balance_get_request : Plaid::TransferBalanceGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a balance held with Plaid Use the `/transfer/balance/get` endpoint to view a balance held with Plaid.
-
#transfer_balance_get_with_http_info(*, transfer_balance_get_request : Plaid::TransferBalanceGetRequest | Nil = nil) : Tuple(TransferBalanceGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a balance held with Plaid Use the `/transfer/balance/get` endpoint to view a balance held with Plaid.
-
#transfer_cancel(*, transfer_cancel_request : Plaid::TransferCancelRequest | Nil = nil) : TransferCancelResponse
Cancel a transfer Use the
/transfer/cancel
endpoint to cancel a transfer. -
#transfer_cancel(*, transfer_cancel_request : Plaid::TransferCancelRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Cancel a transfer Use the `/transfer/cancel` endpoint to cancel a transfer.
-
#transfer_cancel_with_http_info(*, transfer_cancel_request : Plaid::TransferCancelRequest | Nil = nil) : Tuple(TransferCancelResponse, Int32, Hash(String, Array(String) | String))
Cancel a transfer Use the `/transfer/cancel` endpoint to cancel a transfer.
-
#transfer_capabilities_get(*, transfer_capabilities_get_request : Plaid::TransferCapabilitiesGetRequest | Nil = nil) : TransferCapabilitiesGetResponse
Get RTP eligibility information of a transfer Use the
/transfer/capabilities/get
endpoint to determine the RTP eligibility information of a transfer. -
#transfer_capabilities_get(*, transfer_capabilities_get_request : Plaid::TransferCapabilitiesGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get RTP eligibility information of a transfer Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
-
#transfer_capabilities_get_with_http_info(*, transfer_capabilities_get_request : Plaid::TransferCapabilitiesGetRequest | Nil = nil) : Tuple(TransferCapabilitiesGetResponse, Int32, Hash(String, Array(String) | String))
Get RTP eligibility information of a transfer Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
-
#transfer_configuration_get(*, transfer_configuration_get_request : Plaid::TransferConfigurationGetRequest | Nil = nil) : TransferConfigurationGetResponse
Get transfer product configuration Use the
/transfer/configuration/get
endpoint to view your transfer product configurations. -
#transfer_configuration_get(*, transfer_configuration_get_request : Plaid::TransferConfigurationGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get transfer product configuration Use the `/transfer/configuration/get` endpoint to view your transfer product configurations.
-
#transfer_configuration_get_with_http_info(*, transfer_configuration_get_request : Plaid::TransferConfigurationGetRequest | Nil = nil) : Tuple(TransferConfigurationGetResponse, Int32, Hash(String, Array(String) | String))
Get transfer product configuration Use the `/transfer/configuration/get` endpoint to view your transfer product configurations.
-
#transfer_create(*, transfer_create_request : Plaid::TransferCreateRequest | Nil = nil) : TransferCreateResponse
Create a transfer Use the
/transfer/create
endpoint to initiate a new transfer. -
#transfer_create(*, transfer_create_request : Plaid::TransferCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a transfer Use the `/transfer/create` endpoint to initiate a new transfer.
-
#transfer_create_with_http_info(*, transfer_create_request : Plaid::TransferCreateRequest | Nil = nil) : Tuple(TransferCreateResponse, Int32, Hash(String, Array(String) | String))
Create a transfer Use the `/transfer/create` endpoint to initiate a new transfer.
-
#transfer_diligence_document_upload(*, transfer_diligence_document_upload_request : Plaid::TransferDiligenceDocumentUploadRequest | Nil = nil) : TransferDiligenceDocumentUploadResponse
Upload transfer diligence document on behalf of the originator Third-party sender customers can use
/transfer/diligence/document/upload
endpoint to upload a document on behalf of its end customer (i.e. -
#transfer_diligence_document_upload(*, transfer_diligence_document_upload_request : Plaid::TransferDiligenceDocumentUploadRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Upload transfer diligence document on behalf of the originator Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e.
-
#transfer_diligence_document_upload_with_http_info(*, transfer_diligence_document_upload_request : Plaid::TransferDiligenceDocumentUploadRequest | Nil = nil) : Tuple(TransferDiligenceDocumentUploadResponse, Int32, Hash(String, Array(String) | String))
Upload transfer diligence document on behalf of the originator Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e.
-
#transfer_diligence_submit(*, transfer_diligence_submit_request : Plaid::TransferDiligenceSubmitRequest | Nil = nil) : TransferDiligenceSubmitResponse
Submit transfer diligence on behalf of the originator Use the
/transfer/diligence/submit
endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer). -
#transfer_diligence_submit(*, transfer_diligence_submit_request : Plaid::TransferDiligenceSubmitRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Submit transfer diligence on behalf of the originator Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
-
#transfer_diligence_submit_with_http_info(*, transfer_diligence_submit_request : Plaid::TransferDiligenceSubmitRequest | Nil = nil) : Tuple(TransferDiligenceSubmitResponse, Int32, Hash(String, Array(String) | String))
Submit transfer diligence on behalf of the originator Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
-
#transfer_event_list(*, transfer_event_list_request : Plaid::TransferEventListRequest | Nil = nil) : TransferEventListResponse
List transfer events Use the
/transfer/event/list
endpoint to get a list of transfer events based on specified filter criteria. -
#transfer_event_list(*, transfer_event_list_request : Plaid::TransferEventListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List transfer events Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
-
#transfer_event_list_with_http_info(*, transfer_event_list_request : Plaid::TransferEventListRequest | Nil = nil) : Tuple(TransferEventListResponse, Int32, Hash(String, Array(String) | String))
List transfer events Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
-
#transfer_event_sync(*, transfer_event_sync_request : Plaid::TransferEventSyncRequest | Nil = nil) : TransferEventSyncResponse
Sync transfer events
/transfer/event/sync
allows you to request up to the next 25 transfer events that happened after a specificevent_id
. -
#transfer_event_sync(*, transfer_event_sync_request : Plaid::TransferEventSyncRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Sync transfer events `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`.
-
#transfer_event_sync_with_http_info(*, transfer_event_sync_request : Plaid::TransferEventSyncRequest | Nil = nil) : Tuple(TransferEventSyncResponse, Int32, Hash(String, Array(String) | String))
Sync transfer events `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`.
-
#transfer_get(*, transfer_get_request : Plaid::TransferGetRequest | Nil = nil) : TransferGetResponse
Retrieve a transfer The
/transfer/get
endpoint fetches information about the transfer corresponding to the giventransfer_id
. -
#transfer_get(*, transfer_get_request : Plaid::TransferGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a transfer The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
-
#transfer_get_with_http_info(*, transfer_get_request : Plaid::TransferGetRequest | Nil = nil) : Tuple(TransferGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a transfer The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
-
#transfer_intent_create(*, transfer_intent_create_request : Plaid::TransferIntentCreateRequest | Nil = nil) : TransferIntentCreateResponse
Create a transfer intent object to invoke the Transfer UI Use the
/transfer/intent/create
endpoint to generate a transfer intent object and invoke the Transfer UI. -
#transfer_intent_create(*, transfer_intent_create_request : Plaid::TransferIntentCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a transfer intent object to invoke the Transfer UI Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.
-
#transfer_intent_create_with_http_info(*, transfer_intent_create_request : Plaid::TransferIntentCreateRequest | Nil = nil) : Tuple(TransferIntentCreateResponse, Int32, Hash(String, Array(String) | String))
Create a transfer intent object to invoke the Transfer UI Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.
-
#transfer_intent_get(*, transfer_intent_get_request : Plaid::TransferIntentGetRequest | Nil = nil) : TransferIntentGetResponse
Retrieve more information about a transfer intent Use the
/transfer/intent/get
endpoint to retrieve more information about a transfer intent. -
#transfer_intent_get(*, transfer_intent_get_request : Plaid::TransferIntentGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve more information about a transfer intent Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.
-
#transfer_intent_get_with_http_info(*, transfer_intent_get_request : Plaid::TransferIntentGetRequest | Nil = nil) : Tuple(TransferIntentGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve more information about a transfer intent Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.
-
#transfer_ledger_deposit(*, transfer_ledger_deposit_request : Plaid::TransferLedgerDepositRequest | Nil = nil) : TransferLedgerDepositResponse
Deposit funds into a Plaid Ledger balance Use the
/transfer/ledger/deposit
endpoint to deposit funds into Plaid Ledger. -
#transfer_ledger_deposit(*, transfer_ledger_deposit_request : Plaid::TransferLedgerDepositRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Deposit funds into a Plaid Ledger balance Use the `/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger.
-
#transfer_ledger_deposit_with_http_info(*, transfer_ledger_deposit_request : Plaid::TransferLedgerDepositRequest | Nil = nil) : Tuple(TransferLedgerDepositResponse, Int32, Hash(String, Array(String) | String))
Deposit funds into a Plaid Ledger balance Use the `/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger.
-
#transfer_ledger_distribute(*, transfer_ledger_distribute_request : Plaid::TransferLedgerDistributeRequest | Nil = nil) : TransferLedgerDistributeResponse
Move available balance between the ledgers of the platform and one of its originators Use the
/transfer/ledger/distribute
endpoint to move available balance between the ledgers of the platform and one of its originators. -
#transfer_ledger_distribute(*, transfer_ledger_distribute_request : Plaid::TransferLedgerDistributeRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Move available balance between the ledgers of the platform and one of its originators Use the `/transfer/ledger/distribute` endpoint to move available balance between the ledgers of the platform and one of its originators.
-
#transfer_ledger_distribute_with_http_info(*, transfer_ledger_distribute_request : Plaid::TransferLedgerDistributeRequest | Nil = nil) : Tuple(TransferLedgerDistributeResponse, Int32, Hash(String, Array(String) | String))
Move available balance between the ledgers of the platform and one of its originators Use the `/transfer/ledger/distribute` endpoint to move available balance between the ledgers of the platform and one of its originators.
-
#transfer_ledger_get(*, transfer_ledger_get_request : Plaid::TransferLedgerGetRequest | Nil = nil) : TransferLedgerGetResponse
Retrieve Plaid Ledger balance Use the
/transfer/ledger/get
endpoint to view a balance on the ledger held with Plaid. -
#transfer_ledger_get(*, transfer_ledger_get_request : Plaid::TransferLedgerGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve Plaid Ledger balance Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid.
-
#transfer_ledger_get_with_http_info(*, transfer_ledger_get_request : Plaid::TransferLedgerGetRequest | Nil = nil) : Tuple(TransferLedgerGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve Plaid Ledger balance Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid.
-
#transfer_ledger_withdraw(*, transfer_ledger_withdraw_request : Plaid::TransferLedgerWithdrawRequest | Nil = nil) : TransferLedgerWithdrawResponse
Withdraw funds from a Plaid Ledger balance Use the
/transfer/ledger/withdraw
endpoint to withdraw funds from a Plaid Ledger balance. -
#transfer_ledger_withdraw(*, transfer_ledger_withdraw_request : Plaid::TransferLedgerWithdrawRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Withdraw funds from a Plaid Ledger balance Use the `/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance.
-
#transfer_ledger_withdraw_with_http_info(*, transfer_ledger_withdraw_request : Plaid::TransferLedgerWithdrawRequest | Nil = nil) : Tuple(TransferLedgerWithdrawResponse, Int32, Hash(String, Array(String) | String))
Withdraw funds from a Plaid Ledger balance Use the `/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance.
-
#transfer_list(*, transfer_list_request : Plaid::TransferListRequest | Nil = nil) : TransferListResponse
List transfers Use the
/transfer/list
endpoint to see a list of all your transfers and their statuses. -
#transfer_list(*, transfer_list_request : Plaid::TransferListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List transfers Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses.
-
#transfer_list_with_http_info(*, transfer_list_request : Plaid::TransferListRequest | Nil = nil) : Tuple(TransferListResponse, Int32, Hash(String, Array(String) | String))
List transfers Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses.
-
#transfer_metrics_get(*, transfer_metrics_get_request : Plaid::TransferMetricsGetRequest | Nil = nil) : TransferMetricsGetResponse
Get transfer product usage metrics Use the
/transfer/metrics/get
endpoint to view your transfer product usage metrics. -
#transfer_metrics_get(*, transfer_metrics_get_request : Plaid::TransferMetricsGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get transfer product usage metrics Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics.
-
#transfer_metrics_get_with_http_info(*, transfer_metrics_get_request : Plaid::TransferMetricsGetRequest | Nil = nil) : Tuple(TransferMetricsGetResponse, Int32, Hash(String, Array(String) | String))
Get transfer product usage metrics Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics.
-
#transfer_migrate_account(*, transfer_migrate_account_request : Plaid::TransferMigrateAccountRequest | Nil = nil) : TransferMigrateAccountResponse
Migrate account into Transfers As an alternative to adding Items via Link, you can also use the
/transfer/migrate_account
endpoint to migrate known account and routing numbers to Plaid Items. -
#transfer_migrate_account(*, transfer_migrate_account_request : Plaid::TransferMigrateAccountRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Migrate account into Transfers As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items.
-
#transfer_migrate_account_with_http_info(*, transfer_migrate_account_request : Plaid::TransferMigrateAccountRequest | Nil = nil) : Tuple(TransferMigrateAccountResponse, Int32, Hash(String, Array(String) | String))
Migrate account into Transfers As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items.
-
#transfer_originator_create(*, transfer_originator_create_request : Plaid::TransferOriginatorCreateRequest | Nil = nil) : TransferOriginatorCreateResponse
Create a new originator Use the
/transfer/originator/create
endpoint to create a new originator and return anoriginator_client_id
. -
#transfer_originator_create(*, transfer_originator_create_request : Plaid::TransferOriginatorCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a new originator Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`.
-
#transfer_originator_create_with_http_info(*, transfer_originator_create_request : Plaid::TransferOriginatorCreateRequest | Nil = nil) : Tuple(TransferOriginatorCreateResponse, Int32, Hash(String, Array(String) | String))
Create a new originator Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`.
-
#transfer_originator_funding_account_update(*, transfer_originator_funding_account_update_request : Plaid::TransferOriginatorFundingAccountUpdateRequest | Nil = nil) : TransferOriginatorFundingAccountUpdateResponse
Update the funding account associated with the originator Use the
/transfer/originator/funding_account/update
endpoint to update the funding account associated with the originator. -
#transfer_originator_funding_account_update(*, transfer_originator_funding_account_update_request : Plaid::TransferOriginatorFundingAccountUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update the funding account associated with the originator Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator.
-
#transfer_originator_funding_account_update_with_http_info(*, transfer_originator_funding_account_update_request : Plaid::TransferOriginatorFundingAccountUpdateRequest | Nil = nil) : Tuple(TransferOriginatorFundingAccountUpdateResponse, Int32, Hash(String, Array(String) | String))
Update the funding account associated with the originator Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator.
-
#transfer_originator_get(*, transfer_originator_get_request : Plaid::TransferOriginatorGetRequest | Nil = nil) : TransferOriginatorGetResponse
Get status of an originator's onboarding The
/transfer/originator/get
endpoint gets status updates for an originator's onboarding process. -
#transfer_originator_get(*, transfer_originator_get_request : Plaid::TransferOriginatorGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get status of an originator's onboarding The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process.
-
#transfer_originator_get_with_http_info(*, transfer_originator_get_request : Plaid::TransferOriginatorGetRequest | Nil = nil) : Tuple(TransferOriginatorGetResponse, Int32, Hash(String, Array(String) | String))
Get status of an originator's onboarding The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process.
-
#transfer_originator_list(*, transfer_originator_list_request : Plaid::TransferOriginatorListRequest | Nil = nil) : TransferOriginatorListResponse
Get status of all originators' onboarding The
/transfer/originator/list
endpoint gets status updates for all of your originators' onboarding. -
#transfer_originator_list(*, transfer_originator_list_request : Plaid::TransferOriginatorListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get status of all originators' onboarding The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding.
-
#transfer_originator_list_with_http_info(*, transfer_originator_list_request : Plaid::TransferOriginatorListRequest | Nil = nil) : Tuple(TransferOriginatorListResponse, Int32, Hash(String, Array(String) | String))
Get status of all originators' onboarding The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding.
-
#transfer_questionnaire_create(*, transfer_questionnaire_create_request : Plaid::TransferQuestionnaireCreateRequest | Nil = nil) : TransferQuestionnaireCreateResponse
Generate a Plaid-hosted onboarding UI URL.
-
#transfer_questionnaire_create(*, transfer_questionnaire_create_request : Plaid::TransferQuestionnaireCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Generate a Plaid-hosted onboarding UI URL.
-
#transfer_questionnaire_create_with_http_info(*, transfer_questionnaire_create_request : Plaid::TransferQuestionnaireCreateRequest | Nil = nil) : Tuple(TransferQuestionnaireCreateResponse, Int32, Hash(String, Array(String) | String))
Generate a Plaid-hosted onboarding UI URL.
-
#transfer_recurring_cancel(*, transfer_recurring_cancel_request : Plaid::TransferRecurringCancelRequest | Nil = nil) : TransferRecurringCancelResponse
Cancel a recurring transfer.
-
#transfer_recurring_cancel(*, transfer_recurring_cancel_request : Plaid::TransferRecurringCancelRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Cancel a recurring transfer.
-
#transfer_recurring_cancel_with_http_info(*, transfer_recurring_cancel_request : Plaid::TransferRecurringCancelRequest | Nil = nil) : Tuple(TransferRecurringCancelResponse, Int32, Hash(String, Array(String) | String))
Cancel a recurring transfer.
-
#transfer_recurring_create(*, transfer_recurring_create_request : Plaid::TransferRecurringCreateRequest | Nil = nil) : TransferRecurringCreateResponse
Create a recurring transfer Use the
/transfer/recurring/create
endpoint to initiate a new recurring transfer. -
#transfer_recurring_create(*, transfer_recurring_create_request : Plaid::TransferRecurringCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a recurring transfer Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
-
#transfer_recurring_create_with_http_info(*, transfer_recurring_create_request : Plaid::TransferRecurringCreateRequest | Nil = nil) : Tuple(TransferRecurringCreateResponse, Int32, Hash(String, Array(String) | String))
Create a recurring transfer Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
-
#transfer_recurring_get(*, transfer_recurring_get_request : Plaid::TransferRecurringGetRequest | Nil = nil) : TransferRecurringGetResponse
Retrieve a recurring transfer The
/transfer/recurring/get
fetches information about the recurring transfer corresponding to the givenrecurring_transfer_id
. -
#transfer_recurring_get(*, transfer_recurring_get_request : Plaid::TransferRecurringGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a recurring transfer The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.
-
#transfer_recurring_get_with_http_info(*, transfer_recurring_get_request : Plaid::TransferRecurringGetRequest | Nil = nil) : Tuple(TransferRecurringGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a recurring transfer The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.
-
#transfer_recurring_list(*, transfer_recurring_list_request : Plaid::TransferRecurringListRequest | Nil = nil) : TransferRecurringListResponse
List recurring transfers Use the
/transfer/recurring/list
endpoint to see a list of all your recurring transfers and their statuses. -
#transfer_recurring_list(*, transfer_recurring_list_request : Plaid::TransferRecurringListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List recurring transfers Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses.
-
#transfer_recurring_list_with_http_info(*, transfer_recurring_list_request : Plaid::TransferRecurringListRequest | Nil = nil) : Tuple(TransferRecurringListResponse, Int32, Hash(String, Array(String) | String))
List recurring transfers Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses.
-
#transfer_refund_cancel(*, transfer_refund_cancel_request : Plaid::TransferRefundCancelRequest | Nil = nil) : TransferRefundCancelResponse
Cancel a refund Use the
/transfer/refund/cancel
endpoint to cancel a refund. -
#transfer_refund_cancel(*, transfer_refund_cancel_request : Plaid::TransferRefundCancelRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Cancel a refund Use the `/transfer/refund/cancel` endpoint to cancel a refund.
-
#transfer_refund_cancel_with_http_info(*, transfer_refund_cancel_request : Plaid::TransferRefundCancelRequest | Nil = nil) : Tuple(TransferRefundCancelResponse, Int32, Hash(String, Array(String) | String))
Cancel a refund Use the `/transfer/refund/cancel` endpoint to cancel a refund.
-
#transfer_refund_create(*, transfer_refund_create_request : Plaid::TransferRefundCreateRequest | Nil = nil) : TransferRefundCreateResponse
Create a refund Use the
/transfer/refund/create
endpoint to create a refund for a transfer. -
#transfer_refund_create(*, transfer_refund_create_request : Plaid::TransferRefundCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a refund Use the `/transfer/refund/create` endpoint to create a refund for a transfer.
-
#transfer_refund_create_with_http_info(*, transfer_refund_create_request : Plaid::TransferRefundCreateRequest | Nil = nil) : Tuple(TransferRefundCreateResponse, Int32, Hash(String, Array(String) | String))
Create a refund Use the `/transfer/refund/create` endpoint to create a refund for a transfer.
-
#transfer_refund_get(*, transfer_refund_get_request : Plaid::TransferRefundGetRequest | Nil = nil) : TransferRefundGetResponse
Retrieve a refund The
/transfer/refund/get
endpoint fetches information about the refund corresponding to the givenrefund_id
. -
#transfer_refund_get(*, transfer_refund_get_request : Plaid::TransferRefundGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a refund The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`.
-
#transfer_refund_get_with_http_info(*, transfer_refund_get_request : Plaid::TransferRefundGetRequest | Nil = nil) : Tuple(TransferRefundGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a refund The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`.
-
#transfer_repayment_list(*, transfer_repayment_list_request : Plaid::TransferRepaymentListRequest | Nil = nil) : TransferRepaymentListResponse
Lists historical repayments The
/transfer/repayment/list
endpoint fetches repayments matching the given filters. -
#transfer_repayment_list(*, transfer_repayment_list_request : Plaid::TransferRepaymentListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Lists historical repayments The `/transfer/repayment/list` endpoint fetches repayments matching the given filters.
-
#transfer_repayment_list_with_http_info(*, transfer_repayment_list_request : Plaid::TransferRepaymentListRequest | Nil = nil) : Tuple(TransferRepaymentListResponse, Int32, Hash(String, Array(String) | String))
Lists historical repayments The `/transfer/repayment/list` endpoint fetches repayments matching the given filters.
-
#transfer_repayment_return_list(*, transfer_repayment_return_list_request : Plaid::TransferRepaymentReturnListRequest | Nil = nil) : TransferRepaymentReturnListResponse
List the returns included in a repayment The
/transfer/repayment/return/list
endpoint retrieves the set of returns that were batched together into the specified repayment. -
#transfer_repayment_return_list(*, transfer_repayment_return_list_request : Plaid::TransferRepaymentReturnListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List the returns included in a repayment The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment.
-
#transfer_repayment_return_list_with_http_info(*, transfer_repayment_return_list_request : Plaid::TransferRepaymentReturnListRequest | Nil = nil) : Tuple(TransferRepaymentReturnListResponse, Int32, Hash(String, Array(String) | String))
List the returns included in a repayment The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment.
-
#transfer_sweep_get(*, transfer_sweep_get_request : Plaid::TransferSweepGetRequest | Nil = nil) : TransferSweepGetResponse
Retrieve a sweep The
/transfer/sweep/get
endpoint fetches a sweep corresponding to the givensweep_id
. -
#transfer_sweep_get(*, transfer_sweep_get_request : Plaid::TransferSweepGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a sweep The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
-
#transfer_sweep_get_with_http_info(*, transfer_sweep_get_request : Plaid::TransferSweepGetRequest | Nil = nil) : Tuple(TransferSweepGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve a sweep The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
-
#transfer_sweep_list(*, transfer_sweep_list_request : Plaid::TransferSweepListRequest | Nil = nil) : TransferSweepListResponse
List sweeps The
/transfer/sweep/list
endpoint fetches sweeps matching the given filters. -
#transfer_sweep_list(*, transfer_sweep_list_request : Plaid::TransferSweepListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List sweeps The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.
-
#transfer_sweep_list_with_http_info(*, transfer_sweep_list_request : Plaid::TransferSweepListRequest | Nil = nil) : Tuple(TransferSweepListResponse, Int32, Hash(String, Array(String) | String))
List sweeps The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.
-
#user_create(*, user_create_request : Plaid::UserCreateRequest | Nil = nil) : UserCreateResponse
Create user This endpoint should be called for each of your end users before they begin a Plaid income flow.
-
#user_create(*, user_create_request : Plaid::UserCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create user This endpoint should be called for each of your end users before they begin a Plaid income flow.
-
#user_create_with_http_info(*, user_create_request : Plaid::UserCreateRequest | Nil = nil) : Tuple(UserCreateResponse, Int32, Hash(String, Array(String) | String))
Create user This endpoint should be called for each of your end users before they begin a Plaid income flow.
-
#user_update(*, user_update_request : Plaid::UserUpdateRequest | Nil = nil) : UserUpdateResponse
Update user information This endpoint is used to update user information associated with an existing
user_token
. -
#user_update(*, user_update_request : Plaid::UserUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update user information This endpoint is used to update user information associated with an existing `user_token`.
-
#user_update_with_http_info(*, user_update_request : Plaid::UserUpdateRequest | Nil = nil) : Tuple(UserUpdateResponse, Int32, Hash(String, Array(String) | String))
Update user information This endpoint is used to update user information associated with an existing `user_token`.
-
#wallet_create(*, wallet_create_request : Plaid::WalletCreateRequest | Nil = nil) : Plaid::WalletCreateResponse
Create an e-wallet Create an e-wallet.
-
#wallet_create(*, wallet_create_request : Plaid::WalletCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create an e-wallet Create an e-wallet.
-
#wallet_create_with_http_info(*, wallet_create_request : Plaid::WalletCreateRequest | Nil = nil) : Tuple(Plaid::WalletCreateResponse, Int32, Hash(String, Array(String) | String))
Create an e-wallet Create an e-wallet.
-
#wallet_get(*, wallet_get_request : Plaid::WalletGetRequest | Nil = nil) : Plaid::WalletGetResponse
Fetch an e-wallet Fetch an e-wallet.
-
#wallet_get(*, wallet_get_request : Plaid::WalletGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an e-wallet Fetch an e-wallet.
-
#wallet_get_with_http_info(*, wallet_get_request : Plaid::WalletGetRequest | Nil = nil) : Tuple(Plaid::WalletGetResponse, Int32, Hash(String, Array(String) | String))
Fetch an e-wallet Fetch an e-wallet.
-
#wallet_list(*, wallet_list_request : Plaid::WalletListRequest | Nil = nil) : WalletListResponse
Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation.
-
#wallet_list(*, wallet_list_request : Plaid::WalletListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation.
-
#wallet_list_with_http_info(*, wallet_list_request : Plaid::WalletListRequest | Nil = nil) : Tuple(WalletListResponse, Int32, Hash(String, Array(String) | String))
Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation.
-
#wallet_transaction_execute(*, wallet_transaction_execute_request : Plaid::WalletTransactionExecuteRequest | Nil = nil) : WalletTransactionExecuteResponse
Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet.
-
#wallet_transaction_execute(*, wallet_transaction_execute_request : Plaid::WalletTransactionExecuteRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet.
-
#wallet_transaction_execute_with_http_info(*, wallet_transaction_execute_request : Plaid::WalletTransactionExecuteRequest | Nil = nil) : Tuple(WalletTransactionExecuteResponse, Int32, Hash(String, Array(String) | String))
Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet.
-
#wallet_transaction_get(*, wallet_transaction_get_request : Plaid::WalletTransactionGetRequest | Nil = nil) : Plaid::WalletTransactionGetResponse
Fetch an e-wallet transaction Fetch a specific e-wallet transaction @required @param wallet_transaction_get_request [Plaid::WalletTransactionGetRequest?] @return [Plaid::WalletTransactionGetResponse]
-
#wallet_transaction_get(*, wallet_transaction_get_request : Plaid::WalletTransactionGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an e-wallet transaction Fetch a specific e-wallet transaction @required @param wallet_transaction_get_request [Plaid::WalletTransactionGetRequest?] @return nil
-
#wallet_transaction_get_with_http_info(*, wallet_transaction_get_request : Plaid::WalletTransactionGetRequest | Nil = nil) : Tuple(Plaid::WalletTransactionGetResponse, Int32, Hash(String, Array(String) | String))
Fetch an e-wallet transaction Fetch a specific e-wallet transaction @required @param wallet_transaction_get_request [Plaid::WalletTransactionGetRequest?] @return [Tuple(Plaid::WalletTransactionGetResponse, Integer, Hash)] Plaid::WalletTransactionGetResponse, response status code and response headers
-
#wallet_transaction_list(*, wallet_transaction_list_request : Plaid::WalletTransactionListRequest | Nil = nil) : WalletTransactionListResponse
List e-wallet transactions This endpoint lists the latest transactions of the specified e-wallet.
-
#wallet_transaction_list(*, wallet_transaction_list_request : Plaid::WalletTransactionListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List e-wallet transactions This endpoint lists the latest transactions of the specified e-wallet.
-
#wallet_transaction_list_with_http_info(*, wallet_transaction_list_request : Plaid::WalletTransactionListRequest | Nil = nil) : Tuple(WalletTransactionListResponse, Int32, Hash(String, Array(String) | String))
List e-wallet transactions This endpoint lists the latest transactions of the specified e-wallet.
-
#watchlist_screening_entity_create(*, watchlist_screening_entity_create_request : Plaid::WatchlistScreeningEntityCreateRequest | Nil = nil) : WatchlistScreeningEntityCreateResponse
Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program.
-
#watchlist_screening_entity_create(*, watchlist_screening_entity_create_request : Plaid::WatchlistScreeningEntityCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program.
-
#watchlist_screening_entity_create_with_http_info(*, watchlist_screening_entity_create_request : Plaid::WatchlistScreeningEntityCreateRequest | Nil = nil) : Tuple(WatchlistScreeningEntityCreateResponse, Int32, Hash(String, Array(String) | String))
Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program.
-
#watchlist_screening_entity_get(*, watchlist_screening_entity_get_request : Plaid::WatchlistScreeningEntityGetRequest | Nil = nil) : WatchlistScreeningEntityGetResponse
Get an entity screening Retrieve an entity watchlist screening.
-
#watchlist_screening_entity_get(*, watchlist_screening_entity_get_request : Plaid::WatchlistScreeningEntityGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get an entity screening Retrieve an entity watchlist screening.
-
#watchlist_screening_entity_get_with_http_info(*, watchlist_screening_entity_get_request : Plaid::WatchlistScreeningEntityGetRequest | Nil = nil) : Tuple(WatchlistScreeningEntityGetResponse, Int32, Hash(String, Array(String) | String))
Get an entity screening Retrieve an entity watchlist screening.
-
#watchlist_screening_entity_history_list(*, watchlist_screening_entity_history_list_request : Plaid::WatchlistScreeningEntityHistoryListRequest | Nil = nil) : WatchlistScreeningEntityHistoryListResponse
List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order.
-
#watchlist_screening_entity_history_list(*, watchlist_screening_entity_history_list_request : Plaid::WatchlistScreeningEntityHistoryListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order.
-
#watchlist_screening_entity_history_list_with_http_info(*, watchlist_screening_entity_history_list_request : Plaid::WatchlistScreeningEntityHistoryListRequest | Nil = nil) : Tuple(WatchlistScreeningEntityHistoryListResponse, Int32, Hash(String, Array(String) | String))
List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order.
-
#watchlist_screening_entity_hit_list(*, watchlist_screening_entity_hit_list_request : Plaid::WatchlistScreeningEntityHitListRequest | Nil = nil) : WatchlistScreeningEntityHitListResponse
List hits for entity watchlist screenings List all hits for the entity watchlist screening.
-
#watchlist_screening_entity_hit_list(*, watchlist_screening_entity_hit_list_request : Plaid::WatchlistScreeningEntityHitListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List hits for entity watchlist screenings List all hits for the entity watchlist screening.
-
#watchlist_screening_entity_hit_list_with_http_info(*, watchlist_screening_entity_hit_list_request : Plaid::WatchlistScreeningEntityHitListRequest | Nil = nil) : Tuple(WatchlistScreeningEntityHitListResponse, Int32, Hash(String, Array(String) | String))
List hits for entity watchlist screenings List all hits for the entity watchlist screening.
-
#watchlist_screening_entity_list(*, watchlist_screening_entity_list_request : Plaid::WatchlistScreeningEntityListRequest | Nil = nil) : WatchlistScreeningEntityListResponse
List entity watchlist screenings List all entity screenings.
-
#watchlist_screening_entity_list(*, watchlist_screening_entity_list_request : Plaid::WatchlistScreeningEntityListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List entity watchlist screenings List all entity screenings.
-
#watchlist_screening_entity_list_with_http_info(*, watchlist_screening_entity_list_request : Plaid::WatchlistScreeningEntityListRequest | Nil = nil) : Tuple(WatchlistScreeningEntityListResponse, Int32, Hash(String, Array(String) | String))
List entity watchlist screenings List all entity screenings.
-
#watchlist_screening_entity_program_get(*, watchlist_screening_entity_program_get_request : Plaid::WatchlistScreeningEntityProgramGetRequest | Nil = nil) : WatchlistScreeningEntityProgramGetResponse
Get entity watchlist screening program Get an entity watchlist screening program @required @param watchlist_screening_entity_program_get_request [Plaid::WatchlistScreeningEntityProgramGetRequest?] @return [WatchlistScreeningEntityProgramGetResponse]
-
#watchlist_screening_entity_program_get(*, watchlist_screening_entity_program_get_request : Plaid::WatchlistScreeningEntityProgramGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get entity watchlist screening program Get an entity watchlist screening program @required @param watchlist_screening_entity_program_get_request [Plaid::WatchlistScreeningEntityProgramGetRequest?] @return nil
-
#watchlist_screening_entity_program_get_with_http_info(*, watchlist_screening_entity_program_get_request : Plaid::WatchlistScreeningEntityProgramGetRequest | Nil = nil) : Tuple(WatchlistScreeningEntityProgramGetResponse, Int32, Hash(String, Array(String) | String))
Get entity watchlist screening program Get an entity watchlist screening program @required @param watchlist_screening_entity_program_get_request [Plaid::WatchlistScreeningEntityProgramGetRequest?] @return [Tuple(WatchlistScreeningEntityProgramGetResponse, Integer, Hash)] WatchlistScreeningEntityProgramGetResponse, response status code and response headers
-
#watchlist_screening_entity_program_list(*, watchlist_screening_entity_program_list_request : Plaid::WatchlistScreeningEntityProgramListRequest | Nil = nil) : WatchlistScreeningEntityProgramListResponse
List entity watchlist screening programs List all entity watchlist screening programs @required @param watchlist_screening_entity_program_list_request [Plaid::WatchlistScreeningEntityProgramListRequest?] @return [WatchlistScreeningEntityProgramListResponse]
-
#watchlist_screening_entity_program_list(*, watchlist_screening_entity_program_list_request : Plaid::WatchlistScreeningEntityProgramListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List entity watchlist screening programs List all entity watchlist screening programs @required @param watchlist_screening_entity_program_list_request [Plaid::WatchlistScreeningEntityProgramListRequest?] @return nil
-
#watchlist_screening_entity_program_list_with_http_info(*, watchlist_screening_entity_program_list_request : Plaid::WatchlistScreeningEntityProgramListRequest | Nil = nil) : Tuple(WatchlistScreeningEntityProgramListResponse, Int32, Hash(String, Array(String) | String))
List entity watchlist screening programs List all entity watchlist screening programs @required @param watchlist_screening_entity_program_list_request [Plaid::WatchlistScreeningEntityProgramListRequest?] @return [Tuple(WatchlistScreeningEntityProgramListResponse, Integer, Hash)] WatchlistScreeningEntityProgramListResponse, response status code and response headers
-
#watchlist_screening_entity_review_create(*, watchlist_screening_entity_review_create_request : Plaid::WatchlistScreeningEntityReviewCreateRequest | Nil = nil) : WatchlistScreeningEntityReviewCreateResponse
Create a review for an entity watchlist screening Create a review for an entity watchlist screening.
-
#watchlist_screening_entity_review_create(*, watchlist_screening_entity_review_create_request : Plaid::WatchlistScreeningEntityReviewCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a review for an entity watchlist screening Create a review for an entity watchlist screening.
-
#watchlist_screening_entity_review_create_with_http_info(*, watchlist_screening_entity_review_create_request : Plaid::WatchlistScreeningEntityReviewCreateRequest | Nil = nil) : Tuple(WatchlistScreeningEntityReviewCreateResponse, Int32, Hash(String, Array(String) | String))
Create a review for an entity watchlist screening Create a review for an entity watchlist screening.
-
#watchlist_screening_entity_review_list(*, watchlist_screening_entity_review_list_request : Plaid::WatchlistScreeningEntityReviewListRequest | Nil = nil) : WatchlistScreeningEntityReviewListResponse
List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening.
-
#watchlist_screening_entity_review_list(*, watchlist_screening_entity_review_list_request : Plaid::WatchlistScreeningEntityReviewListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening.
-
#watchlist_screening_entity_review_list_with_http_info(*, watchlist_screening_entity_review_list_request : Plaid::WatchlistScreeningEntityReviewListRequest | Nil = nil) : Tuple(WatchlistScreeningEntityReviewListResponse, Int32, Hash(String, Array(String) | String))
List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening.
-
#watchlist_screening_entity_update(*, watchlist_screening_entity_update_request : Plaid::WatchlistScreeningEntityUpdateRequest | Nil = nil) : WatchlistScreeningEntityUpdateResponse
Update an entity screening Update an entity watchlist screening.
-
#watchlist_screening_entity_update(*, watchlist_screening_entity_update_request : Plaid::WatchlistScreeningEntityUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update an entity screening Update an entity watchlist screening.
-
#watchlist_screening_entity_update_with_http_info(*, watchlist_screening_entity_update_request : Plaid::WatchlistScreeningEntityUpdateRequest | Nil = nil) : Tuple(WatchlistScreeningEntityUpdateResponse, Int32, Hash(String, Array(String) | String))
Update an entity screening Update an entity watchlist screening.
-
#watchlist_screening_individual_create(*, watchlist_screening_individual_create_request : Plaid::WatchlistScreeningIndividualCreateRequest | Nil = nil) : WatchlistScreeningIndividualCreateResponse
Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program.
-
#watchlist_screening_individual_create(*, watchlist_screening_individual_create_request : Plaid::WatchlistScreeningIndividualCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program.
-
#watchlist_screening_individual_create_with_http_info(*, watchlist_screening_individual_create_request : Plaid::WatchlistScreeningIndividualCreateRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualCreateResponse, Int32, Hash(String, Array(String) | String))
Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program.
-
#watchlist_screening_individual_get(*, watchlist_screening_individual_get_request : Plaid::WatchlistScreeningIndividualGetRequest | Nil = nil) : WatchlistScreeningIndividualGetResponse
Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening @required @param watchlist_screening_individual_get_request [Plaid::WatchlistScreeningIndividualGetRequest?] @return [WatchlistScreeningIndividualGetResponse]
-
#watchlist_screening_individual_get(*, watchlist_screening_individual_get_request : Plaid::WatchlistScreeningIndividualGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening @required @param watchlist_screening_individual_get_request [Plaid::WatchlistScreeningIndividualGetRequest?] @return nil
-
#watchlist_screening_individual_get_with_http_info(*, watchlist_screening_individual_get_request : Plaid::WatchlistScreeningIndividualGetRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualGetResponse, Int32, Hash(String, Array(String) | String))
Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening @required @param watchlist_screening_individual_get_request [Plaid::WatchlistScreeningIndividualGetRequest?] @return [Tuple(WatchlistScreeningIndividualGetResponse, Integer, Hash)] WatchlistScreeningIndividualGetResponse, response status code and response headers
-
#watchlist_screening_individual_history_list(*, watchlist_screening_individual_history_list_request : Plaid::WatchlistScreeningIndividualHistoryListRequest | Nil = nil) : WatchlistScreeningIndividualHistoryListResponse
List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order.
-
#watchlist_screening_individual_history_list(*, watchlist_screening_individual_history_list_request : Plaid::WatchlistScreeningIndividualHistoryListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order.
-
#watchlist_screening_individual_history_list_with_http_info(*, watchlist_screening_individual_history_list_request : Plaid::WatchlistScreeningIndividualHistoryListRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualHistoryListResponse, Int32, Hash(String, Array(String) | String))
List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order.
-
#watchlist_screening_individual_hit_list(*, watchlist_screening_individual_hit_list_request : Plaid::WatchlistScreeningIndividualHitListRequest | Nil = nil) : WatchlistScreeningIndividualHitListResponse
List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening.
-
#watchlist_screening_individual_hit_list(*, watchlist_screening_individual_hit_list_request : Plaid::WatchlistScreeningIndividualHitListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening.
-
#watchlist_screening_individual_hit_list_with_http_info(*, watchlist_screening_individual_hit_list_request : Plaid::WatchlistScreeningIndividualHitListRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualHitListResponse, Int32, Hash(String, Array(String) | String))
List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening.
-
#watchlist_screening_individual_list(*, watchlist_screening_individual_list_request : Plaid::WatchlistScreeningIndividualListRequest | Nil = nil) : WatchlistScreeningIndividualListResponse
List Individual Watchlist Screenings List previously created watchlist screenings for individuals @required @param watchlist_screening_individual_list_request [Plaid::WatchlistScreeningIndividualListRequest?] @return [WatchlistScreeningIndividualListResponse]
-
#watchlist_screening_individual_list(*, watchlist_screening_individual_list_request : Plaid::WatchlistScreeningIndividualListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List Individual Watchlist Screenings List previously created watchlist screenings for individuals @required @param watchlist_screening_individual_list_request [Plaid::WatchlistScreeningIndividualListRequest?] @return nil
-
#watchlist_screening_individual_list_with_http_info(*, watchlist_screening_individual_list_request : Plaid::WatchlistScreeningIndividualListRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualListResponse, Int32, Hash(String, Array(String) | String))
List Individual Watchlist Screenings List previously created watchlist screenings for individuals @required @param watchlist_screening_individual_list_request [Plaid::WatchlistScreeningIndividualListRequest?] @return [Tuple(WatchlistScreeningIndividualListResponse, Integer, Hash)] WatchlistScreeningIndividualListResponse, response status code and response headers
-
#watchlist_screening_individual_program_get(*, watchlist_screening_individual_program_get_request : Plaid::WatchlistScreeningIndividualProgramGetRequest | Nil = nil) : WatchlistScreeningIndividualProgramGetResponse
Get individual watchlist screening program Get an individual watchlist screening program @required @param watchlist_screening_individual_program_get_request [Plaid::WatchlistScreeningIndividualProgramGetRequest?] @return [WatchlistScreeningIndividualProgramGetResponse]
-
#watchlist_screening_individual_program_get(*, watchlist_screening_individual_program_get_request : Plaid::WatchlistScreeningIndividualProgramGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get individual watchlist screening program Get an individual watchlist screening program @required @param watchlist_screening_individual_program_get_request [Plaid::WatchlistScreeningIndividualProgramGetRequest?] @return nil
-
#watchlist_screening_individual_program_get_with_http_info(*, watchlist_screening_individual_program_get_request : Plaid::WatchlistScreeningIndividualProgramGetRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualProgramGetResponse, Int32, Hash(String, Array(String) | String))
Get individual watchlist screening program Get an individual watchlist screening program @required @param watchlist_screening_individual_program_get_request [Plaid::WatchlistScreeningIndividualProgramGetRequest?] @return [Tuple(WatchlistScreeningIndividualProgramGetResponse, Integer, Hash)] WatchlistScreeningIndividualProgramGetResponse, response status code and response headers
-
#watchlist_screening_individual_program_list(*, watchlist_screening_individual_program_list_request : Plaid::WatchlistScreeningIndividualProgramListRequest | Nil = nil) : WatchlistScreeningIndividualProgramListResponse
List individual watchlist screening programs List all individual watchlist screening programs @required @param watchlist_screening_individual_program_list_request [Plaid::WatchlistScreeningIndividualProgramListRequest?] @return [WatchlistScreeningIndividualProgramListResponse]
-
#watchlist_screening_individual_program_list(*, watchlist_screening_individual_program_list_request : Plaid::WatchlistScreeningIndividualProgramListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List individual watchlist screening programs List all individual watchlist screening programs @required @param watchlist_screening_individual_program_list_request [Plaid::WatchlistScreeningIndividualProgramListRequest?] @return nil
-
#watchlist_screening_individual_program_list_with_http_info(*, watchlist_screening_individual_program_list_request : Plaid::WatchlistScreeningIndividualProgramListRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualProgramListResponse, Int32, Hash(String, Array(String) | String))
List individual watchlist screening programs List all individual watchlist screening programs @required @param watchlist_screening_individual_program_list_request [Plaid::WatchlistScreeningIndividualProgramListRequest?] @return [Tuple(WatchlistScreeningIndividualProgramListResponse, Integer, Hash)] WatchlistScreeningIndividualProgramListResponse, response status code and response headers
-
#watchlist_screening_individual_review_create(*, watchlist_screening_individual_review_create_request : Plaid::WatchlistScreeningIndividualReviewCreateRequest | Nil = nil) : WatchlistScreeningIndividualReviewCreateResponse
Create a review for an individual watchlist screening Create a review for the individual watchlist screening.
-
#watchlist_screening_individual_review_create(*, watchlist_screening_individual_review_create_request : Plaid::WatchlistScreeningIndividualReviewCreateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Create a review for an individual watchlist screening Create a review for the individual watchlist screening.
-
#watchlist_screening_individual_review_create_with_http_info(*, watchlist_screening_individual_review_create_request : Plaid::WatchlistScreeningIndividualReviewCreateRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualReviewCreateResponse, Int32, Hash(String, Array(String) | String))
Create a review for an individual watchlist screening Create a review for the individual watchlist screening.
-
#watchlist_screening_individual_review_list(*, watchlist_screening_individual_review_list_request : Plaid::WatchlistScreeningIndividualReviewListRequest | Nil = nil) : WatchlistScreeningIndividualReviewListResponse
List reviews for individual watchlist screenings List all reviews for the individual watchlist screening.
-
#watchlist_screening_individual_review_list(*, watchlist_screening_individual_review_list_request : Plaid::WatchlistScreeningIndividualReviewListRequest | Nil = nil, &block : Crest::Response -> ) : Nil
List reviews for individual watchlist screenings List all reviews for the individual watchlist screening.
-
#watchlist_screening_individual_review_list_with_http_info(*, watchlist_screening_individual_review_list_request : Plaid::WatchlistScreeningIndividualReviewListRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualReviewListResponse, Int32, Hash(String, Array(String) | String))
List reviews for individual watchlist screenings List all reviews for the individual watchlist screening.
-
#watchlist_screening_individual_update(*, watchlist_screening_individual_update_request : Plaid::WatchlistScreeningIndividualUpdateRequest | Nil = nil) : WatchlistScreeningIndividualUpdateResponse
Update individual watchlist screening Update a specific individual watchlist screening.
-
#watchlist_screening_individual_update(*, watchlist_screening_individual_update_request : Plaid::WatchlistScreeningIndividualUpdateRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Update individual watchlist screening Update a specific individual watchlist screening.
-
#watchlist_screening_individual_update_with_http_info(*, watchlist_screening_individual_update_request : Plaid::WatchlistScreeningIndividualUpdateRequest | Nil = nil) : Tuple(WatchlistScreeningIndividualUpdateResponse, Int32, Hash(String, Array(String) | String))
Update individual watchlist screening Update a specific individual watchlist screening.
-
#webhook_verification_key_get(*, webhook_verification_key_get_request : Plaid::WebhookVerificationKeyGetRequest | Nil = nil) : WebhookVerificationKeyGetResponse
Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application.
-
#webhook_verification_key_get(*, webhook_verification_key_get_request : Plaid::WebhookVerificationKeyGetRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application.
-
#webhook_verification_key_get_with_http_info(*, webhook_verification_key_get_request : Plaid::WebhookVerificationKeyGetRequest | Nil = nil) : Tuple(WebhookVerificationKeyGetResponse, Int32, Hash(String, Array(String) | String))
Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application.
Constructor Detail
Instance Method Detail
Retrieve real-time balance data
The /accounts/balance/get
endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as /accounts/get
, return a balance object, only /accounts/balance/get
forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, balance
itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
@required @param accounts_balance_get_request [Plaid::AccountsBalanceGetRequest?]
@return [AccountsGetResponse]
Retrieve real-time balance data The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. @required @param accounts_balance_get_request [Plaid::AccountsBalanceGetRequest?] @return nil
Retrieve real-time balance data The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. @required @param accounts_balance_get_request [Plaid::AccountsBalanceGetRequest?] @return [Tuple(AccountsGetResponse, Integer, Hash)] AccountsGetResponse, response status code and response headers
Retrieve accounts
The /accounts/get
endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the NEW_ACCOUNTS_AVAILABLE
webhook and then use Link's update mode to request that the user share this new account with you. /accounts/get
is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint /accounts/balance/get
instead.
@required @param accounts_get_request [Plaid::AccountsGetRequest?]
@return [AccountsGetResponse]
Retrieve accounts The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the `NEW_ACCOUNTS_AVAILABLE` webhook and then use Link's update mode to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead. @required @param accounts_get_request [Plaid::AccountsGetRequest?] @return nil
Retrieve accounts The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the `NEW_ACCOUNTS_AVAILABLE` webhook and then use Link's update mode to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead. @required @param accounts_get_request [Plaid::AccountsGetRequest?] @return [Tuple(AccountsGetResponse, Integer, Hash)] AccountsGetResponse, response status code and response headers
Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences @required @param application_get_request [Plaid::ApplicationGetRequest?] @return [ApplicationGetResponse]
Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences @required @param application_get_request [Plaid::ApplicationGetRequest?] @return nil
Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences @required @param application_get_request [Plaid::ApplicationGetRequest?] @return [Tuple(ApplicationGetResponse, Integer, Hash)] ApplicationGetResponse, response status code and response headers
Create Asset Report Audit Copy
Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certaintyâ„¢ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the /asset_report/audit_copy/create
endpoint to create an audit_copy_token
and then pass that token to the third party who needs access. Each third party has its own auditor_id
, for example fannie_mae
. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
@required @param asset_report_audit_copy_create_request [Plaid::AssetReportAuditCopyCreateRequest?]
@return [AssetReportAuditCopyCreateResponse]
Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report. @required @param asset_report_audit_copy_create_request [Plaid::AssetReportAuditCopyCreateRequest?] @return nil
Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report. @required @param asset_report_audit_copy_create_request [Plaid::AssetReportAuditCopyCreateRequest?] @return [Tuple(AssetReportAuditCopyCreateResponse, Integer, Hash)] AssetReportAuditCopyCreateResponse, response status code and response headers
Retrieve an Asset Report Audit Copy
/asset_report/audit_copy/get
allows auditors to get a copy of an Asset Report that was previously shared via the /asset_report/audit_copy/create
endpoint. The caller of /asset_report/audit_copy/create
must provide the audit_copy_token
to the auditor. This token can then be used to call /asset_report/audit_copy/create
.
@required @param asset_report_audit_copy_get_request [Plaid::AssetReportAuditCopyGetRequest?]
@return [AssetReportGetResponse]
Retrieve an Asset Report Audit Copy `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/create`. @required @param asset_report_audit_copy_get_request [Plaid::AssetReportAuditCopyGetRequest?] @return nil
Retrieve an Asset Report Audit Copy `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/create`. @required @param asset_report_audit_copy_get_request [Plaid::AssetReportAuditCopyGetRequest?] @return [Tuple(AssetReportGetResponse, Integer, Hash)] AssetReportGetResponse, response status code and response headers
Remove Asset Report Audit Copy
The /asset_report/audit_copy/remove
endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the audit_copy_token
associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
@required @param asset_report_audit_copy_remove_request [Plaid::AssetReportAuditCopyRemoveRequest?]
@return [AssetReportAuditCopyRemoveResponse]
Remove Asset Report Audit Copy The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy. @required @param asset_report_audit_copy_remove_request [Plaid::AssetReportAuditCopyRemoveRequest?] @return nil
Remove Asset Report Audit Copy The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy. @required @param asset_report_audit_copy_remove_request [Plaid::AssetReportAuditCopyRemoveRequest?] @return [Tuple(AssetReportAuditCopyRemoveResponse, Integer, Hash)] AssetReportAuditCopyRemoveResponse, response status code and response headers
Create an Asset Report
The /asset_report/create
endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the asset_report_token
return value to the /asset_report/get
or /asset_report/pdf/get
endpoints. The Asset Report takes some time to be created and is not available immediately after calling /asset_report/create
. The exact amount of time to create the report will vary depending on how many days of history are requested and will typically range from a few seconds to about one minute. When the Asset Report is ready to be retrieved using /asset_report/get
or /asset_report/pdf/get
, Plaid will fire a PRODUCT_READY
webhook. For full details of the webhook schema, see Asset Report webhooks. The /asset_report/create
endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the /asset_report/refresh
endpoint.
@required @param asset_report_create_request [Plaid::AssetReportCreateRequest?]
@return [AssetReportCreateResponse]
Create an Asset Report The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. The exact amount of time to create the report will vary depending on how many days of history are requested and will typically range from a few seconds to about one minute. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see Asset Report webhooks. The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint. @required @param asset_report_create_request [Plaid::AssetReportCreateRequest?] @return nil
Create an Asset Report The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. The exact amount of time to create the report will vary depending on how many days of history are requested and will typically range from a few seconds to about one minute. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see Asset Report webhooks. The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint. @required @param asset_report_create_request [Plaid::AssetReportCreateRequest?] @return [Tuple(AssetReportCreateResponse, Integer, Hash)] AssetReportCreateResponse, response status code and response headers
Filter Asset Report
By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the /accounts/get
endpoint. To narrow an Asset Report to only a subset of accounts, use the /asset_report/filter
endpoint. To exclude certain Accounts from an Asset Report, first use the /asset_report/create
endpoint to create the report, then send the asset_report_token
along with a list of account_ids
to exclude to the /asset_report/filter
endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling /asset_report/filter
does not alter the original Asset Report in any way; rather, /asset_report/filter
creates a new Asset Report with a new token and id. Asset Reports created via /asset_report/filter
do not contain new Asset data, and are not billed. Plaid will fire a PRODUCT_READY
webhook once generation of the filtered Asset Report has completed.
@required @param asset_report_filter_request [Plaid::AssetReportFilterRequest?]
@return [AssetReportFilterResponse]
Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a `PRODUCT_READY` webhook once generation of the filtered Asset Report has completed. @required @param asset_report_filter_request [Plaid::AssetReportFilterRequest?] @return nil
Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a `PRODUCT_READY` webhook once generation of the filtered Asset Report has completed. @required @param asset_report_filter_request [Plaid::AssetReportFilterRequest?] @return [Tuple(AssetReportFilterResponse, Integer, Hash)] AssetReportFilterResponse, response status code and response headers
Retrieve an Asset Report
The /asset_report/get
endpoint retrieves the Asset Report in JSON format. Before calling /asset_report/get
, you must first create the Asset Report using /asset_report/create
(or filter an Asset Report using /asset_report/filter
) and then wait for the PRODUCT_READY
webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call /asset_report/get
endpoint with include_insights
set to true
. For latency-sensitive applications, you can optionally call /asset_report/create
with options.add_ons
set to [\"fast_assets\"]
. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
@required @param asset_report_get_request [Plaid::AssetReportGetRequest?]
@return [AssetReportGetResponse]
Retrieve an Asset Report The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the `PRODUCT_READY` webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `["fast_assets"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report. @required @param asset_report_get_request [Plaid::AssetReportGetRequest?] @return nil
Retrieve an Asset Report The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the `PRODUCT_READY` webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `["fast_assets"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report. @required @param asset_report_get_request [Plaid::AssetReportGetRequest?] @return [Tuple(AssetReportGetResponse, Integer, Hash)] AssetReportGetResponse, response status code and response headers
Retrieve a PDF Asset Report
The /asset_report/pdf/get
endpoint retrieves the Asset Report in PDF format. Before calling /asset_report/pdf/get
, you must first create the Asset Report using /asset_report/create
(or filter an Asset Report using /asset_report/filter
) and then wait for the PRODUCT_READY
webhook to fire, indicating that the Report is ready to be retrieved. The response to /asset_report/pdf/get
is the PDF binary data. The request_id
is returned in the Plaid-Request-ID
header. View a sample PDF Asset Report.
@required @param asset_report_pdf_get_request [Plaid::AssetReportPDFGetRequest?]
@return [::File]
Retrieve a PDF Asset Report The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the `PRODUCT_READY` webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. View a sample PDF Asset Report. @required @param asset_report_pdf_get_request [Plaid::AssetReportPDFGetRequest?] @return nil
Retrieve a PDF Asset Report The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the `PRODUCT_READY` webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. View a sample PDF Asset Report. @required @param asset_report_pdf_get_request [Plaid::AssetReportPDFGetRequest?] @return [Tuple(::File, Integer, Hash)] ::File, response status code and response headers
Refresh an Asset Report
An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the /asset_report/refresh
endpoint to create a new Asset Report based on the old one, but with the most recent data available. The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to /asset_report/filter
. By default, the new Asset Report will also use the same parameters you submitted with your original /asset_report/create
request, but the original days_requested
value and the values of any parameters in the options
object can be overridden with new values. To change these arguments, simply supply new values for them in your request to /asset_report/refresh
. Submit an empty string ("") for any previously-populated fields you would like set as empty.
@required @param asset_report_refresh_request [Plaid::AssetReportRefreshRequest?]
@return [AssetReportRefreshResponse]
Refresh an Asset Report An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available. The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string ("") for any previously-populated fields you would like set as empty. @required @param asset_report_refresh_request [Plaid::AssetReportRefreshRequest?] @return nil
Refresh an Asset Report An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available. The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string ("") for any previously-populated fields you would like set as empty. @required @param asset_report_refresh_request [Plaid::AssetReportRefreshRequest?] @return [Tuple(AssetReportRefreshResponse, Integer, Hash)] AssetReportRefreshResponse, response status code and response headers
Delete an Asset Report
The /item/remove
endpoint allows you to invalidate an access_token
, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The /asset_report/remove
endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its asset_report_token
, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any audit_copy_tokens
associated with the Asset Report.
@required @param asset_report_remove_request [Plaid::AssetReportRemoveRequest?]
@return [AssetReportRemoveResponse]
Delete an Asset Report The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report. @required @param asset_report_remove_request [Plaid::AssetReportRemoveRequest?] @return nil
Delete an Asset Report The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report. @required @param asset_report_remove_request [Plaid::AssetReportRemoveRequest?] @return [Tuple(AssetReportRemoveResponse, Integer, Hash)] AssetReportRemoveResponse, response status code and response headers
Retrieve auth data
The /auth/get
endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if auth
was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Versioning note: In API version 2017-03-08, the schema of the numbers
object returned by this endpoint is substantially different. For details, see Plaid API versioning.
@required @param auth_get_request [Plaid::AuthGetRequest?]
@return [AuthGetResponse]
Retrieve auth data The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see Plaid API versioning. @required @param auth_get_request [Plaid::AuthGetRequest?] @return nil
Retrieve auth data The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see Plaid API versioning. @required @param auth_get_request [Plaid::AuthGetRequest?] @return [Tuple(AuthGetResponse, Integer, Hash)] AuthGetResponse, response status code and response headers
Get balance of your Bank Transfer account
Use the /bank_transfer/balance/get
endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
@required @param bank_transfer_balance_get_request [Plaid::BankTransferBalanceGetRequest?]
@return [BankTransferBalanceGetResponse]
Get balance of your Bank Transfer account Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration. @required @param bank_transfer_balance_get_request [Plaid::BankTransferBalanceGetRequest?] @return nil
Get balance of your Bank Transfer account Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration. @required @param bank_transfer_balance_get_request [Plaid::BankTransferBalanceGetRequest?] @return [Tuple(BankTransferBalanceGetResponse, Integer, Hash)] BankTransferBalanceGetResponse, response status code and response headers
Cancel a bank transfer
Use the /bank_transfer/cancel
endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the cancellable
property returned by /bank_transfer/get
is true
.
@required @param bank_transfer_cancel_request [Plaid::BankTransferCancelRequest?]
@return [BankTransferCancelResponse]
Cancel a bank transfer Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`. @required @param bank_transfer_cancel_request [Plaid::BankTransferCancelRequest?] @return nil
Cancel a bank transfer Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`. @required @param bank_transfer_cancel_request [Plaid::BankTransferCancelRequest?] @return [Tuple(BankTransferCancelResponse, Integer, Hash)] BankTransferCancelResponse, response status code and response headers
Create a bank transfer
Use the /bank_transfer/create
endpoint to initiate a new bank transfer.
@required @param bank_transfer_create_request [Plaid::BankTransferCreateRequest?]
@return [BankTransferCreateResponse]
Create a bank transfer Use the `/bank_transfer/create` endpoint to initiate a new bank transfer. @required @param bank_transfer_create_request [Plaid::BankTransferCreateRequest?] @return nil
Create a bank transfer Use the `/bank_transfer/create` endpoint to initiate a new bank transfer. @required @param bank_transfer_create_request [Plaid::BankTransferCreateRequest?] @return [Tuple(BankTransferCreateResponse, Integer, Hash)] BankTransferCreateResponse, response status code and response headers
List bank transfer events
Use the /bank_transfer/event/list
endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see micro-deposit events.
@required @param bank_transfer_event_list_request [Plaid::BankTransferEventListRequest?]
@return [BankTransferEventListResponse]
List bank transfer events Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see micro-deposit events. @required @param bank_transfer_event_list_request [Plaid::BankTransferEventListRequest?] @return nil
List bank transfer events Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see micro-deposit events. @required @param bank_transfer_event_list_request [Plaid::BankTransferEventListRequest?] @return [Tuple(BankTransferEventListResponse, Integer, Hash)] BankTransferEventListResponse, response status code and response headers
Sync bank transfer events
/bank_transfer/event/sync
allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific event_id
. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see micro-deposit events.
@required @param bank_transfer_event_sync_request [Plaid::BankTransferEventSyncRequest?]
@return [BankTransferEventSyncResponse]
Sync bank transfer events `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see micro-deposit events. @required @param bank_transfer_event_sync_request [Plaid::BankTransferEventSyncRequest?] @return nil
Sync bank transfer events `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see micro-deposit events. @required @param bank_transfer_event_sync_request [Plaid::BankTransferEventSyncRequest?] @return [Tuple(BankTransferEventSyncResponse, Integer, Hash)] BankTransferEventSyncResponse, response status code and response headers
Retrieve a bank transfer
The /bank_transfer/get
fetches information about the bank transfer corresponding to the given bank_transfer_id
.
@required @param bank_transfer_get_request [Plaid::BankTransferGetRequest?]
@return [BankTransferGetResponse]
Retrieve a bank transfer The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`. @required @param bank_transfer_get_request [Plaid::BankTransferGetRequest?] @return nil
Retrieve a bank transfer The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`. @required @param bank_transfer_get_request [Plaid::BankTransferGetRequest?] @return [Tuple(BankTransferGetResponse, Integer, Hash)] BankTransferGetResponse, response status code and response headers
List bank transfers
Use the /bank_transfer/list
endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the count
and offset
query parameters to retrieve the desired bank transfers.
@required @param bank_transfer_list_request [Plaid::BankTransferListRequest?]
@return [BankTransferListResponse]
List bank transfers Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers. @required @param bank_transfer_list_request [Plaid::BankTransferListRequest?] @return nil
List bank transfers Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers. @required @param bank_transfer_list_request [Plaid::BankTransferListRequest?] @return [Tuple(BankTransferListResponse, Integer, Hash)] BankTransferListResponse, response status code and response headers
Migrate account into Bank Transfers
As an alternative to adding Items via Link, you can also use the /bank_transfer/migrate_account
endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as /accounts/balance/get
, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to /bank_transfer/migrate_account
is not enabled by default; to obtain access, contact your Plaid Account Manager.
@required @param bank_transfer_migrate_account_request [Plaid::BankTransferMigrateAccountRequest?]
@return [BankTransferMigrateAccountResponse]
Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager. @required @param bank_transfer_migrate_account_request [Plaid::BankTransferMigrateAccountRequest?] @return nil
Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager. @required @param bank_transfer_migrate_account_request [Plaid::BankTransferMigrateAccountRequest?] @return [Tuple(BankTransferMigrateAccountResponse, Integer, Hash)] BankTransferMigrateAccountResponse, response status code and response headers
Retrieve a sweep
The /bank_transfer/sweep/get
endpoint fetches information about the sweep corresponding to the given sweep_id
.
@required @param bank_transfer_sweep_get_request [Plaid::BankTransferSweepGetRequest?]
@return [BankTransferSweepGetResponse]
Retrieve a sweep The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`. @required @param bank_transfer_sweep_get_request [Plaid::BankTransferSweepGetRequest?] @return nil
Retrieve a sweep The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`. @required @param bank_transfer_sweep_get_request [Plaid::BankTransferSweepGetRequest?] @return [Tuple(BankTransferSweepGetResponse, Integer, Hash)] BankTransferSweepGetResponse, response status code and response headers
List sweeps
The /bank_transfer/sweep/list
endpoint fetches information about the sweeps matching the given filters.
@required @param bank_transfer_sweep_list_request [Plaid::BankTransferSweepListRequest?]
@return [BankTransferSweepListResponse]
List sweeps The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters. @required @param bank_transfer_sweep_list_request [Plaid::BankTransferSweepListRequest?] @return nil
List sweeps The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters. @required @param bank_transfer_sweep_list_request [Plaid::BankTransferSweepListRequest?] @return [Tuple(BankTransferSweepListResponse, Integer, Hash)] BankTransferSweepListResponse, response status code and response headers
Retrieve a Base Report
This endpoint allows the customer to retrieve a Base Report. Customers should pass in the user_token
created in /link/token/create
.
@required @param base_report_get_request [Plaid::BaseReportGetRequest?]
@return [BaseReportGetResponse]
Retrieve a Base Report This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/link/token/create`. @required @param base_report_get_request [Plaid::BaseReportGetRequest?] @return nil
Retrieve a Base Report This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/link/token/create`. @required @param base_report_get_request [Plaid::BaseReportGetRequest?] @return [Tuple(BaseReportGetResponse, Integer, Hash)] BaseReportGetResponse, response status code and response headers
Create a Beacon Report
Create a fraud report for a given Beacon User. Note: If you are creating users with the express purpose of providing historical fraud data, you should use the /beacon/user/create
endpoint instead and embed the fraud report in the request. This will ensure that the Beacon User you create will not be subject to any billing costs.
@required @param beacon_report_create_request [Plaid::BeaconReportCreateRequest?]
@return [BeaconReportCreateResponse]
Create a Beacon Report Create a fraud report for a given Beacon User. Note: If you are creating users with the express purpose of providing historical fraud data, you should use the `/beacon/user/create` endpoint instead and embed the fraud report in the request. This will ensure that the Beacon User you create will not be subject to any billing costs. @required @param beacon_report_create_request [Plaid::BeaconReportCreateRequest?] @return nil
Create a Beacon Report Create a fraud report for a given Beacon User. Note: If you are creating users with the express purpose of providing historical fraud data, you should use the `/beacon/user/create` endpoint instead and embed the fraud report in the request. This will ensure that the Beacon User you create will not be subject to any billing costs. @required @param beacon_report_create_request [Plaid::BeaconReportCreateRequest?] @return [Tuple(BeaconReportCreateResponse, Integer, Hash)] BeaconReportCreateResponse, response status code and response headers
Get a Beacon Report Returns a Beacon report for a given Beacon report id. @required @param beacon_report_get_request [Plaid::BeaconReportGetRequest?] @return [BeaconReportGetResponse]
Get a Beacon Report Returns a Beacon report for a given Beacon report id. @required @param beacon_report_get_request [Plaid::BeaconReportGetRequest?] @return nil
Get a Beacon Report Returns a Beacon report for a given Beacon report id. @required @param beacon_report_get_request [Plaid::BeaconReportGetRequest?] @return [Tuple(BeaconReportGetResponse, Integer, Hash)] BeaconReportGetResponse, response status code and response headers
List Beacon Reports for a Beacon User
Use the /beacon/report/list
endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the next_cursor
field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the next_cursor
value as the cursor
parameter in the next request.
@required @param beacon_report_list_request [Plaid::BeaconReportListRequest?]
@return [BeaconReportListResponse]
List Beacon Reports for a Beacon User Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request. @required @param beacon_report_list_request [Plaid::BeaconReportListRequest?] @return nil
List Beacon Reports for a Beacon User Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request. @required @param beacon_report_list_request [Plaid::BeaconReportListRequest?] @return [Tuple(BeaconReportListResponse, Integer, Hash)] BeaconReportListResponse, response status code and response headers
List Beacon Report Syndications for a Beacon User
Use the /beacon/report_syndication/list
endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the next_cursor
field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the next_cursor
value as the cursor
parameter in the next request.
@required @param beacon_report_syndication_list_request [Plaid::BeaconReportSyndicationListRequest?]
@return [BeaconReportSyndicationListResponse]
List Beacon Report Syndications for a Beacon User Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request. @required @param beacon_report_syndication_list_request [Plaid::BeaconReportSyndicationListRequest?] @return nil
List Beacon Report Syndications for a Beacon User Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request. @required @param beacon_report_syndication_list_request [Plaid::BeaconReportSyndicationListRequest?] @return [Tuple(BeaconReportSyndicationListResponse, Integer, Hash)] BeaconReportSyndicationListResponse, response status code and response headers
Create a Beacon User
Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to /beacon/user/create
, several checks are performed immediately: - The user's PII (provided within the user
object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's "Duplicate Information Filtering" settings, the user will be returned with a status of pending_review
. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of rejected
. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a pending_review
status if your program has enabled automatic flagging based on network fraud.
@required @param beacon_user_create_request [Plaid::BeaconUserCreateRequest?]
@return [BeaconUserCreateResponse]
Create a Beacon User Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's "Duplicate Information Filtering" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. @required @param beacon_user_create_request [Plaid::BeaconUserCreateRequest?] @return nil
Create a Beacon User Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's "Duplicate Information Filtering" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. @required @param beacon_user_create_request [Plaid::BeaconUserCreateRequest?] @return [Tuple(BeaconUserCreateResponse, Integer, Hash)] BeaconUserCreateResponse, response status code and response headers
Get a Beacon User
Fetch a Beacon User. The Beacon User is returned with all of their associated information and a status
based on the Beacon Network duplicate record and fraud checks.
@required @param beacon_user_get_request [Plaid::BeaconUserGetRequest?]
@return [BeaconUserGetResponse]
Get a Beacon User Fetch a Beacon User. The Beacon User is returned with all of their associated information and a `status` based on the Beacon Network duplicate record and fraud checks. @required @param beacon_user_get_request [Plaid::BeaconUserGetRequest?] @return nil
Get a Beacon User Fetch a Beacon User. The Beacon User is returned with all of their associated information and a `status` based on the Beacon Network duplicate record and fraud checks. @required @param beacon_user_get_request [Plaid::BeaconUserGetRequest?] @return [Tuple(BeaconUserGetResponse, Integer, Hash)] BeaconUserGetResponse, response status code and response headers
Review a Beacon User Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User's status to "rejected", we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to "cleared", we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to "cleared". There are no restrictions on updating a Beacon User's status to "pending_review". If these conditions are not met, the request will be rejected with an error explaining the issue. @required @param beacon_user_review_request [Plaid::BeaconUserReviewRequest?] @return [BeaconUserGetResponse]
Review a Beacon User Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User's status to "rejected", we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to "cleared", we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to "cleared". There are no restrictions on updating a Beacon User's status to "pending_review". If these conditions are not met, the request will be rejected with an error explaining the issue. @required @param beacon_user_review_request [Plaid::BeaconUserReviewRequest?] @return nil
Review a Beacon User Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User's status to "rejected", we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to "cleared", we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to "cleared". There are no restrictions on updating a Beacon User's status to "pending_review". If these conditions are not met, the request will be rejected with an error explaining the issue. @required @param beacon_user_review_request [Plaid::BeaconUserReviewRequest?] @return [Tuple(BeaconUserGetResponse, Integer, Hash)] BeaconUserGetResponse, response status code and response headers
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Get categories
Send a request to the /categories/get
endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer personal_finance_category
taxonomy instead of the older category
taxonomy supported by this endpoint. The personal_finance_category taxonomy
CSV file is available for download and is not accessible via API.
@required @param body [Object?]
@return [CategoriesGetResponse]
Get categories Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The `personal_finance_category taxonomy` CSV file is available for download and is not accessible via API. @required @param body [Object?] @return nil
Get categories Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The `personal_finance_category taxonomy` CSV file is available for download and is not accessible via API. @required @param body [Object?] @return [Tuple(CategoriesGetResponse, Integer, Hash)] CategoriesGetResponse, response status code and response headers
Retrieve information from the bank accounts used for income verification
/cra/bank_income/get
returns the bank income report(s) for a specified user.
@required @param cra_bank_income_get_request [Plaid::CraBankIncomeGetRequest?]
@return [CraBankIncomeGetResponse]
Retrieve information from the bank accounts used for income verification `/cra/bank_income/get` returns the bank income report(s) for a specified user. @required @param cra_bank_income_get_request [Plaid::CraBankIncomeGetRequest?] @return nil
Retrieve information from the bank accounts used for income verification `/cra/bank_income/get` returns the bank income report(s) for a specified user. @required @param cra_bank_income_get_request [Plaid::CraBankIncomeGetRequest?] @return [Tuple(CraBankIncomeGetResponse, Integer, Hash)] CraBankIncomeGetResponse, response status code and response headers
Create payment token
The /payment_initiation/payment/token/create
endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, link_token
-based flow. The recommended flow is to provide the payment_id
to /link/token/create
, which returns a link_token
used to initialize Link. The /payment_initiation/payment/token/create
is used to create a payment_token
, which can then be used in Link initialization to enter a payment initiation flow. You can only use a payment_token
once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
@required @param payment_initiation_payment_token_create_request [Plaid::PaymentInitiationPaymentTokenCreateRequest?]
@return [PaymentInitiationPaymentTokenCreateResponse]
Create payment token The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input. @required @param payment_initiation_payment_token_create_request [Plaid::PaymentInitiationPaymentTokenCreateRequest?] @return nil
Create payment token The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input. @required @param payment_initiation_payment_token_create_request [Plaid::PaymentInitiationPaymentTokenCreateRequest?] @return [Tuple(PaymentInitiationPaymentTokenCreateResponse, Integer, Hash)] PaymentInitiationPaymentTokenCreateResponse, response status code and response headers
Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
The credit/asset_report/freddie_mac/get
endpoint retrieves the Asset Report in Freddie Mac's JSON format.
@required @param asset_report_freddie_get_request [Plaid::AssetReportFreddieGetRequest?]
@return [AssetReportFreddieGetResponse]
Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format. @required @param asset_report_freddie_get_request [Plaid::AssetReportFreddieGetRequest?] @return nil
Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format. @required @param asset_report_freddie_get_request [Plaid::AssetReportFreddieGetRequest?] @return [Tuple(AssetReportFreddieGetResponse, Integer, Hash)] AssetReportFreddieGetResponse, response status code and response headers
Create Asset or Income Report Audit Copy Token
Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certaintyâ„¢ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the /credit/audit_copy_token/create
endpoint to create an audit_copy_token
and then pass that token to the GSE who needs access.
@required @param credit_audit_copy_token_create_request [Plaid::CreditAuditCopyTokenCreateRequest?]
@return [CreditAuditCopyTokenCreateResponse]
Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certaintyâ„¢ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access. @required @param credit_audit_copy_token_create_request [Plaid::CreditAuditCopyTokenCreateRequest?] @return nil
Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certaintyâ„¢ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access. @required @param credit_audit_copy_token_create_request [Plaid::CreditAuditCopyTokenCreateRequest?] @return [Tuple(CreditAuditCopyTokenCreateResponse, Integer, Hash)] CreditAuditCopyTokenCreateResponse, response status code and response headers
Update an Audit Copy Token
The /credit/audit_copy_token/update
endpoint updates an existing Audit Copy Token by adding the report tokens in the report_tokens
field to the audit_copy_token
. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the report_tokens
field.
@required @param credit_audit_copy_token_update_request [Plaid::CreditAuditCopyTokenUpdateRequest?]
@return [CreditAuditCopyTokenUpdateResponse]
Update an Audit Copy Token The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field. @required @param credit_audit_copy_token_update_request [Plaid::CreditAuditCopyTokenUpdateRequest?] @return nil
Update an Audit Copy Token The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field. @required @param credit_audit_copy_token_update_request [Plaid::CreditAuditCopyTokenUpdateRequest?] @return [Tuple(CreditAuditCopyTokenUpdateResponse, Integer, Hash)] CreditAuditCopyTokenUpdateResponse, response status code and response headers
Retrieve information from the bank accounts used for employment verification
/credit/bank_employment/get
returns the employment report(s) derived from bank transaction data for a specified user.
@required @param credit_bank_employment_get_request [Plaid::CreditBankEmploymentGetRequest?]
@return [CreditBankEmploymentGetResponse]
Retrieve information from the bank accounts used for employment verification `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user. @required @param credit_bank_employment_get_request [Plaid::CreditBankEmploymentGetRequest?] @return nil
Retrieve information from the bank accounts used for employment verification `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user. @required @param credit_bank_employment_get_request [Plaid::CreditBankEmploymentGetRequest?] @return [Tuple(CreditBankEmploymentGetResponse, Integer, Hash)] CreditBankEmploymentGetResponse, response status code and response headers
Retrieve information from the bank accounts used for income verification
/credit/bank_income/get
returns the bank income report(s) for a specified user.
@required @param credit_bank_income_get_request [Plaid::CreditBankIncomeGetRequest?]
@return [CreditBankIncomeGetResponse]
Retrieve information from the bank accounts used for income verification `/credit/bank_income/get` returns the bank income report(s) for a specified user. @required @param credit_bank_income_get_request [Plaid::CreditBankIncomeGetRequest?] @return nil
Retrieve information from the bank accounts used for income verification `/credit/bank_income/get` returns the bank income report(s) for a specified user. @required @param credit_bank_income_get_request [Plaid::CreditBankIncomeGetRequest?] @return [Tuple(CreditBankIncomeGetResponse, Integer, Hash)] CreditBankIncomeGetResponse, response status code and response headers
Retrieve information from the bank accounts used for income verification in PDF format
/credit/bank_income/pdf/get
returns the most recent bank income report for a specified user in PDF format.
@required @param credit_bank_income_pdf_get_request [Plaid::CreditBankIncomePDFGetRequest?]
@return [::File]
Retrieve information from the bank accounts used for income verification in PDF format `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. @required @param credit_bank_income_pdf_get_request [Plaid::CreditBankIncomePDFGetRequest?] @return nil
Retrieve information from the bank accounts used for income verification in PDF format `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. @required @param credit_bank_income_pdf_get_request [Plaid::CreditBankIncomePDFGetRequest?] @return [Tuple(::File, Integer, Hash)] ::File, response status code and response headers
Refresh a user's bank income information
/credit/bank_income/refresh
refreshes the bank income report data for a specific user.
@required @param credit_bank_income_refresh_request [Plaid::CreditBankIncomeRefreshRequest?]
@return [CreditBankIncomeRefreshResponse]
Refresh a user's bank income information `/credit/bank_income/refresh` refreshes the bank income report data for a specific user. @required @param credit_bank_income_refresh_request [Plaid::CreditBankIncomeRefreshRequest?] @return nil
Refresh a user's bank income information `/credit/bank_income/refresh` refreshes the bank income report data for a specific user. @required @param credit_bank_income_refresh_request [Plaid::CreditBankIncomeRefreshRequest?] @return [Tuple(CreditBankIncomeRefreshResponse, Integer, Hash)] CreditBankIncomeRefreshResponse, response status code and response headers
Subscribe and unsubscribe to proactive notifications for a user's income profile
/credit/bank_income/webhook/update
allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user's income profile, you will receive a BANK_INCOME_REFRESH_UPDATE
webhook, prompting you to refresh bank income data for the user.
@required @param credit_bank_income_webhook_update_request [Plaid::CreditBankIncomeWebhookUpdateRequest?]
@return [CreditBankIncomeWebhookUpdateResponse]
Subscribe and unsubscribe to proactive notifications for a user's income profile `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user. @required @param credit_bank_income_webhook_update_request [Plaid::CreditBankIncomeWebhookUpdateRequest?] @return nil
Subscribe and unsubscribe to proactive notifications for a user's income profile `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user. @required @param credit_bank_income_webhook_update_request [Plaid::CreditBankIncomeWebhookUpdateRequest?] @return [Tuple(CreditBankIncomeWebhookUpdateResponse, Integer, Hash)] CreditBankIncomeWebhookUpdateResponse, response status code and response headers
Retrieve data for a user's uploaded bank statements
/credit/bank_statements/uploads/get
returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document Parsing, contact your account manager to request access.
@required @param credit_bank_statements_uploads_get_request [Plaid::CreditBankStatementsUploadsGetRequest?]
@return [CreditBankStatementsUploadsGetResponse]
Retrieve data for a user's uploaded bank statements `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document Parsing, contact your account manager to request access. @required @param credit_bank_statements_uploads_get_request [Plaid::CreditBankStatementsUploadsGetRequest?] @return nil
Retrieve data for a user's uploaded bank statements `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document Parsing, contact your account manager to request access. @required @param credit_bank_statements_uploads_get_request [Plaid::CreditBankStatementsUploadsGetRequest?] @return [Tuple(CreditBankStatementsUploadsGetResponse, Integer, Hash)] CreditBankStatementsUploadsGetResponse, response status code and response headers
Retrieve a summary of an individual's employment information
/credit/employment/get
returns a list of items with employment information from a user's payroll provider that was verified by an end user.
@required @param credit_employment_get_request [Plaid::CreditEmploymentGetRequest?]
@return [CreditEmploymentGetResponse]
Retrieve a summary of an individual's employment information `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user. @required @param credit_employment_get_request [Plaid::CreditEmploymentGetRequest?] @return nil
Retrieve a summary of an individual's employment information `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user. @required @param credit_employment_get_request [Plaid::CreditEmploymentGetRequest?] @return [Tuple(CreditEmploymentGetResponse, Integer, Hash)] CreditEmploymentGetResponse, response status code and response headers
Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
The credit/asset_report/freddie_mac/get
endpoint retrieves the Verification of Assets and Verification of Employment reports.
@required @param credit_freddie_mac_reports_get_request [Plaid::CreditFreddieMacReportsGetRequest?]
@return [CreditFreddieMacReportsGetResponse]
Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint. The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports. @required @param credit_freddie_mac_reports_get_request [Plaid::CreditFreddieMacReportsGetRequest?] @return nil
Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint. The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports. @required @param credit_freddie_mac_reports_get_request [Plaid::CreditFreddieMacReportsGetRequest?] @return [Tuple(CreditFreddieMacReportsGetResponse, Integer, Hash)] CreditFreddieMacReportsGetResponse, response status code and response headers
Retrieve a user's payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document. @required @param credit_payroll_income_get_request [Plaid::CreditPayrollIncomeGetRequest?] @return [CreditPayrollIncomeGetResponse]
Retrieve a user's payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document. @required @param credit_payroll_income_get_request [Plaid::CreditPayrollIncomeGetRequest?] @return nil
Retrieve a user's payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document. @required @param credit_payroll_income_get_request [Plaid::CreditPayrollIncomeGetRequest?] @return [Tuple(CreditPayrollIncomeGetResponse, Integer, Hash)] CreditPayrollIncomeGetResponse, response status code and response headers
Update the parsing configuration for a document income verification
/credit/payroll_income/parsing_config/update
updates the parsing configuration for a document income verification.
@required @param credit_payroll_income_parsing_config_update_request [Plaid::CreditPayrollIncomeParsingConfigUpdateRequest?]
@return [CreditPayrollIncomeParsingConfigUpdateResponse]
Update the parsing configuration for a document income verification `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification. @required @param credit_payroll_income_parsing_config_update_request [Plaid::CreditPayrollIncomeParsingConfigUpdateRequest?] @return nil
Update the parsing configuration for a document income verification `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification. @required @param credit_payroll_income_parsing_config_update_request [Plaid::CreditPayrollIncomeParsingConfigUpdateRequest?] @return [Tuple(CreditPayrollIncomeParsingConfigUpdateResponse, Integer, Hash)] CreditPayrollIncomeParsingConfigUpdateResponse, response status code and response headers
Check income verification eligibility and optimize conversion
/credit/payroll_income/precheck
is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing employer
data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the employer
and access_tokens
fields. employer_good
and employer_bad
will result in HIGH
and LOW
confidence values, respectively. employer_multi
will result in a HIGH
confidence with multiple payroll options. Likewise, access_good
and access_bad
will result in HIGH
and LOW
confidence values, respectively. Any other value for employer
and access_tokens
in Sandbox will result in UNKNOWN
confidence.
@required @param credit_payroll_income_precheck_request [Plaid::CreditPayrollIncomePrecheckRequest?]
@return [CreditPayrollIncomePrecheckResponse]
Check income verification eligibility and optimize conversion `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence. @required @param credit_payroll_income_precheck_request [Plaid::CreditPayrollIncomePrecheckRequest?] @return nil
Check income verification eligibility and optimize conversion `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence. @required @param credit_payroll_income_precheck_request [Plaid::CreditPayrollIncomePrecheckRequest?] @return [Tuple(CreditPayrollIncomePrecheckResponse, Integer, Hash)] CreditPayrollIncomePrecheckResponse, response status code and response headers
Refresh a digital payroll income verification
/credit/payroll_income/refresh
refreshes a given digital payroll income verification.
@required @param credit_payroll_income_refresh_request [Plaid::CreditPayrollIncomeRefreshRequest?]
@return [CreditPayrollIncomeRefreshResponse]
Refresh a digital payroll income verification `/credit/payroll_income/refresh` refreshes a given digital payroll income verification. @required @param credit_payroll_income_refresh_request [Plaid::CreditPayrollIncomeRefreshRequest?] @return nil
Refresh a digital payroll income verification `/credit/payroll_income/refresh` refreshes a given digital payroll income verification. @required @param credit_payroll_income_refresh_request [Plaid::CreditPayrollIncomeRefreshRequest?] @return [Tuple(CreditPayrollIncomeRefreshResponse, Integer, Hash)] CreditPayrollIncomeRefreshResponse, response status code and response headers
Retrieve fraud insights for a user's manually uploaded document(s).
/credit/payroll_income/risk_signals/get
can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call /link/token/create
with parsing_config
set to include fraud_risk
, or call /credit/payroll_income/parsing_config/update
. Once risk signal generation has been triggered, /credit/payroll_income/risk_signals/get
can be called at any time after the INCOME_VERIFICATION_RISK_SIGNALS
webhook has been fired. /credit/payroll_income/risk_signals/get
is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
@required @param credit_payroll_income_risk_signals_get_request [Plaid::CreditPayrollIncomeRiskSignalsGetRequest?]
@return [CreditPayrollIncomeRiskSignalsGetResponse]
Retrieve fraud insights for a user's manually uploaded document(s). `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `fraud_risk`, or call `/credit/payroll_income/parsing_config/update`. Once risk signal generation has been triggered, `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param credit_payroll_income_risk_signals_get_request [Plaid::CreditPayrollIncomeRiskSignalsGetRequest?] @return nil
Retrieve fraud insights for a user's manually uploaded document(s). `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `fraud_risk`, or call `/credit/payroll_income/parsing_config/update`. Once risk signal generation has been triggered, `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param credit_payroll_income_risk_signals_get_request [Plaid::CreditPayrollIncomeRiskSignalsGetRequest?] @return [Tuple(CreditPayrollIncomeRiskSignalsGetResponse, Integer, Hash)] CreditPayrollIncomeRiskSignalsGetResponse, response status code and response headers
Create a relay token to share an Asset Report with a partner client (beta)
Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in /asset_report/create
. To grant a third party access to an Asset Report, use the /credit/relay/create
endpoint to create a relay_token
and then pass that token to your third party. Each third party has its own secondary_client_id
; for example, ce5bd328dcd34123456
. You'll need to create a separate relay_token
for each third party that needs access to the report on your behalf.
@required @param credit_relay_create_request [Plaid::CreditRelayCreateRequest?]
@return [CreditRelayCreateResponse]
Create a relay token to share an Asset Report with a partner client (beta) Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf. @required @param credit_relay_create_request [Plaid::CreditRelayCreateRequest?] @return nil
Create a relay token to share an Asset Report with a partner client (beta) Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf. @required @param credit_relay_create_request [Plaid::CreditRelayCreateRequest?] @return [Tuple(CreditRelayCreateResponse, Integer, Hash)] CreditRelayCreateResponse, response status code and response headers
Retrieve the reports associated with a relay token that was shared with you (beta)
/credit/relay/get
allows third parties to receive a report that was shared with them, using a relay_token
that was created by the report owner.
@required @param credit_relay_get_request [Plaid::CreditRelayGetRequest?]
@return [AssetReportGetResponse]
Retrieve the reports associated with a relay token that was shared with you (beta) `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner. @required @param credit_relay_get_request [Plaid::CreditRelayGetRequest?] @return nil
Retrieve the reports associated with a relay token that was shared with you (beta) `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner. @required @param credit_relay_get_request [Plaid::CreditRelayGetRequest?] @return [Tuple(AssetReportGetResponse, Integer, Hash)] AssetReportGetResponse, response status code and response headers
Retrieve the pdf reports associated with a relay token that was shared with you (beta)
/credit/relay/pdf/get
allows third parties to receive a pdf report that was shared with them, using a relay_token
that was created by the report owner. The /credit/relay/pdf/get
endpoint retrieves the Asset Report in PDF format. Before calling /credit/relay/pdf/get
, you must first create the Asset Report using /credit/relay/create
and then wait for the PRODUCT_READY
webhook to fire, indicating that the Report is ready to be retrieved. The response to /credit/relay/pdf/get
is the PDF binary data. The request_id
is returned in the Plaid-Request-ID
header. View a sample PDF Asset Report.
@required @param credit_relay_pdf_get_request [Plaid::CreditRelayPDFGetRequest?]
@return [::File]
Retrieve the pdf reports associated with a relay token that was shared with you (beta) `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/credit/relay/pdf/get`, you must first create the Asset Report using `/credit/relay/create` and then wait for the `PRODUCT_READY` webhook to fire, indicating that the Report is ready to be retrieved. The response to `/credit/relay/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. View a sample PDF Asset Report. @required @param credit_relay_pdf_get_request [Plaid::CreditRelayPDFGetRequest?] @return nil
Retrieve the pdf reports associated with a relay token that was shared with you (beta) `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/credit/relay/pdf/get`, you must first create the Asset Report using `/credit/relay/create` and then wait for the `PRODUCT_READY` webhook to fire, indicating that the Report is ready to be retrieved. The response to `/credit/relay/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. View a sample PDF Asset Report. @required @param credit_relay_pdf_get_request [Plaid::CreditRelayPDFGetRequest?] @return [Tuple(::File, Integer, Hash)] ::File, response status code and response headers
Refresh a report of a relay token (beta)
The /credit/relay/refresh
endpoint allows third parties to refresh a report that was relayed to them, using a relay_token
that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the days_requested
value of the original report.
@required @param credit_relay_refresh_request [Plaid::CreditRelayRefreshRequest?]
@return [CreditRelayRefreshResponse]
Refresh a report of a relay token (beta) The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report. @required @param credit_relay_refresh_request [Plaid::CreditRelayRefreshRequest?] @return nil
Refresh a report of a relay token (beta) The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report. @required @param credit_relay_refresh_request [Plaid::CreditRelayRefreshRequest?] @return [Tuple(CreditRelayRefreshResponse, Integer, Hash)] CreditRelayRefreshResponse, response status code and response headers
Remove relay token (beta)
The /credit/relay/remove
endpoint allows you to invalidate a relay_token
. The third party holding the token will no longer be able to access or refresh the reports which the relay_token
gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given relay_token
.
@required @param credit_relay_remove_request [Plaid::CreditRelayRemoveRequest?]
@return [CreditRelayRemoveResponse]
Remove relay token (beta) The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the `relay_token` gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token`. @required @param credit_relay_remove_request [Plaid::CreditRelayRemoveRequest?] @return nil
Remove relay token (beta) The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the `relay_token` gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token`. @required @param credit_relay_remove_request [Plaid::CreditRelayRemoveRequest?] @return [Tuple(CreditRelayRemoveResponse, Integer, Hash)] CreditRelayRemoveResponse, response status code and response headers
Remove an Audit Copy token
The /credit/audit_copy_token/remove
endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the audit_copy_token
associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
@required @param credit_audit_copy_token_remove_request [Plaid::CreditAuditCopyTokenRemoveRequest?]
@return [CreditAuditCopyTokenRemoveResponse]
Remove an Audit Copy token The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy. @required @param credit_audit_copy_token_remove_request [Plaid::CreditAuditCopyTokenRemoveRequest?] @return nil
Remove an Audit Copy token The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy. @required @param credit_audit_copy_token_remove_request [Plaid::CreditAuditCopyTokenRemoveRequest?] @return [Tuple(CreditAuditCopyTokenRemoveResponse, Integer, Hash)] CreditAuditCopyTokenRemoveResponse, response status code and response headers
Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step). @required @param credit_sessions_get_request [Plaid::CreditSessionsGetRequest?] @return [CreditSessionsGetResponse]
Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step). @required @param credit_sessions_get_request [Plaid::CreditSessionsGetRequest?] @return nil
Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step). @required @param credit_sessions_get_request [Plaid::CreditSessionsGetRequest?] @return [Tuple(CreditSessionsGetResponse, Integer, Hash)] CreditSessionsGetResponse, response status code and response headers
Retrieve a dashboard user Retrieve information about a dashboard user. @required @param dashboard_user_get_request [Plaid::DashboardUserGetRequest?] @return [DashboardUserGetResponse]
Retrieve a dashboard user Retrieve information about a dashboard user. @required @param dashboard_user_get_request [Plaid::DashboardUserGetRequest?] @return nil
Retrieve a dashboard user Retrieve information about a dashboard user. @required @param dashboard_user_get_request [Plaid::DashboardUserGetRequest?] @return [Tuple(DashboardUserGetResponse, Integer, Hash)] DashboardUserGetResponse, response status code and response headers
List dashboard users List all dashboard users associated with your account. @required @param dashboard_user_list_request [Plaid::DashboardUserListRequest?] @return [DashboardUserListResponse]
List dashboard users List all dashboard users associated with your account. @required @param dashboard_user_list_request [Plaid::DashboardUserListRequest?] @return nil
List dashboard users List all dashboard users associated with your account. @required @param dashboard_user_list_request [Plaid::DashboardUserListRequest?] @return [Tuple(DashboardUserListResponse, Integer, Hash)] DashboardUserListResponse, response status code and response headers
Create a deposit switch without using Plaid Exchange
This endpoint provides an alternative to /deposit_switch/create
for customers who have not yet fully integrated with Plaid Exchange. Like /deposit_switch/create
, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
@required @param deposit_switch_alt_create_request [Plaid::DepositSwitchAltCreateRequest?]
@return [DepositSwitchAltCreateResponse]
Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch. @required @param deposit_switch_alt_create_request [Plaid::DepositSwitchAltCreateRequest?] @return nil
Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch. @required @param deposit_switch_alt_create_request [Plaid::DepositSwitchAltCreateRequest?] @return [Tuple(DepositSwitchAltCreateResponse, Integer, Hash)] DepositSwitchAltCreateResponse, response status code and response headers
Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch. @required @param deposit_switch_create_request [Plaid::DepositSwitchCreateRequest?] @return [DepositSwitchCreateResponse]
Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch. @required @param deposit_switch_create_request [Plaid::DepositSwitchCreateRequest?] @return nil
Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch. @required @param deposit_switch_create_request [Plaid::DepositSwitchCreateRequest?] @return [Tuple(DepositSwitchCreateResponse, Integer, Hash)] DepositSwitchCreateResponse, response status code and response headers
Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences. @required @param deposit_switch_get_request [Plaid::DepositSwitchGetRequest?] @return [DepositSwitchGetResponse]
Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences. @required @param deposit_switch_get_request [Plaid::DepositSwitchGetRequest?] @return nil
Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences. @required @param deposit_switch_get_request [Plaid::DepositSwitchGetRequest?] @return [Tuple(DepositSwitchGetResponse, Integer, Hash)] DepositSwitchGetResponse, response status code and response headers
Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes. @required @param deposit_switch_token_create_request [Plaid::DepositSwitchTokenCreateRequest?] @return [DepositSwitchTokenCreateResponse]
Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes. @required @param deposit_switch_token_create_request [Plaid::DepositSwitchTokenCreateRequest?] @return nil
Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes. @required @param deposit_switch_token_create_request [Plaid::DepositSwitchTokenCreateRequest?] @return [Tuple(DepositSwitchTokenCreateResponse, Integer, Hash)] DepositSwitchTokenCreateResponse, response status code and response headers
Search employer database
/employers/search
allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
@required @param employers_search_request [Plaid::EmployersSearchRequest?]
@return [EmployersSearchResponse]
Search employer database `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day. @required @param employers_search_request [Plaid::EmployersSearchRequest?] @return nil
Search employer database `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day. @required @param employers_search_request [Plaid::EmployersSearchRequest?] @return [Tuple(EmployersSearchResponse, Integer, Hash)] EmployersSearchResponse, response status code and response headers
(Deprecated) Retrieve a summary of an individual's employment information
/employment/verification/get
returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use /credit/employment/get
instead.
@required @param employment_verification_get_request [Plaid::EmploymentVerificationGetRequest?]
@return [EmploymentVerificationGetResponse]
(Deprecated) Retrieve a summary of an individual's employment information `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead. @required @param employment_verification_get_request [Plaid::EmploymentVerificationGetRequest?] @return nil
(Deprecated) Retrieve a summary of an individual's employment information `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead. @required @param employment_verification_get_request [Plaid::EmploymentVerificationGetRequest?] @return [Tuple(EmploymentVerificationGetResponse, Integer, Hash)] EmploymentVerificationGetResponse, response status code and response headers
Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications @required @param fdx_notification [Plaid::FDXNotification?] @return [Nil]
Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications @required @param fdx_notification [Plaid::FDXNotification?] @return nil
Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications @required @param fdx_notification [Plaid::FDXNotification?] @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
Retrieve identity data
The /identity/get
endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the owners
object is not returned, and instead identity information is returned in the top level identity
object. For more details, see Plaid API versioning.
@required @param identity_get_request [Plaid::IdentityGetRequest?]
@return [IdentityGetResponse]
Retrieve identity data The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see Plaid API versioning. @required @param identity_get_request [Plaid::IdentityGetRequest?] @return nil
Retrieve identity data The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see Plaid API versioning. @required @param identity_get_request [Plaid::IdentityGetRequest?] @return [Tuple(IdentityGetResponse, Integer, Hash)] IdentityGetResponse, response status code and response headers
Retrieve identity match score
The /identity/match
endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the balances
object will always be null when retrieved by /identity/match
. Instead, use the free /accounts/get
endpoint to request balance cached data, or /accounts/balance/get
for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
@required @param identity_match_request [Plaid::IdentityMatchRequest?]
@return [IdentityMatchResponse]
Retrieve identity match score The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. @required @param identity_match_request [Plaid::IdentityMatchRequest?] @return nil
Retrieve identity match score The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. @required @param identity_match_request [Plaid::IdentityMatchRequest?] @return [Tuple(IdentityMatchResponse, Integer, Hash)] IdentityMatchResponse, response status code and response headers
Refresh identity data
/identity/refresh
is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur any Identity-enabled Item. If changes to Identity are discovered after calling /identity/refresh
, Plaid will fire a webhook DEFAULT_UPDATE
. /identity/refresh
is offered as an add-on to Identity and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
@required @param identity_refresh_request [Plaid::IdentityRefreshRequest?]
@return [IdentityRefreshResponse]
Refresh identity data `/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook `DEFAULT_UPDATE`. `/identity/refresh` is offered as an add-on to Identity and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param identity_refresh_request [Plaid::IdentityRefreshRequest?] @return nil
Refresh identity data `/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook `DEFAULT_UPDATE`. `/identity/refresh` is offered as an add-on to Identity and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param identity_refresh_request [Plaid::IdentityRefreshRequest?] @return [Tuple(IdentityRefreshResponse, Integer, Hash)] IdentityRefreshResponse, response status code and response headers
Create a new identity verification
Create a new Identity Verification for the user specified by the client_user_id
field. The requirements and behavior of the verification are determined by the template_id
provided. If you don't know whether the associated user already has an active Identity Verification, you can specify \"is_idempotent\": true
in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated client_user_id
and template_id
. If an Identity Verification is found, it will be returned unmodified with an 200 OK
HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
@required @param identity_verification_create_request [Plaid::IdentityVerificationCreateRequest?]
@return [IdentityVerificationCreateResponse]
Create a new identity verification Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `"is_idempotent": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. @required @param identity_verification_create_request [Plaid::IdentityVerificationCreateRequest?] @return nil
Create a new identity verification Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `"is_idempotent": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. @required @param identity_verification_create_request [Plaid::IdentityVerificationCreateRequest?] @return [Tuple(IdentityVerificationCreateResponse, Integer, Hash)] IdentityVerificationCreateResponse, response status code and response headers
Retrieve Identity Verification Retrieve a previously created identity verification. @required @param identity_verification_get_request [Plaid::IdentityVerificationGetRequest?] @return [IdentityVerificationGetResponse]
Retrieve Identity Verification Retrieve a previously created identity verification. @required @param identity_verification_get_request [Plaid::IdentityVerificationGetRequest?] @return nil
Retrieve Identity Verification Retrieve a previously created identity verification. @required @param identity_verification_get_request [Plaid::IdentityVerificationGetRequest?] @return [Tuple(IdentityVerificationGetResponse, Integer, Hash)] IdentityVerificationGetResponse, response status code and response headers
List Identity Verifications Filter and list Identity Verifications created by your account @required @param identity_verification_list_request [Plaid::IdentityVerificationListRequest?] @return [IdentityVerificationListResponse]
List Identity Verifications Filter and list Identity Verifications created by your account @required @param identity_verification_list_request [Plaid::IdentityVerificationListRequest?] @return nil
List Identity Verifications Filter and list Identity Verifications created by your account @required @param identity_verification_list_request [Plaid::IdentityVerificationListRequest?] @return [Tuple(IdentityVerificationListResponse, Integer, Hash)] IdentityVerificationListResponse, response status code and response headers
Retry an Identity Verification Allow a customer to retry their identity verification @required @param identity_verification_retry_request [Plaid::IdentityVerificationRetryRequest?] @return [IdentityVerificationRetryResponse]
Retry an Identity Verification Allow a customer to retry their identity verification @required @param identity_verification_retry_request [Plaid::IdentityVerificationRetryRequest?] @return nil
Retry an Identity Verification Allow a customer to retry their identity verification @required @param identity_verification_retry_request [Plaid::IdentityVerificationRetryRequest?] @return [Tuple(IdentityVerificationRetryResponse, Integer, Hash)] IdentityVerificationRetryResponse, response status code and response headers
(Deprecated) Create an income verification instance
/income/verification/create
begins the income verification process by returning an income_verification_id
. You can then provide the income_verification_id
to /link/token/create
under the income_verification
parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an INCOME
webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
@required @param income_verification_create_request [Plaid::IncomeVerificationCreateRequest?]
@return [IncomeVerificationCreateResponse]
(Deprecated) Create an income verification instance `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing. @required @param income_verification_create_request [Plaid::IncomeVerificationCreateRequest?] @return nil
(Deprecated) Create an income verification instance `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing. @required @param income_verification_create_request [Plaid::IncomeVerificationCreateRequest?] @return [Tuple(IncomeVerificationCreateResponse, Integer, Hash)] IncomeVerificationCreateResponse, response status code and response headers
(Deprecated) Download the original documents used for income verification
/income/verification/documents/download
provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to /income/verification/documents/download
is a ZIP file in binary data. If a document_id
is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The request_id
is returned in the Plaid-Request-ID
header.
@required @param income_verification_documents_download_request [Plaid::IncomeVerificationDocumentsDownloadRequest?]
@return [::File]
(Deprecated) Download the original documents used for income verification `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header. @required @param income_verification_documents_download_request [Plaid::IncomeVerificationDocumentsDownloadRequest?] @return nil
(Deprecated) Download the original documents used for income verification `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header. @required @param income_verification_documents_download_request [Plaid::IncomeVerificationDocumentsDownloadRequest?] @return [Tuple(::File, Integer, Hash)] ::File, response status code and response headers
(Deprecated) Retrieve information from the paystubs used for income verification
/income/verification/paystubs/get
returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to VERIFICATION_STATUS_PROCESSING_COMPLETE
, as reported by the INCOME: verification_status
webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use /credit/payroll_income/get
instead.
@required @param income_verification_paystubs_get_request [Plaid::IncomeVerificationPaystubsGetRequest?]
@return [IncomeVerificationPaystubsGetResponse]
(Deprecated) Retrieve information from the paystubs used for income verification `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead. @required @param income_verification_paystubs_get_request [Plaid::IncomeVerificationPaystubsGetRequest?] @return nil
(Deprecated) Retrieve information from the paystubs used for income verification `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead. @required @param income_verification_paystubs_get_request [Plaid::IncomeVerificationPaystubsGetRequest?] @return [Tuple(IncomeVerificationPaystubsGetResponse, Integer, Hash)] IncomeVerificationPaystubsGetResponse, response status code and response headers
(Deprecated) Check digital income verification eligibility and optimize conversion
/income/verification/precheck
is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a precheck_id
that can be provided to /link/token/create
. If the user is eligible for digital verification, providing the precheck_id
in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the precheck_id
can still be provided to /link/token/create
and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either employer
or transactions_access_tokens
data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use /credit/payroll_income/precheck
instead.
@required @param income_verification_precheck_request [Plaid::IncomeVerificationPrecheckRequest?]
@return [IncomeVerificationPrecheckResponse]
(Deprecated) Check digital income verification eligibility and optimize conversion `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead. @required @param income_verification_precheck_request [Plaid::IncomeVerificationPrecheckRequest?] @return nil
(Deprecated) Check digital income verification eligibility and optimize conversion `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead. @required @param income_verification_precheck_request [Plaid::IncomeVerificationPrecheckRequest?] @return [Tuple(IncomeVerificationPrecheckResponse, Integer, Hash)] IncomeVerificationPrecheckResponse, response status code and response headers
(Deprecated) Retrieve information from the tax documents used for income verification
/income/verification/taxforms/get
returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to VERIFICATION_STATUS_PROCESSING_COMPLETE
, as reported by the INCOME: verification_status
webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use /credit/payroll_income/get
instead.
@required @param income_verification_taxforms_get_request [Plaid::IncomeVerificationTaxformsGetRequest?]
@return [IncomeVerificationTaxformsGetResponse]
(Deprecated) Retrieve information from the tax documents used for income verification `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead. @required @param income_verification_taxforms_get_request [Plaid::IncomeVerificationTaxformsGetRequest?] @return nil
(Deprecated) Retrieve information from the tax documents used for income verification `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead. @required @param income_verification_taxforms_get_request [Plaid::IncomeVerificationTaxformsGetRequest?] @return [Tuple(IncomeVerificationTaxformsGetResponse, Integer, Hash)] IncomeVerificationTaxformsGetResponse, response status code and response headers
Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call. @required @param institutions_get_request [Plaid::InstitutionsGetRequest?] @return [InstitutionsGetResponse]
Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call. @required @param institutions_get_request [Plaid::InstitutionsGetRequest?] @return nil
Get details of an institution
Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the public_key
parameter instead of the client_id
and secret
to authenticate to this endpoint. The public_key
has been deprecated; all customers are encouraged to use client_id
and secret
instead.
@required @param institutions_get_by_id_request [Plaid::InstitutionsGetByIdRequest?]
@return [InstitutionsGetByIdResponse]
Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead. @required @param institutions_get_by_id_request [Plaid::InstitutionsGetByIdRequest?] @return nil
Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead. @required @param institutions_get_by_id_request [Plaid::InstitutionsGetByIdRequest?] @return [Tuple(InstitutionsGetByIdResponse, Integer, Hash)] InstitutionsGetByIdResponse, response status code and response headers
Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call. @required @param institutions_get_request [Plaid::InstitutionsGetRequest?] @return [Tuple(InstitutionsGetResponse, Integer, Hash)] InstitutionsGetResponse, response status code and response headers
Search institutions
Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the public_key
parameter instead of the client_id
and secret
parameters to authenticate to this endpoint. The public_key
parameter has since been deprecated; all customers are encouraged to use client_id
and secret
instead.
@required @param institutions_search_request [Plaid::InstitutionsSearchRequest?]
@return [InstitutionsSearchResponse]
Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead. @required @param institutions_search_request [Plaid::InstitutionsSearchRequest?] @return nil
Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead. @required @param institutions_search_request [Plaid::InstitutionsSearchRequest?] @return [Tuple(InstitutionsSearchResponse, Integer, Hash)] InstitutionsSearchResponse, response status code and response headers
Get data needed to authorize an investments transfer
The /investments/auth/get
endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings
@required @param investments_auth_get_request [Plaid::InvestmentsAuthGetRequest?]
@return [InvestmentsAuthGetResponse]
Get data needed to authorize an investments transfer The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings @required @param investments_auth_get_request [Plaid::InvestmentsAuthGetRequest?] @return nil
Get data needed to authorize an investments transfer The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings @required @param investments_auth_get_request [Plaid::InvestmentsAuthGetRequest?] @return [Tuple(InvestmentsAuthGetResponse, Integer, Hash)] InvestmentsAuthGetResponse, response status code and response headers
Get Investment holdings
The /investments/holdings/get
endpoint allows developers to receive user-authorized stock position data for investment
-type accounts.
@required @param investments_holdings_get_request [Plaid::InvestmentsHoldingsGetRequest?]
@return [InvestmentsHoldingsGetResponse]
Get Investment holdings The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts. @required @param investments_holdings_get_request [Plaid::InvestmentsHoldingsGetRequest?] @return nil
Get Investment holdings The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts. @required @param investments_holdings_get_request [Plaid::InvestmentsHoldingsGetRequest?] @return [Tuple(InvestmentsHoldingsGetResponse, Integer, Hash)] InvestmentsHoldingsGetResponse, response status code and response headers
Refresh investment data
/investments/refresh
is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Investments-enabled Item. If changes to investments are discovered after calling /investments/refresh
, Plaid will fire webhooks: HOLDINGS: DEFAULT_UPDATE
if any new holdings are detected, and INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling /investments/holdings/get
and /investments/transactions/get
. "Note that the /investments/refresh
endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a PRODUCT_NOT_SUPPORTED
error. /investments/refresh
is offered as an add-on to Investments and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
@required @param investments_refresh_request [Plaid::InvestmentsRefreshRequest?]
@return [InvestmentsRefreshResponse]
Refresh investment data `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: `HOLDINGS: DEFAULT_UPDATE` if any new holdings are detected, and INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. "Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. `/investments/refresh` is offered as an add-on to Investments and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param investments_refresh_request [Plaid::InvestmentsRefreshRequest?] @return nil
Refresh investment data `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: `HOLDINGS: DEFAULT_UPDATE` if any new holdings are detected, and INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. "Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. `/investments/refresh` is offered as an add-on to Investments and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param investments_refresh_request [Plaid::InvestmentsRefreshRequest?] @return [Tuple(InvestmentsRefreshResponse, Integer, Hash)] InvestmentsRefreshResponse, response status code and response headers
Get investment transactions
The /investments/transactions/get
endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_investment_transactions
response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the async_update
option). Instead, if transactions data is not ready when /investments/transactions/get
is first called, Plaid will wait for the data. For this reason, calling /investments/transactions/get
immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when async_update
is set to true) may not be immediately available to /investments/transactions/get
. To be alerted when the data is ready to be fetched, listen for the HISTORICAL_UPDATE
webhook. If no investments history is ready when /investments/transactions/get
is called, it will return a PRODUCT_NOT_READY
error.
@required @param investments_transactions_get_request [Plaid::InvestmentsTransactionsGetRequest?]
@return [InvestmentsTransactionsGetResponse]
Get investment transactions The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the `async_update` option). Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when `async_update` is set to true) may not be immediately available to `/investments/transactions/get`. To be alerted when the data is ready to be fetched, listen for the `HISTORICAL_UPDATE` webhook. If no investments history is ready when `/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. @required @param investments_transactions_get_request [Plaid::InvestmentsTransactionsGetRequest?] @return nil
Get investment transactions The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the `async_update` option). Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when `async_update` is set to true) may not be immediately available to `/investments/transactions/get`. To be alerted when the data is ready to be fetched, listen for the `HISTORICAL_UPDATE` webhook. If no investments history is ready when `/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. @required @param investments_transactions_get_request [Plaid::InvestmentsTransactionsGetRequest?] @return [Tuple(InvestmentsTransactionsGetResponse, Integer, Hash)] InvestmentsTransactionsGetResponse, response status code and response headers
Invalidate access_token
By default, the access_token
associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the /item/access_token/invalidate
endpoint to rotate the access_token
associated with an Item. The endpoint returns a new access_token
and immediately invalidates the previous access_token
.
@required @param item_access_token_invalidate_request [Plaid::ItemAccessTokenInvalidateRequest?]
@return [ItemAccessTokenInvalidateResponse]
Invalidate access_token By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`. @required @param item_access_token_invalidate_request [Plaid::ItemAccessTokenInvalidateRequest?] @return nil
Invalidate access_token By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`. @required @param item_access_token_invalidate_request [Plaid::ItemAccessTokenInvalidateRequest?] @return [Tuple(ItemAccessTokenInvalidateResponse, Integer, Hash)] ItemAccessTokenInvalidateResponse, response status code and response headers
List a historical log of user consent events List a historical log of user consent events @required @param item_activity_list_request [Plaid::ItemActivityListRequest?] @return [ItemActivityListResponse]
List a historical log of user consent events List a historical log of user consent events @required @param item_activity_list_request [Plaid::ItemActivityListRequest?] @return nil
List a historical log of user consent events List a historical log of user consent events @required @param item_activity_list_request [Plaid::ItemActivityListRequest?] @return [Tuple(ItemActivityListResponse, Integer, Hash)] ItemActivityListResponse, response status code and response headers
List a user’s connected applications List a user’s connected applications @required @param item_application_list_request [Plaid::ItemApplicationListRequest?] @return [ItemApplicationListResponse]
List a user’s connected applications List a user’s connected applications @required @param item_application_list_request [Plaid::ItemApplicationListRequest?] @return nil
List a user’s connected applications List a user’s connected applications @required @param item_application_list_request [Plaid::ItemApplicationListRequest?] @return [Tuple(ItemApplicationListResponse, Integer, Hash)] ItemApplicationListResponse, response status code and response headers
Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application. @required @param item_application_scopes_update_request [Plaid::ItemApplicationScopesUpdateRequest?] @return [ItemApplicationScopesUpdateResponse]
Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application. @required @param item_application_scopes_update_request [Plaid::ItemApplicationScopesUpdateRequest?] @return nil
Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application. @required @param item_application_scopes_update_request [Plaid::ItemApplicationScopesUpdateRequest?] @return [Tuple(ItemApplicationScopesUpdateResponse, Integer, Hash)] ItemApplicationScopesUpdateResponse, response status code and response headers
Unlink a user’s connected application Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible. @required @param item_application_unlink_request [Plaid::ItemApplicationUnlinkRequest?] @return [ItemApplicationUnlinkResponse]
Unlink a user’s connected application Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible. @required @param item_application_unlink_request [Plaid::ItemApplicationUnlinkRequest?] @return nil
Unlink a user’s connected application Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible. @required @param item_application_unlink_request [Plaid::ItemApplicationUnlinkRequest?] @return [Tuple(ItemApplicationUnlinkResponse, Integer, Hash)] ItemApplicationUnlinkResponse, response status code and response headers
Create public token
Note: As of July 2020, the /item/public_token/create
endpoint is deprecated. Instead, use /link/token/create
with an access_token
to create a Link token for use with update mode. If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the /item/public_token/create
endpoint and then initialize Link with that public_token
. A public_token
is one-time use and expires after 30 minutes. You use a public_token
to initialize Link in update mode for a particular Item. You can generate a public_token
for an Item even if you did not use Link to create the Item originally. The /item/public_token/create
endpoint is not used to create your initial public_token
. If you have not already received an access_token
for a specific Item, use Link to obtain your public_token
instead. See the Quickstart for more information.
@required @param item_public_token_create_request [Plaid::ItemPublicTokenCreateRequest?]
@return [ItemPublicTokenCreateResponse]
Create public token Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with update mode. If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in update mode for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is not used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the Quickstart for more information. @required @param item_public_token_create_request [Plaid::ItemPublicTokenCreateRequest?] @return nil
Create public token Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with update mode. If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in update mode for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is not used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the Quickstart for more information. @required @param item_public_token_create_request [Plaid::ItemPublicTokenCreateRequest?] @return [Tuple(ItemPublicTokenCreateResponse, Integer, Hash)] ItemPublicTokenCreateResponse, response status code and response headers
Retrieve an Item Returns information about the status of an Item. @required @param item_get_request [Plaid::ItemGetRequest?] @return [ItemGetResponse]
Retrieve an Item Returns information about the status of an Item. @required @param item_get_request [Plaid::ItemGetRequest?] @return nil
Retrieve an Item Returns information about the status of an Item. @required @param item_get_request [Plaid::ItemGetRequest?] @return [Tuple(ItemGetResponse, Integer, Hash)] ItemGetResponse, response status code and response headers
Import Item
/item/import
creates an Item via your Plaid Exchange Integration and returns an access_token
. As part of an /item/import
request, you will include a User ID (user_auth.user_id
) and Authentication Token (user_auth.auth_token
) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via /item/import
, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated.
@required @param item_import_request [Plaid::ItemImportRequest?]
@return [ItemImportResponse]
Import Item `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. @required @param item_import_request [Plaid::ItemImportRequest?] @return nil
Import Item `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. @required @param item_import_request [Plaid::ItemImportRequest?] @return [Tuple(ItemImportResponse, Integer, Hash)] ItemImportResponse, response status code and response headers
Exchange public token for an access token
Exchange a Link public_token
for an API access_token
. Link hands off the public_token
client-side via the onSuccess
callback once a user has successfully created an Item. The public_token
is ephemeral and expires after 30 minutes. An access_token
does not expire, but can be revoked by calling /item/remove
. The response also includes an item_id
that should be stored with the access_token
. The item_id
is used to identify an Item in a webhook. The item_id
can also be retrieved by making an /item/get
request.
@required @param item_public_token_exchange_request [Plaid::ItemPublicTokenExchangeRequest?]
@return [ItemPublicTokenExchangeResponse]
Exchange public token for an access token Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request. @required @param item_public_token_exchange_request [Plaid::ItemPublicTokenExchangeRequest?] @return nil
Exchange public token for an access token Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request. @required @param item_public_token_exchange_request [Plaid::ItemPublicTokenExchangeRequest?] @return [Tuple(ItemPublicTokenExchangeResponse, Integer, Hash)] ItemPublicTokenExchangeResponse, response status code and response headers
Remove an Item
The /item/remove
endpoint allows you to remove an Item. Once removed, the access_token
, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an /item/remove
request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via /item/remove
may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a removed
boolean as part of the response.
@required @param item_remove_request [Plaid::ItemRemoveRequest?]
@return [ItemRemoveResponse]
Remove an Item The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response. @required @param item_remove_request [Plaid::ItemRemoveRequest?] @return nil
Remove an Item The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response. @required @param item_remove_request [Plaid::ItemRemoveRequest?] @return [Tuple(ItemRemoveResponse, Integer, Hash)] ItemRemoveResponse, response status code and response headers
Update Webhook URL
The POST /item/webhook/update
allows you to update the webhook URL associated with an Item. This request triggers a WEBHOOK_UPDATE_ACKNOWLEDGED
webhook to the newly specified webhook URL.
@required @param item_webhook_update_request [Plaid::ItemWebhookUpdateRequest?]
@return [ItemWebhookUpdateResponse]
Update Webhook URL The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL. @required @param item_webhook_update_request [Plaid::ItemWebhookUpdateRequest?] @return nil
Update Webhook URL The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL. @required @param item_webhook_update_request [Plaid::ItemWebhookUpdateRequest?] @return [Tuple(ItemWebhookUpdateResponse, Integer, Hash)] ItemWebhookUpdateResponse, response status code and response headers
Retrieve Liabilities data
The /liabilities/get
endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type credit
with account subtype credit card
or paypal
, and account type loan
with account subtype student
or mortgage
. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the account_filters
parameter when creating a Link token. The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling /liabilities/get
. Note: This request may take some time to complete if liabilities
was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
@required @param liabilities_get_request [Plaid::LiabilitiesGetRequest?]
@return [LiabilitiesGetResponse]
Retrieve Liabilities data The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when creating a Link token. The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data. @required @param liabilities_get_request [Plaid::LiabilitiesGetRequest?] @return nil
Retrieve Liabilities data The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when creating a Link token. The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data. @required @param liabilities_get_request [Plaid::LiabilitiesGetRequest?] @return [Tuple(LiabilitiesGetResponse, Integer, Hash)] LiabilitiesGetResponse, response status code and response headers
Create Hosted Link session
Use the /link_delivery/create
endpoint to create a Hosted Link session.
@required @param link_delivery_create_request [Plaid::LinkDeliveryCreateRequest?]
@return [LinkDeliveryCreateResponse]
Create Hosted Link session Use the `/link_delivery/create` endpoint to create a Hosted Link session. @required @param link_delivery_create_request [Plaid::LinkDeliveryCreateRequest?] @return nil
Create Hosted Link session Use the `/link_delivery/create` endpoint to create a Hosted Link session. @required @param link_delivery_create_request [Plaid::LinkDeliveryCreateRequest?] @return [Tuple(LinkDeliveryCreateResponse, Integer, Hash)] LinkDeliveryCreateResponse, response status code and response headers
Get Hosted Link session
Use the /link_delivery/get
endpoint to get the status of a Hosted Link session.
@required @param link_delivery_get_request [Plaid::LinkDeliveryGetRequest?]
@return [LinkDeliveryGetResponse]
Get Hosted Link session Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session. @required @param link_delivery_get_request [Plaid::LinkDeliveryGetRequest?] @return nil
Get Hosted Link session Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session. @required @param link_delivery_get_request [Plaid::LinkDeliveryGetRequest?] @return [Tuple(LinkDeliveryGetResponse, Integer, Hash)] LinkDeliveryGetResponse, response status code and response headers
Exchange the Link Correlation Id for a Link Token
Exchange an OAuth link_correlation_id
for the corresponding link_token
. The link_correlation_id
is only available for 'payment_initiation' products and is provided to the client via the OAuth redirect_uri
as a query parameter. The link_correlation_id
is ephemeral and expires in a brief period, after which it can no longer be exchanged for the 'link_token'.
@required @param link_o_auth_correlation_id_exchange_request [Plaid::LinkOAuthCorrelationIdExchangeRequest?]
@return [LinkOAuthCorrelationIdExchangeResponse]
Exchange the Link Correlation Id for a Link Token Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for 'payment_initiation' products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the 'link_token'. @required @param link_o_auth_correlation_id_exchange_request [Plaid::LinkOAuthCorrelationIdExchangeRequest?] @return nil
Exchange the Link Correlation Id for a Link Token Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for 'payment_initiation' products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the 'link_token'. @required @param link_o_auth_correlation_id_exchange_request [Plaid::LinkOAuthCorrelationIdExchangeRequest?] @return [Tuple(LinkOAuthCorrelationIdExchangeResponse, Integer, Hash)] LinkOAuthCorrelationIdExchangeResponse, response status code and response headers
Create Link Token
The /link/token/create
endpoint creates a link_token
, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a public_token
, which can then be exchanged for an access_token
via /item/public_token/exchange
as part of the main Link flow. A link_token
generated by /link/token/create
is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
@required @param link_token_create_request [Plaid::LinkTokenCreateRequest?]
@return [LinkTokenCreateResponse]
Create Link Token The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow. @required @param link_token_create_request [Plaid::LinkTokenCreateRequest?] @return nil
Create Link Token The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow. @required @param link_token_create_request [Plaid::LinkTokenCreateRequest?] @return [Tuple(LinkTokenCreateResponse, Integer, Hash)] LinkTokenCreateResponse, response status code and response headers
Get Link Token
The /link/token/get
endpoint gets information about a previously-created link_token
using the /link/token/create
endpoint. It can be useful for debugging purposes.
@required @param link_token_get_request [Plaid::LinkTokenGetRequest?]
@return [LinkTokenGetResponse]
Get Link Token The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes. @required @param link_token_get_request [Plaid::LinkTokenGetRequest?] @return nil
Get Link Token The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes. @required @param link_token_get_request [Plaid::LinkTokenGetRequest?] @return [Tuple(LinkTokenGetResponse, Integer, Hash)] LinkTokenGetResponse, response status code and response headers
Creates a new end customer for a Plaid reseller.
The /partner/customer/create
endpoint is used by reseller partners to create end customers.
@required @param partner_customer_create_request [Plaid::PartnerCustomerCreateRequest?]
@return [PartnerCustomerCreateResponse]
Creates a new end customer for a Plaid reseller. The `/partner/customer/create` endpoint is used by reseller partners to create end customers. @required @param partner_customer_create_request [Plaid::PartnerCustomerCreateRequest?] @return nil
Creates a new end customer for a Plaid reseller. The `/partner/customer/create` endpoint is used by reseller partners to create end customers. @required @param partner_customer_create_request [Plaid::PartnerCustomerCreateRequest?] @return [Tuple(PartnerCustomerCreateResponse, Integer, Hash)] PartnerCustomerCreateResponse, response status code and response headers
Enables a Plaid reseller's end customer in the Production environment.
The /partner/customer/enable
endpoint is used by reseller partners to enable an end customer in the Production environment.
@required @param partner_customer_enable_request [Plaid::PartnerCustomerEnableRequest?]
@return [PartnerCustomerEnableResponse]
Enables a Plaid reseller's end customer in the Production environment. The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment. @required @param partner_customer_enable_request [Plaid::PartnerCustomerEnableRequest?] @return nil
Enables a Plaid reseller's end customer in the Production environment. The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment. @required @param partner_customer_enable_request [Plaid::PartnerCustomerEnableRequest?] @return [Tuple(PartnerCustomerEnableResponse, Integer, Hash)] PartnerCustomerEnableResponse, response status code and response headers
Returns a Plaid reseller's end customer.
The /partner/customer/get
endpoint is used by reseller partners to retrieve data about a single end customer.
@required @param partner_customer_get_request [Plaid::PartnerCustomerGetRequest?]
@return [PartnerCustomerGetResponse]
Returns a Plaid reseller's end customer. The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer. @required @param partner_customer_get_request [Plaid::PartnerCustomerGetRequest?] @return nil
Returns a Plaid reseller's end customer. The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer. @required @param partner_customer_get_request [Plaid::PartnerCustomerGetRequest?] @return [Tuple(PartnerCustomerGetResponse, Integer, Hash)] PartnerCustomerGetResponse, response status code and response headers
Returns OAuth-institution registration information for a given end customer.
The /partner/customer/oauth_institutions/get
endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the reseller documentation.
@required @param partner_customer_o_auth_institutions_get_request [Plaid::PartnerCustomerOAuthInstitutionsGetRequest?]
@return [PartnerCustomerOAuthInstitutionsGetResponse]
Returns OAuth-institution registration information for a given end customer. The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the reseller documentation. @required @param partner_customer_o_auth_institutions_get_request [Plaid::PartnerCustomerOAuthInstitutionsGetRequest?] @return nil
Returns OAuth-institution registration information for a given end customer. The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the reseller documentation. @required @param partner_customer_o_auth_institutions_get_request [Plaid::PartnerCustomerOAuthInstitutionsGetRequest?] @return [Tuple(PartnerCustomerOAuthInstitutionsGetResponse, Integer, Hash)] PartnerCustomerOAuthInstitutionsGetResponse, response status code and response headers
Removes a Plaid reseller's end customer.
The /partner/customer/remove
endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
@required @param partner_customer_remove_request [Plaid::PartnerCustomerRemoveRequest?]
@return [PartnerCustomerRemoveResponse]
Removes a Plaid reseller's end customer. The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production. @required @param partner_customer_remove_request [Plaid::PartnerCustomerRemoveRequest?] @return nil
Removes a Plaid reseller's end customer. The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production. @required @param partner_customer_remove_request [Plaid::PartnerCustomerRemoveRequest?] @return [Tuple(PartnerCustomerRemoveResponse, Integer, Hash)] PartnerCustomerRemoveResponse, response status code and response headers
Create payment consent
The /payment_initiation/consent/create
endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with UNAUTHORISED
status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments.
@required @param payment_initiation_consent_create_request [Plaid::PaymentInitiationConsentCreateRequest?]
@return [PaymentInitiationConsentCreateResponse]
Create payment consent The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with `UNAUTHORISED` status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments. @required @param payment_initiation_consent_create_request [Plaid::PaymentInitiationConsentCreateRequest?] @return nil
Create payment consent The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with `UNAUTHORISED` status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments. @required @param payment_initiation_consent_create_request [Plaid::PaymentInitiationConsentCreateRequest?] @return [Tuple(PaymentInitiationConsentCreateResponse, Integer, Hash)] PaymentInitiationConsentCreateResponse, response status code and response headers
Get payment consent
The /payment_initiation/consent/get
endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.
@required @param payment_initiation_consent_get_request [Plaid::PaymentInitiationConsentGetRequest?]
@return [Plaid::PaymentInitiationConsentGetResponse]
Get payment consent The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints. @required @param payment_initiation_consent_get_request [Plaid::PaymentInitiationConsentGetRequest?] @return nil
Get payment consent The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints. @required @param payment_initiation_consent_get_request [Plaid::PaymentInitiationConsentGetRequest?] @return [Tuple(Plaid::PaymentInitiationConsentGetResponse, Integer, Hash)] Plaid::PaymentInitiationConsentGetResponse, response status code and response headers
Execute a single payment using consent
The /payment_initiation/consent/payment/execute
endpoint can be used to execute payments using payment consent.
@required @param payment_initiation_consent_payment_execute_request [Plaid::PaymentInitiationConsentPaymentExecuteRequest?]
@return [PaymentInitiationConsentPaymentExecuteResponse]
Execute a single payment using consent The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent. @required @param payment_initiation_consent_payment_execute_request [Plaid::PaymentInitiationConsentPaymentExecuteRequest?] @return nil
Execute a single payment using consent The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent. @required @param payment_initiation_consent_payment_execute_request [Plaid::PaymentInitiationConsentPaymentExecuteRequest?] @return [Tuple(PaymentInitiationConsentPaymentExecuteResponse, Integer, Hash)] PaymentInitiationConsentPaymentExecuteResponse, response status code and response headers
Revoke payment consent
The /payment_initiation/consent/revoke
endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.
@required @param payment_initiation_consent_revoke_request [Plaid::PaymentInitiationConsentRevokeRequest?]
@return [PaymentInitiationConsentRevokeResponse]
Revoke payment consent The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it. @required @param payment_initiation_consent_revoke_request [Plaid::PaymentInitiationConsentRevokeRequest?] @return nil
Revoke payment consent The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it. @required @param payment_initiation_consent_revoke_request [Plaid::PaymentInitiationConsentRevokeRequest?] @return [Tuple(PaymentInitiationConsentRevokeResponse, Integer, Hash)] PaymentInitiationConsentRevokeResponse, response status code and response headers
Create a payment
After creating a payment recipient, you can use the /payment_initiation/payment/create
endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen currency. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen currency. For details on any payment limits in Production, contact your Plaid Account Manager.
@required @param payment_initiation_payment_create_request [Plaid::PaymentInitiationPaymentCreateRequest?]
@return [PaymentInitiationPaymentCreateResponse]
Create a payment After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen currency. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen currency. For details on any payment limits in Production, contact your Plaid Account Manager. @required @param payment_initiation_payment_create_request [Plaid::PaymentInitiationPaymentCreateRequest?] @return nil
Create a payment After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen currency. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen currency. For details on any payment limits in Production, contact your Plaid Account Manager. @required @param payment_initiation_payment_create_request [Plaid::PaymentInitiationPaymentCreateRequest?] @return [Tuple(PaymentInitiationPaymentCreateResponse, Integer, Hash)] PaymentInitiationPaymentCreateResponse, response status code and response headers
Get payment details
The /payment_initiation/payment/get
endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the /payment_initiation/payment/get
endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
@required @param payment_initiation_payment_get_request [Plaid::PaymentInitiationPaymentGetRequest?]
@return [Plaid::PaymentInitiationPaymentGetResponse]
Get payment details The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. @required @param payment_initiation_payment_get_request [Plaid::PaymentInitiationPaymentGetRequest?] @return nil
Get payment details The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. @required @param payment_initiation_payment_get_request [Plaid::PaymentInitiationPaymentGetRequest?] @return [Tuple(Plaid::PaymentInitiationPaymentGetResponse, Integer, Hash)] Plaid::PaymentInitiationPaymentGetResponse, response status code and response headers
List payments
The /payment_initiation/payment/list
endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional count
and cursor
parameters.
@required @param payment_initiation_payment_list_request [Plaid::PaymentInitiationPaymentListRequest?]
@return [PaymentInitiationPaymentListResponse]
List payments The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters. @required @param payment_initiation_payment_list_request [Plaid::PaymentInitiationPaymentListRequest?] @return nil
List payments The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters. @required @param payment_initiation_payment_list_request [Plaid::PaymentInitiationPaymentListRequest?] @return [Tuple(PaymentInitiationPaymentListResponse, Integer, Hash)] PaymentInitiationPaymentListResponse, response status code and response headers
Reverse an existing payment Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. @required @param payment_initiation_payment_reverse_request [Plaid::PaymentInitiationPaymentReverseRequest?] @return [PaymentInitiationPaymentReverseResponse]
Reverse an existing payment Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. @required @param payment_initiation_payment_reverse_request [Plaid::PaymentInitiationPaymentReverseRequest?] @return nil
Reverse an existing payment Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. @required @param payment_initiation_payment_reverse_request [Plaid::PaymentInitiationPaymentReverseRequest?] @return [Tuple(PaymentInitiationPaymentReverseResponse, Integer, Hash)] PaymentInitiationPaymentReverseResponse, response status code and response headers
Create payment recipient
Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country supported by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use bacs
in the UK and iban
in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same recipient_id
.
@required @param payment_initiation_recipient_create_request [Plaid::PaymentInitiationRecipientCreateRequest?]
@return [PaymentInitiationRecipientCreateResponse]
Create payment recipient Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country supported by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`. @required @param payment_initiation_recipient_create_request [Plaid::PaymentInitiationRecipientCreateRequest?] @return nil
Create payment recipient Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country supported by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`. @required @param payment_initiation_recipient_create_request [Plaid::PaymentInitiationRecipientCreateRequest?] @return [Tuple(PaymentInitiationRecipientCreateResponse, Integer, Hash)] PaymentInitiationRecipientCreateResponse, response status code and response headers
Get payment recipient Get details about a payment recipient you have previously created. @required @param payment_initiation_recipient_get_request [Plaid::PaymentInitiationRecipientGetRequest?] @return [Plaid::PaymentInitiationRecipientGetResponse]
Get payment recipient Get details about a payment recipient you have previously created. @required @param payment_initiation_recipient_get_request [Plaid::PaymentInitiationRecipientGetRequest?] @return nil
Get payment recipient Get details about a payment recipient you have previously created. @required @param payment_initiation_recipient_get_request [Plaid::PaymentInitiationRecipientGetRequest?] @return [Tuple(Plaid::PaymentInitiationRecipientGetResponse, Integer, Hash)] Plaid::PaymentInitiationRecipientGetResponse, response status code and response headers
List payment recipients
The /payment_initiation/recipient/list
endpoint list the payment recipients that you have previously created.
@required @param payment_initiation_recipient_list_request [Plaid::PaymentInitiationRecipientListRequest?]
@return [PaymentInitiationRecipientListResponse]
List payment recipients The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created. @required @param payment_initiation_recipient_list_request [Plaid::PaymentInitiationRecipientListRequest?] @return nil
List payment recipients The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created. @required @param payment_initiation_recipient_list_request [Plaid::PaymentInitiationRecipientListRequest?] @return [Tuple(PaymentInitiationRecipientListResponse, Integer, Hash)] PaymentInitiationRecipientListResponse, response status code and response headers
Create payment profile
Use /payment_profile/create
endpoint to create a new payment profile. To initiate the account linking experience, call /link/token/create
and provide the payment_profile_token
in the transfer.payment_profile_token
field. You can then use the payment_profile_token
when creating transfers using /transfer/authorization/create
and /transfer/create
.
@required @param payment_profile_create_request [Plaid::PaymentProfileCreateRequest?]
@return [PaymentProfileCreateResponse]
Create payment profile Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field. You can then use the `payment_profile_token` when creating transfers using `/transfer/authorization/create` and `/transfer/create`. @required @param payment_profile_create_request [Plaid::PaymentProfileCreateRequest?] @return nil
Create payment profile Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field. You can then use the `payment_profile_token` when creating transfers using `/transfer/authorization/create` and `/transfer/create`. @required @param payment_profile_create_request [Plaid::PaymentProfileCreateRequest?] @return [Tuple(PaymentProfileCreateResponse, Integer, Hash)] PaymentProfileCreateResponse, response status code and response headers
Get payment profile
Use /payment_profile/get
endpoint to get the status of a given Payment Profile.
@required @param payment_profile_get_request [Plaid::PaymentProfileGetRequest?]
@return [PaymentProfileGetResponse]
Get payment profile Use `/payment_profile/get` endpoint to get the status of a given Payment Profile. @required @param payment_profile_get_request [Plaid::PaymentProfileGetRequest?] @return nil
Get payment profile Use `/payment_profile/get` endpoint to get the status of a given Payment Profile. @required @param payment_profile_get_request [Plaid::PaymentProfileGetRequest?] @return [Tuple(PaymentProfileGetResponse, Integer, Hash)] PaymentProfileGetResponse, response status code and response headers
Remove payment profile
Use the /payment_profile/remove
endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.
@required @param payment_profile_remove_request [Plaid::PaymentProfileRemoveRequest?]
@return [PaymentProfileRemoveResponse]
Remove payment profile Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers. @required @param payment_profile_remove_request [Plaid::PaymentProfileRemoveRequest?] @return nil
Remove payment profile Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers. @required @param payment_profile_remove_request [Plaid::PaymentProfileRemoveRequest?] @return [Tuple(PaymentProfileRemoveResponse, Integer, Hash)] PaymentProfileRemoveResponse, response status code and response headers
Retrieve the account associated with a processor token
This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use /processor/balance/get
instead. Note that some information is nullable.
@required @param processor_account_get_request [Plaid::ProcessorAccountGetRequest?]
@return [ProcessorAccountGetResponse]
Retrieve the account associated with a processor token This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use `/processor/balance/get` instead. Note that some information is nullable. @required @param processor_account_get_request [Plaid::ProcessorAccountGetRequest?] @return nil
Retrieve the account associated with a processor token This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use `/processor/balance/get` instead. Note that some information is nullable. @required @param processor_account_get_request [Plaid::ProcessorAccountGetRequest?] @return [Tuple(ProcessorAccountGetResponse, Integer, Hash)] ProcessorAccountGetResponse, response status code and response headers
Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations. @required @param processor_apex_processor_token_create_request [Plaid::ProcessorApexProcessorTokenCreateRequest?] @return [ProcessorTokenCreateResponse]
Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations. @required @param processor_apex_processor_token_create_request [Plaid::ProcessorApexProcessorTokenCreateRequest?] @return nil
Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations. @required @param processor_apex_processor_token_create_request [Plaid::ProcessorApexProcessorTokenCreateRequest?] @return [Tuple(ProcessorTokenCreateResponse, Integer, Hash)] ProcessorTokenCreateResponse, response status code and response headers
Retrieve Auth data
The /processor/auth/get
endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given processor_token
. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the numbers
object returned by this endpoint. For details, see Plaid API versioning.
@required @param processor_auth_get_request [Plaid::ProcessorAuthGetRequest?]
@return [ProcessorAuthGetResponse]
Retrieve Auth data The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see Plaid API versioning. @required @param processor_auth_get_request [Plaid::ProcessorAuthGetRequest?] @return nil
Retrieve Auth data The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see Plaid API versioning. @required @param processor_auth_get_request [Plaid::ProcessorAuthGetRequest?] @return [Tuple(ProcessorAuthGetResponse, Integer, Hash)] ProcessorAuthGetResponse, response status code and response headers
Retrieve Balance data
The /processor/balance/get
endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only /processor/balance/get
forces the available and current balance fields to be refreshed rather than cached.
@required @param processor_balance_get_request [Plaid::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
.
@return [ProcessorBalanceGetResponse]
Retrieve Balance data
The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
@required @param processor_balance_get_request [Plaid::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
.
@return nil
Retrieve Balance data
The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
@required @param processor_balance_get_request [Plaid::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
.
@return [Tuple(ProcessorBalanceGetResponse, Integer, Hash)] ProcessorBalanceGetResponse, response status code and response headers
Create a bank transfer as a processor
Use the /processor/bank_transfer/create
endpoint to initiate a new bank transfer as a processor
@required @param processor_bank_transfer_create_request [Plaid::ProcessorBankTransferCreateRequest?]
@return [ProcessorBankTransferCreateResponse]
Create a bank transfer as a processor Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor @required @param processor_bank_transfer_create_request [Plaid::ProcessorBankTransferCreateRequest?] @return nil
Create a bank transfer as a processor Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor @required @param processor_bank_transfer_create_request [Plaid::ProcessorBankTransferCreateRequest?] @return [Tuple(ProcessorBankTransferCreateResponse, Integer, Hash)] ProcessorBankTransferCreateResponse, response status code and response headers
Retrieve Identity data
The /processor/identity/get
endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
@required @param processor_identity_get_request [Plaid::ProcessorIdentityGetRequest?]
@return [ProcessorIdentityGetResponse]
Retrieve Identity data The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. @required @param processor_identity_get_request [Plaid::ProcessorIdentityGetRequest?] @return nil
Retrieve Identity data The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. @required @param processor_identity_get_request [Plaid::ProcessorIdentityGetRequest?] @return [Tuple(ProcessorIdentityGetResponse, Integer, Hash)] ProcessorIdentityGetResponse, response status code and response headers
Retrieve identity match score
The /processor/identity/match
endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the balances
object will always be null when retrieved by /identity/match
. Instead, use the free /accounts/get
endpoint to request balance cached data, or /accounts/balance/get
for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
@required @param processor_identity_match_request [Plaid::ProcessorIdentityMatchRequest?]
@return [ProcessorIdentityMatchResponse]
Retrieve identity match score The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. @required @param processor_identity_match_request [Plaid::ProcessorIdentityMatchRequest?] @return nil
Retrieve identity match score The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. @required @param processor_identity_match_request [Plaid::ProcessorIdentityMatchRequest?] @return [Tuple(ProcessorIdentityMatchResponse, Integer, Hash)] ProcessorIdentityMatchResponse, response status code and response headers
Report whether you initiated an ACH transaction
After calling /processor/signal/evaluate
, call /processor/signal/decision/report
to report whether the transaction was initiated.
@required @param processor_signal_decision_report_request [Plaid::ProcessorSignalDecisionReportRequest?]
@return [ProcessorSignalDecisionReportResponse]
Report whether you initiated an ACH transaction After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. @required @param processor_signal_decision_report_request [Plaid::ProcessorSignalDecisionReportRequest?] @return nil
Report whether you initiated an ACH transaction After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. @required @param processor_signal_decision_report_request [Plaid::ProcessorSignalDecisionReportRequest?] @return [Tuple(ProcessorSignalDecisionReportResponse, Integer, Hash)] ProcessorSignalDecisionReportResponse, response status code and response headers
Evaluate a planned ACH transaction
Use /processor/signal/evaluate
to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If /processor/signal/evaluate
is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on item errors and Link in Update Mode. Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. To reduce this latency, you can call /signal/prepare
on the Item before you need to request Signal data.
@required @param processor_signal_evaluate_request [Plaid::ProcessorSignalEvaluateRequest?]
@return [ProcessorSignalEvaluateResponse]
Evaluate a planned ACH transaction Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on item errors and Link in Update Mode. Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. To reduce this latency, you can call `/signal/prepare` on the Item before you need to request Signal data. @required @param processor_signal_evaluate_request [Plaid::ProcessorSignalEvaluateRequest?] @return nil
Evaluate a planned ACH transaction Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on item errors and Link in Update Mode. Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. To reduce this latency, you can call `/signal/prepare` on the Item before you need to request Signal data. @required @param processor_signal_evaluate_request [Plaid::ProcessorSignalEvaluateRequest?] @return [Tuple(ProcessorSignalEvaluateResponse, Integer, Hash)] ProcessorSignalEvaluateResponse, response status code and response headers
Opt-in a processor token to Signal
When a processor token is not initialized with Signal, call /processor/signal/prepare
to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score. If this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token.
@required @param processor_signal_prepare_request [Plaid::ProcessorSignalPrepareRequest?]
@return [ProcessorSignalPrepareResponse]
Opt-in a processor token to Signal When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score. If this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token. @required @param processor_signal_prepare_request [Plaid::ProcessorSignalPrepareRequest?] @return nil
Opt-in a processor token to Signal When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score. If this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token. @required @param processor_signal_prepare_request [Plaid::ProcessorSignalPrepareRequest?] @return [Tuple(ProcessorSignalPrepareResponse, Integer, Hash)] ProcessorSignalPrepareResponse, response status code and response headers
Report a return for an ACH transaction
Call the /processor/signal/return/report
endpoint to report a returned transaction that was previously sent to the /processor/signal/evaluate
endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
@required @param processor_signal_return_report_request [Plaid::ProcessorSignalReturnReportRequest?]
@return [ProcessorSignalReturnReportResponse]
Report a return for an ACH transaction Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. @required @param processor_signal_return_report_request [Plaid::ProcessorSignalReturnReportRequest?] @return nil
Report a return for an ACH transaction Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. @required @param processor_signal_return_report_request [Plaid::ProcessorSignalReturnReportRequest?] @return [Tuple(ProcessorSignalReturnReportResponse, Integer, Hash)] ProcessorSignalReturnReportResponse, response status code and response headers
Create Stripe bank account token
Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see Add Stripe to your app. Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new access_token
. Bank account tokens can also be revoked, using /item/remove
.
@required @param processor_stripe_bank_account_token_create_request [Plaid::ProcessorStripeBankAccountTokenCreateRequest?]
@return [ProcessorStripeBankAccountTokenCreateResponse]
Create Stripe bank account token Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see Add Stripe to your app. Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`. @required @param processor_stripe_bank_account_token_create_request [Plaid::ProcessorStripeBankAccountTokenCreateRequest?] @return nil
Create Stripe bank account token Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see Add Stripe to your app. Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`. @required @param processor_stripe_bank_account_token_create_request [Plaid::ProcessorStripeBankAccountTokenCreateRequest?] @return [Tuple(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)] ProcessorStripeBankAccountTokenCreateResponse, response status code and response headers
Create processor token
Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see /processor/stripe/bank_account_token/create
for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new access_token
. Processor tokens can also be revoked, using /item/remove
.
@required @param processor_token_create_request [Plaid::ProcessorTokenCreateRequest?]
@return [ProcessorTokenCreateResponse]
Create processor token Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`. @required @param processor_token_create_request [Plaid::ProcessorTokenCreateRequest?] @return nil
Create processor token Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`. @required @param processor_token_create_request [Plaid::ProcessorTokenCreateRequest?] @return [Tuple(ProcessorTokenCreateResponse, Integer, Hash)] ProcessorTokenCreateResponse, response status code and response headers
Get a processor token's product permissions
Used to get a processor token's product permissions. The products
field will be an empty list if the processor can access all available products.
@required @param processor_token_permissions_get_request [Plaid::ProcessorTokenPermissionsGetRequest?]
@return [ProcessorTokenPermissionsGetResponse]
Get a processor token's product permissions Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products. @required @param processor_token_permissions_get_request [Plaid::ProcessorTokenPermissionsGetRequest?] @return nil
Get a processor token's product permissions Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products. @required @param processor_token_permissions_get_request [Plaid::ProcessorTokenPermissionsGetRequest?] @return [Tuple(ProcessorTokenPermissionsGetResponse, Integer, Hash)] ProcessorTokenPermissionsGetResponse, response status code and response headers
Control a processor's access to products Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change. @required @param processor_token_permissions_set_request [Plaid::ProcessorTokenPermissionsSetRequest?] @return [ProcessorTokenPermissionsSetResponse]
Control a processor's access to products Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change. @required @param processor_token_permissions_set_request [Plaid::ProcessorTokenPermissionsSetRequest?] @return nil
Control a processor's access to products Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change. @required @param processor_token_permissions_set_request [Plaid::ProcessorTokenPermissionsSetRequest?] @return [Tuple(ProcessorTokenPermissionsSetResponse, Integer, Hash)] ProcessorTokenPermissionsSetResponse, response status code and response headers
Update a processor token's webhook URL
This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a WEBHOOK_UPDATE_ACKNOWLEDGED
webhook to the newly specified webhook URL.
@required @param processor_token_webhook_update_request [Plaid::ProcessorTokenWebhookUpdateRequest?]
@return [ProcessorTokenWebhookUpdateResponse]
Update a processor token's webhook URL This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL. @required @param processor_token_webhook_update_request [Plaid::ProcessorTokenWebhookUpdateRequest?] @return nil
Update a processor token's webhook URL This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL. @required @param processor_token_webhook_update_request [Plaid::ProcessorTokenWebhookUpdateRequest?] @return [Tuple(ProcessorTokenWebhookUpdateResponse, Integer, Hash)] ProcessorTokenWebhookUpdateResponse, response status code and response headers
Get transaction data
The /processor/transactions/get
endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student
; coverage may be limited). 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 /processor/transactions/get
. For more details, see Pending and posted transactions. Due to the potentially large number of transactions associated with a processor token, 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 /processor/transactions/get
will be the data available for the processor token 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. To force Plaid to check for new transactions, you can use the /processor/transactions/refresh
endpoint. Note that data may not be immediately available to /processor/transactions/get
. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with transactions
, or upon the first call to /processor/transactions/get
, if it wasn't. If no transaction history is ready when /processor/transactions/get
is called, it will return a PRODUCT_NOT_READY
error. To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update
endpoint.
@required @param processor_transactions_get_request [Plaid::ProcessorTransactionsGetRequest?]
@return [ProcessorTransactionsGetResponse]
Get transaction data The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). 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 `/processor/transactions/get`. For more details, see Pending and posted transactions. Due to the potentially large number of transactions associated with a processor token, 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 `/processor/transactions/get` will be the data available for the processor token 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. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the `/processor/token/webhook/update` endpoint. @required @param processor_transactions_get_request [Plaid::ProcessorTransactionsGetRequest?] @return nil
Get transaction data The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). 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 `/processor/transactions/get`. For more details, see Pending and posted transactions. Due to the potentially large number of transactions associated with a processor token, 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 `/processor/transactions/get` will be the data available for the processor token 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. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the `/processor/token/webhook/update` endpoint. @required @param processor_transactions_get_request [Plaid::ProcessorTransactionsGetRequest?] @return [Tuple(ProcessorTransactionsGetResponse, Integer, Hash)] ProcessorTransactionsGetResponse, response status code and response headers
Fetch recurring transaction streams
The /processor/transactions/recurring/get
endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in /link/token/create
; or after Link, by calling /processor/transactions/get
or /processor/transactions/sync
). Once all historical transactions have been fetched, call /processor/transactions/recurring/get
to receive the Recurring Transactions streams and subscribe to the RECURRING_TRANSACTIONS_UPDATE
webhook. To know when historical transactions have been fetched, if you are using /processor/transactions/sync
listen for the SYNC_UPDATES_AVAILABLE
webhook and check that the historical_update_complete
field in the payload is true
. If using /processor/transactions/get
, listen for the HISTORICAL_UPDATE
webhook. After the initial call, you can call /processor/transactions/recurring/get
endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the RECURRING_TRANSACTIONS_UPDATE
webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update
endpoint.
@required @param processor_transactions_recurring_get_request [Plaid::ProcessorTransactionsRecurringGetRequest?]
@return [ProcessorTransactionsRecurringGetResponse]
Fetch recurring transaction streams The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the `RECURRING_TRANSACTIONS_UPDATE` webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the `SYNC_UPDATES_AVAILABLE` webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the `HISTORICAL_UPDATE` webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the `RECURRING_TRANSACTIONS_UPDATE` webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the `/processor/token/webhook/update` endpoint. @required @param processor_transactions_recurring_get_request [Plaid::ProcessorTransactionsRecurringGetRequest?] @return nil
Fetch recurring transaction streams The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the `RECURRING_TRANSACTIONS_UPDATE` webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the `SYNC_UPDATES_AVAILABLE` webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the `HISTORICAL_UPDATE` webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the `RECURRING_TRANSACTIONS_UPDATE` webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the `/processor/token/webhook/update` endpoint. @required @param processor_transactions_recurring_get_request [Plaid::ProcessorTransactionsRecurringGetRequest?] @return [Tuple(ProcessorTransactionsRecurringGetResponse, Integer, Hash)] ProcessorTransactionsRecurringGetResponse, response status code and response headers
Refresh transaction data
/processor/transactions/refresh
is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled processor token. If changes to transactions are discovered after calling /processor/transactions/refresh
, Plaid will fire a webhook: for /transactions/sync
users, SYNC_UPDATES_AVAILABLE
will be fired if there are any transactions updated, added, or removed. For users of both /processor/transactions/sync
and /processor/transactions/get
, TRANSACTIONS_REMOVED
will be fired if any removed transactions are detected, and DEFAULT_UPDATE
will be fired if any new transactions are detected. New transactions can be fetched by calling /processor/transactions/get
or /processor/transactions/sync
. Note that the /processor/transactions/refresh
endpoint is not supported for Capital One (ins_128026
) and will result in a PRODUCT_NOT_SUPPORTED
error if called on a processor token from that institution. /processor/transactions/refresh
is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
@required @param processor_transactions_refresh_request [Plaid::ProcessorTransactionsRefreshRequest?]
@return [ProcessorTransactionsRefreshResponse]
Refresh transaction data `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, `SYNC_UPDATES_AVAILABLE` will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, `TRANSACTIONS_REMOVED` will be fired if any removed transactions are detected, and `DEFAULT_UPDATE` will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on a processor token from that institution. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param processor_transactions_refresh_request [Plaid::ProcessorTransactionsRefreshRequest?] @return nil
Refresh transaction data `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, `SYNC_UPDATES_AVAILABLE` will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, `TRANSACTIONS_REMOVED` will be fired if any removed transactions are detected, and `DEFAULT_UPDATE` will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on a processor token from that institution. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param processor_transactions_refresh_request [Plaid::ProcessorTransactionsRefreshRequest?] @return [Tuple(ProcessorTransactionsRefreshResponse, Integer, Hash)] ProcessorTransactionsRefreshResponse, response status code and response headers
Get incremental transaction updates on a processor token
This endpoint replaces /processor/transactions/get
and its associated webhooks for most common use-cases. The /processor/transactions/sync
endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. /processor/transactions/sync
provides the same functionality as /processor/transactions/get
and can be used instead of /processor/transactions/get
to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for credit
, depository
, and some loan-type accounts (only those with account subtype student
; coverage may be limited). For transaction history from investments
accounts, use /investments/transactions/get
instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to /processor/transactions/sync
for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as "adds"), which then generates a next_cursor
for that processor token. In subsequent calls, send the next_cursor
to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The has_more
field specifies if additional calls are necessary to fetch all available transaction updates. Call /processor/transactions/sync
with the new cursor, pulling all updates, until has_more
is false
. When retrieving paginated updates, track both the next_cursor
from the latest response and the original cursor from the first call in which has_more
was true
; if a call to /processor/transactions/sync
fails when retrieving a paginated update, which can occur as a result of the TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION
error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, /processor/transactions/sync
will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the /processor/transactions/refresh
endpoint. Note that for newly created processor tokens, data may not be immediately available to /processor/transactions/sync
. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update
endpoint.
@required @param processor_transactions_sync_request [Plaid::ProcessorTransactionsSyncRequest?]
@return [ProcessorTransactionsSyncResponse]
Get incremental transaction updates on a processor token This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as "adds"), which then generates a `next_cursor` for that processor token. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the `TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION` error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created processor tokens, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the `/processor/token/webhook/update` endpoint. @required @param processor_transactions_sync_request [Plaid::ProcessorTransactionsSyncRequest?] @return nil
Get incremental transaction updates on a processor token This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as "adds"), which then generates a `next_cursor` for that processor token. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the `TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION` error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created processor tokens, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the `/processor/token/webhook/update` endpoint. @required @param processor_transactions_sync_request [Plaid::ProcessorTransactionsSyncRequest?] @return [Tuple(ProcessorTransactionsSyncResponse, Integer, Hash)] ProcessorTransactionsSyncResponse, response status code and response headers
Manually fire a bank income webhook in sandbox
Use the /sandbox/bank_income/fire_webhook
endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
@required @param sandbox_bank_income_fire_webhook_request [Plaid::SandboxBankIncomeFireWebhookRequest?]
@return [SandboxBankIncomeFireWebhookResponse]
Manually fire a bank income webhook in sandbox Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment. @required @param sandbox_bank_income_fire_webhook_request [Plaid::SandboxBankIncomeFireWebhookRequest?] @return nil
Manually fire a bank income webhook in sandbox Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment. @required @param sandbox_bank_income_fire_webhook_request [Plaid::SandboxBankIncomeFireWebhookRequest?] @return [Tuple(SandboxBankIncomeFireWebhookResponse, Integer, Hash)] SandboxBankIncomeFireWebhookResponse, response status code and response headers
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.
@required @param sandbox_bank_transfer_fire_webhook_request [Plaid::SandboxBankTransferFireWebhookRequest?]
@return [SandboxBankTransferFireWebhookResponse]
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. @required @param sandbox_bank_transfer_fire_webhook_request [Plaid::SandboxBankTransferFireWebhookRequest?] @return nil
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. @required @param sandbox_bank_transfer_fire_webhook_request [Plaid::SandboxBankTransferFireWebhookRequest?] @return [Tuple(SandboxBankTransferFireWebhookResponse, Integer, Hash)] SandboxBankTransferFireWebhookResponse, response status code and response headers
Simulate a bank transfer event in Sandbox
Use the /sandbox/bank_transfer/simulate
endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as /bank_transfer/event/sync
or /bank_transfer/event/list
, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
@required @param sandbox_bank_transfer_simulate_request [Plaid::SandboxBankTransferSimulateRequest?]
@return [SandboxBankTransferSimulateResponse]
Simulate a bank transfer event in Sandbox Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox. @required @param sandbox_bank_transfer_simulate_request [Plaid::SandboxBankTransferSimulateRequest?] @return nil
Simulate a bank transfer event in Sandbox Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox. @required @param sandbox_bank_transfer_simulate_request [Plaid::SandboxBankTransferSimulateRequest?] @return [Tuple(SandboxBankTransferSimulateResponse, Integer, Hash)] SandboxBankTransferSimulateResponse, response status code and response headers
Manually fire an Income webhook
Use the /sandbox/income/fire_webhook
endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
@required @param sandbox_income_fire_webhook_request [Plaid::SandboxIncomeFireWebhookRequest?]
@return [SandboxIncomeFireWebhookResponse]
Manually fire an Income webhook Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment. @required @param sandbox_income_fire_webhook_request [Plaid::SandboxIncomeFireWebhookRequest?] @return nil
Manually fire an Income webhook Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment. @required @param sandbox_income_fire_webhook_request [Plaid::SandboxIncomeFireWebhookRequest?] @return [Tuple(SandboxIncomeFireWebhookResponse, Integer, Hash)] SandboxIncomeFireWebhookResponse, response status code and response headers
Fire a test webhook
The /sandbox/item/fire_webhook
endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: DEFAULT_UPDATE
: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a SANDBOX_PRODUCT_NOT_ENABLED
error will result. NEW_ACCOUNTS_AVAILABLE
: Webhook to be fired for a given Sandbox Item created with Account Select v2. AUTH_DATA_UPDATE
: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. LOGIN_REPAIRED
: Fired when an Item recovers from the ITEM_LOGIN_REQUIRED
without the user going through update mode in your app. RECURRING_TRANSACTIONS_UPDATE
: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a SANDBOX_PRODUCT_NOT_ENABLED
error will result. SYNC_UPDATES_AVAILABLE
: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a SANDBOX_PRODUCT_NOT_ENABLED
error will result. PRODUCT_READY
: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a SANDBOX_PRODUCT_NOT_ENABLED
error will result. ERROR
: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a SANDBOX_PRODUCT_NOT_ENABLED
error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development (except for webhooks of type TRANSFER
).
@required @param sandbox_item_fire_webhook_request [Plaid::SandboxItemFireWebhookRequest?]
@return [SandboxItemFireWebhookResponse]
Fire a test webhook The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development (except for webhooks of type `TRANSFER`). @required @param sandbox_item_fire_webhook_request [Plaid::SandboxItemFireWebhookRequest?] @return nil
Fire a test webhook The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development (except for webhooks of type `TRANSFER`). @required @param sandbox_item_fire_webhook_request [Plaid::SandboxItemFireWebhookRequest?] @return [Tuple(SandboxItemFireWebhookResponse, Integer, Hash)] SandboxItemFireWebhookResponse, response status code and response headers
Force a Sandbox Item into an error state
/sandbox/item/reset_login/
forces an Item into an ITEM_LOGIN_REQUIRED
state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's update mode flow in the Sandbox environment. After calling /sandbox/item/reset_login
, You can then use Plaid Link update mode to restore the Item to a good state. An ITEM_LOGIN_REQUIRED
webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an ITEM_LOGIN_REQUIRED
error state automatically after 30 days, even if this endpoint is not called.
@required @param sandbox_item_reset_login_request [Plaid::SandboxItemResetLoginRequest?]
@return [SandboxItemResetLoginResponse]
Force a Sandbox Item into an error state `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's update mode flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called. @required @param sandbox_item_reset_login_request [Plaid::SandboxItemResetLoginRequest?] @return nil
Force a Sandbox Item into an error state `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's update mode flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called. @required @param sandbox_item_reset_login_request [Plaid::SandboxItemResetLoginRequest?] @return [Tuple(SandboxItemResetLoginResponse, Integer, Hash)] SandboxItemResetLoginResponse, response status code and response headers
Set verification status for Sandbox account
The /sandbox/item/set_verification_status
endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or submit a product access Support ticket. For more information on testing Automated Micro-deposits in Sandbox, see Auth full coverage testing.
@required @param sandbox_item_set_verification_status_request [Plaid::SandboxItemSetVerificationStatusRequest?]
@return [SandboxItemSetVerificationStatusResponse]
Set verification status for Sandbox account The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or submit a product access Support ticket. For more information on testing Automated Micro-deposits in Sandbox, see Auth full coverage testing. @required @param sandbox_item_set_verification_status_request [Plaid::SandboxItemSetVerificationStatusRequest?] @return nil
Set verification status for Sandbox account The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or submit a product access Support ticket. For more information on testing Automated Micro-deposits in Sandbox, see Auth full coverage testing. @required @param sandbox_item_set_verification_status_request [Plaid::SandboxItemSetVerificationStatusRequest?] @return [Tuple(SandboxItemSetVerificationStatusResponse, Integer, Hash)] SandboxItemSetVerificationStatusResponse, response status code and response headers
Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution @required @param sandbox_oauth_select_accounts_request [Plaid::SandboxOauthSelectAccountsRequest?] @return [Hash(String, Object)]
Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution @required @param sandbox_oauth_select_accounts_request [Plaid::SandboxOauthSelectAccountsRequest?] @return nil
Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution @required @param sandbox_oauth_select_accounts_request [Plaid::SandboxOauthSelectAccountsRequest?] @return [Tuple(Hash(String, Object), Integer, Hash)] Hash(String, Object), response status code and response headers
Reset the login of a Payment Profile
/sandbox/payment_profile/reset_login/
forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling /sandbox/payment_profile/reset_login
, calls to the /transfer/authorization/create
with the Payment Profile will result in a decision_rationale
PAYMENT_PROFILE_LOGIN_REQUIRED
. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first create a Payment Profile and go through the Link flow.
@required @param sandbox_payment_profile_reset_login_request [Plaid::SandboxPaymentProfileResetLoginRequest?]
@return [SandboxPaymentProfileResetLoginResponse]
Reset the login of a Payment Profile `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a `decision_rationale` `PAYMENT_PROFILE_LOGIN_REQUIRED`. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first create a Payment Profile and go through the Link flow. @required @param sandbox_payment_profile_reset_login_request [Plaid::SandboxPaymentProfileResetLoginRequest?] @return nil
Reset the login of a Payment Profile `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a `decision_rationale` `PAYMENT_PROFILE_LOGIN_REQUIRED`. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first create a Payment Profile and go through the Link flow. @required @param sandbox_payment_profile_reset_login_request [Plaid::SandboxPaymentProfileResetLoginRequest?] @return [Tuple(SandboxPaymentProfileResetLoginResponse, Integer, Hash)] SandboxPaymentProfileResetLoginResponse, response status code and response headers
Create a test Item and processor token
Use the /sandbox/processor_token/create
endpoint to create a valid processor_token
for an arbitrary institution ID and test credentials. The created processor_token
corresponds to a new Sandbox Item. You can then use this processor_token
with the /processor/
API endpoints in Sandbox. You can also use /sandbox/processor_token/create
with the user_custom
test username to generate a test account with custom data.
@required @param sandbox_processor_token_create_request [Plaid::SandboxProcessorTokenCreateRequest?]
@return [SandboxProcessorTokenCreateResponse]
Create a test Item and processor token Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the `user_custom` test username to generate a test account with custom data. @required @param sandbox_processor_token_create_request [Plaid::SandboxProcessorTokenCreateRequest?] @return nil
Create a test Item and processor token Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the `user_custom` test username to generate a test account with custom data. @required @param sandbox_processor_token_create_request [Plaid::SandboxProcessorTokenCreateRequest?] @return [Tuple(SandboxProcessorTokenCreateResponse, Integer, Hash)] SandboxProcessorTokenCreateResponse, response status code and response headers
Create a test Item
Use the /sandbox/public_token/create
endpoint to create a valid public_token
for an arbitrary institution ID, initial products, and test credentials. The created public_token
maps to a new Sandbox Item. You can then call /item/public_token/exchange
to exchange the public_token
for an access_token
and perform all API actions. /sandbox/public_token/create
can also be used with the user_custom
test username to generate a test account with custom data. /sandbox/public_token/create
cannot be used with OAuth institutions.
@required @param sandbox_public_token_create_request [Plaid::SandboxPublicTokenCreateRequest?]
@return [SandboxPublicTokenCreateResponse]
Create a test Item Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the `user_custom` test username to generate a test account with custom data. `/sandbox/public_token/create` cannot be used with OAuth institutions. @required @param sandbox_public_token_create_request [Plaid::SandboxPublicTokenCreateRequest?] @return nil
Create a test Item Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the `user_custom` test username to generate a test account with custom data. `/sandbox/public_token/create` cannot be used with OAuth institutions. @required @param sandbox_public_token_create_request [Plaid::SandboxPublicTokenCreateRequest?] @return [Tuple(SandboxPublicTokenCreateResponse, Integer, Hash)] SandboxPublicTokenCreateResponse, response status code and response headers
Manually fire a Transfer webhook
Use the /sandbox/transfer/fire_webhook
endpoint to manually trigger a TRANSFER_EVENTS_UPDATE
webhook in the Sandbox environment.
@required @param sandbox_transfer_fire_webhook_request [Plaid::SandboxTransferFireWebhookRequest?]
@return [SandboxTransferFireWebhookResponse]
Manually fire a Transfer webhook Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment. @required @param sandbox_transfer_fire_webhook_request [Plaid::SandboxTransferFireWebhookRequest?] @return nil
Manually fire a Transfer webhook Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment. @required @param sandbox_transfer_fire_webhook_request [Plaid::SandboxTransferFireWebhookRequest?] @return [Tuple(SandboxTransferFireWebhookResponse, Integer, Hash)] SandboxTransferFireWebhookResponse, response status code and response headers
Simulate a ledger deposit event in Sandbox
Use the /sandbox/transfer/ledger/deposit/simulate
endpoint to simulate a ledger deposit event in the Sandbox environment.
@required @param sandbox_transfer_ledger_deposit_simulate_request [Plaid::SandboxTransferLedgerDepositSimulateRequest?]
@return [SandboxTransferLedgerDepositSimulateResponse]
Simulate a ledger deposit event in Sandbox Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment. @required @param sandbox_transfer_ledger_deposit_simulate_request [Plaid::SandboxTransferLedgerDepositSimulateRequest?] @return nil
Simulate a ledger deposit event in Sandbox Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment. @required @param sandbox_transfer_ledger_deposit_simulate_request [Plaid::SandboxTransferLedgerDepositSimulateRequest?] @return [Tuple(SandboxTransferLedgerDepositSimulateResponse, Integer, Hash)] SandboxTransferLedgerDepositSimulateResponse, response status code and response headers
Simulate converting pending balance to available balance
Use the /sandbox/transfer/ledger/simulate_available
endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.
@required @param sandbox_transfer_ledger_simulate_available_request [Plaid::SandboxTransferLedgerSimulateAvailableRequest?]
@return [SandboxTransferLedgerSimulateAvailableResponse]
Simulate converting pending balance to available balance Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment. @required @param sandbox_transfer_ledger_simulate_available_request [Plaid::SandboxTransferLedgerSimulateAvailableRequest?] @return nil
Simulate converting pending balance to available balance Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment. @required @param sandbox_transfer_ledger_simulate_available_request [Plaid::SandboxTransferLedgerSimulateAvailableRequest?] @return [Tuple(SandboxTransferLedgerSimulateAvailableResponse, Integer, Hash)] SandboxTransferLedgerSimulateAvailableResponse, response status code and response headers
Simulate a ledger withdraw event in Sandbox
Use the /sandbox/transfer/ledger/withdraw/simulate
endpoint to simulate a ledger withdraw event in the Sandbox environment.
@required @param sandbox_transfer_ledger_withdraw_simulate_request [Plaid::SandboxTransferLedgerWithdrawSimulateRequest?]
@return [SandboxTransferLedgerWithdrawSimulateResponse]
Simulate a ledger withdraw event in Sandbox Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment. @required @param sandbox_transfer_ledger_withdraw_simulate_request [Plaid::SandboxTransferLedgerWithdrawSimulateRequest?] @return nil
Simulate a ledger withdraw event in Sandbox Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment. @required @param sandbox_transfer_ledger_withdraw_simulate_request [Plaid::SandboxTransferLedgerWithdrawSimulateRequest?] @return [Tuple(SandboxTransferLedgerWithdrawSimulateResponse, Integer, Hash)] SandboxTransferLedgerWithdrawSimulateResponse, response status code and response headers
Simulate a refund event in Sandbox
Use the /sandbox/transfer/refund/simulate
endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as /transfer/event/sync
or /transfer/event/list
, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
@required @param sandbox_transfer_refund_simulate_request [Plaid::SandboxTransferRefundSimulateRequest?]
@return [SandboxTransferRefundSimulateResponse]
Simulate a refund event in Sandbox Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox. @required @param sandbox_transfer_refund_simulate_request [Plaid::SandboxTransferRefundSimulateRequest?] @return nil
Simulate a refund event in Sandbox Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox. @required @param sandbox_transfer_refund_simulate_request [Plaid::SandboxTransferRefundSimulateRequest?] @return [Tuple(SandboxTransferRefundSimulateResponse, Integer, Hash)] SandboxTransferRefundSimulateResponse, response status code and response headers
Trigger the creation of a repayment
Use the /sandbox/transfer/repayment/simulate
endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
@required @param sandbox_transfer_repayment_simulate_request [Plaid::SandboxTransferRepaymentSimulateRequest?]
@return [SandboxTransferRepaymentSimulateResponse]
Trigger the creation of a repayment Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned. @required @param sandbox_transfer_repayment_simulate_request [Plaid::SandboxTransferRepaymentSimulateRequest?] @return nil
Trigger the creation of a repayment Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned. @required @param sandbox_transfer_repayment_simulate_request [Plaid::SandboxTransferRepaymentSimulateRequest?] @return [Tuple(SandboxTransferRepaymentSimulateResponse, Integer, Hash)] SandboxTransferRepaymentSimulateResponse, response status code and response headers
Simulate a transfer event in Sandbox
Use the /sandbox/transfer/simulate
endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as /transfer/event/sync
or /transfer/event/list
, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
@required @param sandbox_transfer_simulate_request [Plaid::SandboxTransferSimulateRequest?]
@return [SandboxTransferSimulateResponse]
Simulate a transfer event in Sandbox Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox. @required @param sandbox_transfer_simulate_request [Plaid::SandboxTransferSimulateRequest?] @return nil
Simulate a transfer event in Sandbox Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox. @required @param sandbox_transfer_simulate_request [Plaid::SandboxTransferSimulateRequest?] @return [Tuple(SandboxTransferSimulateResponse, Integer, Hash)] SandboxTransferSimulateResponse, response status code and response headers
Simulate creating a sweep
Use the /sandbox/transfer/sweep/simulate
endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of swept
will become swept_settled
, all posted
or pending
transfers with a sweep status of unswept
will become swept
, and all returned
transfers with a sweep status of swept
will become return_swept
.
@required @param sandbox_transfer_sweep_simulate_request [Plaid::SandboxTransferSweepSimulateRequest?]
@return [SandboxTransferSweepSimulateResponse]
Simulate creating a sweep Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`. @required @param sandbox_transfer_sweep_simulate_request [Plaid::SandboxTransferSweepSimulateRequest?] @return nil
Simulate creating a sweep Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`. @required @param sandbox_transfer_sweep_simulate_request [Plaid::SandboxTransferSweepSimulateRequest?] @return [Tuple(SandboxTransferSweepSimulateResponse, Integer, Hash)] SandboxTransferSweepSimulateResponse, response status code and response headers
Advance a test clock
Use the /sandbox/transfer/test_clock/advance
endpoint to advance a test_clock
in the Sandbox environment. A test clock object represents an independent timeline and has a virtual_time
field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing virtual_time
, but may never go back to a lower virtual_time
. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For example, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting virtual_time
= t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current virtual_time
should be limited such that there are no more than 20 originations resulting from the advance operation on each recurring_transfer
associated with the test_clock
. For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the virtual_time
up to 80 weeks on each API call.
@required @param sandbox_transfer_test_clock_advance_request [Plaid::SandboxTransferTestClockAdvanceRequest?]
@return [SandboxTransferTestClockAdvanceResponse]
Advance a test clock Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For example, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call. @required @param sandbox_transfer_test_clock_advance_request [Plaid::SandboxTransferTestClockAdvanceRequest?] @return nil
Advance a test clock Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For example, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call. @required @param sandbox_transfer_test_clock_advance_request [Plaid::SandboxTransferTestClockAdvanceRequest?] @return [Tuple(SandboxTransferTestClockAdvanceResponse, Integer, Hash)] SandboxTransferTestClockAdvanceResponse, response status code and response headers
Create a test clock
Use the /sandbox/transfer/test_clock/create
endpoint to create a test_clock
in the Sandbox environment. A test clock object represents an independent timeline and has a virtual_time
field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.
@required @param sandbox_transfer_test_clock_create_request [Plaid::SandboxTransferTestClockCreateRequest?]
@return [SandboxTransferTestClockCreateResponse]
Create a test clock Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers. @required @param sandbox_transfer_test_clock_create_request [Plaid::SandboxTransferTestClockCreateRequest?] @return nil
Create a test clock Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers. @required @param sandbox_transfer_test_clock_create_request [Plaid::SandboxTransferTestClockCreateRequest?] @return [Tuple(SandboxTransferTestClockCreateResponse, Integer, Hash)] SandboxTransferTestClockCreateResponse, response status code and response headers
Get a test clock
Use the /sandbox/transfer/test_clock/get
endpoint to get a test_clock
in the Sandbox environment.
@required @param sandbox_transfer_test_clock_get_request [Plaid::SandboxTransferTestClockGetRequest?]
@return [SandboxTransferTestClockGetResponse]
Get a test clock Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment. @required @param sandbox_transfer_test_clock_get_request [Plaid::SandboxTransferTestClockGetRequest?] @return nil
Get a test clock Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment. @required @param sandbox_transfer_test_clock_get_request [Plaid::SandboxTransferTestClockGetRequest?] @return [Tuple(SandboxTransferTestClockGetResponse, Integer, Hash)] SandboxTransferTestClockGetResponse, response status code and response headers
List test clocks
Use the /sandbox/transfer/test_clock/list
endpoint to see a list of all your test clocks in the Sandbox environment, by ascending virtual_time
. Results are paginated; use the count
and offset
query parameters to retrieve the desired test clocks.
@required @param sandbox_transfer_test_clock_list_request [Plaid::SandboxTransferTestClockListRequest?]
@return [SandboxTransferTestClockListResponse]
List test clocks Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks. @required @param sandbox_transfer_test_clock_list_request [Plaid::SandboxTransferTestClockListRequest?] @return nil
List test clocks Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks. @required @param sandbox_transfer_test_clock_list_request [Plaid::SandboxTransferTestClockListRequest?] @return [Tuple(SandboxTransferTestClockListResponse, Integer, Hash)] SandboxTransferTestClockListResponse, response status code and response headers
Report whether you initiated an ACH transaction
After calling /signal/evaluate
, call /signal/decision/report
to report whether the transaction was initiated.
@required @param signal_decision_report_request [Plaid::SignalDecisionReportRequest?]
@return [SignalDecisionReportResponse]
Report whether you initiated an ACH transaction After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. @required @param signal_decision_report_request [Plaid::SignalDecisionReportRequest?] @return nil
Report whether you initiated an ACH transaction After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. @required @param signal_decision_report_request [Plaid::SignalDecisionReportRequest?] @return [Tuple(SignalDecisionReportResponse, Integer, Hash)] SignalDecisionReportResponse, response status code and response headers
Evaluate a planned ACH transaction
Use /signal/evaluate
to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If /signal/evaluate
is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to the error documentation on Item errors and Link in Update Mode. Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
@required @param signal_evaluate_request [Plaid::SignalEvaluateRequest?]
@return [SignalEvaluateResponse]
Evaluate a planned ACH transaction Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to the error documentation on Item errors and Link in Update Mode. Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. @required @param signal_evaluate_request [Plaid::SignalEvaluateRequest?] @return nil
Evaluate a planned ACH transaction Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to the error documentation on Item errors and Link in Update Mode. Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. @required @param signal_evaluate_request [Plaid::SignalEvaluateRequest?] @return [Tuple(SignalEvaluateResponse, Integer, Hash)] SignalEvaluateResponse, response status code and response headers
Opt-in an Item to Signal
When Link is not initialized with Signal, call /signal/prepare
to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call /signal/prepare
after those product calls are complete. Example flow: Link is initialized with Auth, call /auth/get
for the account and routing number, call /identity/get
to retrieve bank ownership details, then call /signal/prepare
to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call /signal/evaluate
for a Signal score. For more information please see Recommendations for initializing Link with specific product combinations. If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
@required @param signal_prepare_request [Plaid::SignalPrepareRequest?]
@return [SignalPrepareResponse]
Opt-in an Item to Signal When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see Recommendations for initializing Link with specific product combinations. If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item. @required @param signal_prepare_request [Plaid::SignalPrepareRequest?] @return nil
Opt-in an Item to Signal When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see Recommendations for initializing Link with specific product combinations. If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item. @required @param signal_prepare_request [Plaid::SignalPrepareRequest?] @return [Tuple(SignalPrepareResponse, Integer, Hash)] SignalPrepareResponse, response status code and response headers
Report a return for an ACH transaction
Call the /signal/return/report
endpoint to report a returned transaction that was previously sent to the /signal/evaluate
endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
@required @param signal_return_report_request [Plaid::SignalReturnReportRequest?]
@return [SignalReturnReportResponse]
Report a return for an ACH transaction Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. @required @param signal_return_report_request [Plaid::SignalReturnReportRequest?] @return nil
Report a return for an ACH transaction Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. @required @param signal_return_report_request [Plaid::SignalReturnReportRequest?] @return [Tuple(SignalReturnReportResponse, Integer, Hash)] SignalReturnReportResponse, response status code and response headers
Retrieve a single statement.
The /statements/download
endpoint retrieves a single statement PDF in binary format. The response will contain a Plaid-Content-Hash
header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system.
@required @param statements_download_request [Plaid::StatementsDownloadRequest?]
@return [::File]
Retrieve a single statement. The `/statements/download` endpoint retrieves a single statement PDF in binary format. The response will contain a `Plaid-Content-Hash` header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system. @required @param statements_download_request [Plaid::StatementsDownloadRequest?] @return nil
Retrieve a single statement. The `/statements/download` endpoint retrieves a single statement PDF in binary format. The response will contain a `Plaid-Content-Hash` header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system. @required @param statements_download_request [Plaid::StatementsDownloadRequest?] @return [Tuple(::File, Integer, Hash)] ::File, response status code and response headers
Retrieve a list of all statements associated with the provided item.
The /statements/list
endpoint retrieves a list of all statements associated with the provided item.
@required @param statements_list_request [Plaid::StatementsListRequest?]
@return [StatementsListResponse]
Retrieve a list of all statements associated with the provided item. The `/statements/list` endpoint retrieves a list of all statements associated with the provided item. @required @param statements_list_request [Plaid::StatementsListRequest?] @return nil
Retrieve a list of all statements associated with the provided item. The `/statements/list` endpoint retrieves a list of all statements associated with the provided item. @required @param statements_list_request [Plaid::StatementsListRequest?] @return [Tuple(StatementsListResponse, Integer, Hash)] StatementsListResponse, response status code and response headers
enhance locally-held transaction data
The /beta/transactions/v1/enhance
endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
@required @param transactions_enhance_get_request [Plaid::TransactionsEnhanceGetRequest?]
@return [TransactionsEnhanceGetResponse]
enhance locally-held transaction data The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta. @required @param transactions_enhance_get_request [Plaid::TransactionsEnhanceGetRequest?] @return nil
enhance locally-held transaction data The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta. @required @param transactions_enhance_get_request [Plaid::TransactionsEnhanceGetRequest?] @return [Tuple(TransactionsEnhanceGetResponse, Integer, Hash)] TransactionsEnhanceGetResponse, response status code and response headers
Enrich locally-held transaction data
The /transactions/enrich
endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
@required @param transactions_enrich_request [Plaid::TransactionsEnrichRequest?]
@return [TransactionsEnrichResponse]
Enrich locally-held transaction data The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. @required @param transactions_enrich_request [Plaid::TransactionsEnrichRequest?] @return nil
Enrich locally-held transaction data The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. @required @param transactions_enrich_request [Plaid::TransactionsEnrichRequest?] @return [Tuple(TransactionsEnrichResponse, Integer, Hash)] TransactionsEnrichResponse, response status code and response headers
Get transaction data
Note: All new implementations are encouraged to use /transactions/sync
rather than /transactions/get
. /transactions/sync
provides the same functionality as /transactions/get
and improves developer ease-of-use for handling transactions updates. The /transactions/get
endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student
; coverage may be limited). For transaction history from investments accounts, use the Investments endpoint 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. 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
and HISTORICAL_UPDATE
webhooks. If no transaction history is ready when /transactions/get
is called, it will return a PRODUCT_NOT_READY
error.
@required @param transactions_get_request [Plaid::TransactionsGetRequest?]
@return [TransactionsGetResponse]
Get transaction data Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the Investments endpoint 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. 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` and `HISTORICAL_UPDATE` webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. @required @param transactions_get_request [Plaid::TransactionsGetRequest?] @return nil
Get transaction data Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the Investments endpoint 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. 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` and `HISTORICAL_UPDATE` webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. @required @param transactions_get_request [Plaid::TransactionsGetRequest?] @return [Tuple(TransactionsGetResponse, Integer, Hash)] TransactionsGetResponse, response status code and response headers
Fetch recurring transaction streams
The /transactions/recurring/get
endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in /link/token/create
; or after Link, by calling /transactions/get
or /transactions/sync
). Once all historical transactions have been fetched, call /transactions/recurring/get
to receive the Recurring Transactions streams and subscribe to the RECURRING_TRANSACTIONS_UPDATE
webhook. To know when historical transactions have been fetched, if you are using /transactions/sync
listen for the SYNC_UPDATES_AVAILABLE
webhook and check that the historical_update_complete
field in the payload is true
. If using /transactions/get
, listen for the HISTORICAL_UPDATE
webhook. After the initial call, you can call /transactions/recurring/get
endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the RECURRING_TRANSACTIONS_UPDATE
webhook to be notified when new updates are available.
@required @param transactions_recurring_get_request [Plaid::TransactionsRecurringGetRequest?]
@return [TransactionsRecurringGetResponse]
Fetch recurring transaction streams The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the `RECURRING_TRANSACTIONS_UPDATE` webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the `SYNC_UPDATES_AVAILABLE` webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the `HISTORICAL_UPDATE` webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the `RECURRING_TRANSACTIONS_UPDATE` webhook to be notified when new updates are available. @required @param transactions_recurring_get_request [Plaid::TransactionsRecurringGetRequest?] @return nil
Fetch recurring transaction streams The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the `RECURRING_TRANSACTIONS_UPDATE` webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the `SYNC_UPDATES_AVAILABLE` webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the `HISTORICAL_UPDATE` webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the `RECURRING_TRANSACTIONS_UPDATE` webhook to be notified when new updates are available. @required @param transactions_recurring_get_request [Plaid::TransactionsRecurringGetRequest?] @return [Tuple(TransactionsRecurringGetResponse, Integer, Hash)] TransactionsRecurringGetResponse, response status code and response headers
Refresh transaction data
/transactions/refresh
is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling /transactions/refresh
, Plaid will fire a webhook: for /transactions/sync
users, SYNC_UPDATES_AVAILABLE
will be fired if there are any transactions updated, added, or removed. For users of both /transactions/sync
and /transactions/get
, TRANSACTIONS_REMOVED
will be fired if any removed transactions are detected, and DEFAULT_UPDATE
will be fired if any new transactions are detected. New transactions can be fetched by calling /transactions/get
or /transactions/sync
. Note that the /transactions/refresh
endpoint is not supported for Capital One (ins_128026
) and will result in a PRODUCT_NOT_SUPPORTED
error if called on an Item from that institution. /transactions/refresh
is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
@required @param transactions_refresh_request [Plaid::TransactionsRefreshRequest?]
@return [TransactionsRefreshResponse]
Refresh transaction data `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, `SYNC_UPDATES_AVAILABLE` will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, `TRANSACTIONS_REMOVED` will be fired if any removed transactions are detected, and `DEFAULT_UPDATE` will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. `/transactions/refresh` is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param transactions_refresh_request [Plaid::TransactionsRefreshRequest?] @return nil
Refresh transaction data `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, `SYNC_UPDATES_AVAILABLE` will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, `TRANSACTIONS_REMOVED` will be fired if any removed transactions are detected, and `DEFAULT_UPDATE` will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. `/transactions/refresh` is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager. @required @param transactions_refresh_request [Plaid::TransactionsRefreshRequest?] @return [Tuple(TransactionsRefreshResponse, Integer, Hash)] TransactionsRefreshResponse, response status code and response headers
Create transaction category rule
The /transactions/rules/v1/create
endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in /transactions/get
response. The product is currently in beta. To request access, contact [email protected].
@required @param transactions_rules_create_request [Plaid::TransactionsRulesCreateRequest?]
@return [TransactionsRulesCreateResponse]
Create transaction category rule The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact [email protected]. @required @param transactions_rules_create_request [Plaid::TransactionsRulesCreateRequest?] @return nil
Create transaction category rule The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact [email protected]. @required @param transactions_rules_create_request [Plaid::TransactionsRulesCreateRequest?] @return [Tuple(TransactionsRulesCreateResponse, Integer, Hash)] TransactionsRulesCreateResponse, response status code and response headers
Return a list of rules created for the Item associated with the access token.
The /transactions/rules/v1/list
returns a list of transaction rules created for the Item associated with the access token.
@required @param transactions_rules_list_request [Plaid::TransactionsRulesListRequest?]
@return [TransactionsRulesListResponse]
Return a list of rules created for the Item associated with the access token. The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token. @required @param transactions_rules_list_request [Plaid::TransactionsRulesListRequest?] @return nil
Return a list of rules created for the Item associated with the access token. The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token. @required @param transactions_rules_list_request [Plaid::TransactionsRulesListRequest?] @return [Tuple(TransactionsRulesListResponse, Integer, Hash)] TransactionsRulesListResponse, response status code and response headers
Remove transaction rule
The /transactions/rules/v1/remove
endpoint is used to remove a transaction rule.
@required @param transactions_rules_remove_request [Plaid::TransactionsRulesRemoveRequest?]
@return [TransactionsRulesRemoveResponse]
Remove transaction rule The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule. @required @param transactions_rules_remove_request [Plaid::TransactionsRulesRemoveRequest?] @return nil
Remove transaction rule The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule. @required @param transactions_rules_remove_request [Plaid::TransactionsRulesRemoveRequest?] @return [Tuple(TransactionsRulesRemoveResponse, Integer, Hash)] TransactionsRulesRemoveResponse, response status code and response headers
Get incremental transaction updates on an Item
The /transactions/sync
endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. /transactions/sync
provides the same functionality as /transactions/get
and can be used instead of /transactions/get
to simplify the process of tracking transactions updates. To learn more about migrating from /transactions/get
, see the Transactions Sync migration guide. This endpoint provides user-authorized transaction data for credit
, depository
, and some loan-type accounts (only those with account subtype student
; coverage may be limited). For transaction history from investments
accounts, use /investments/transactions/get
instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to /transactions/sync
for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as "adds"), which then generates a next_cursor
for that Item. In subsequent calls, send the next_cursor
to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The has_more
field specifies if additional calls are necessary to fetch all available transaction updates. Call /transactions/sync
with the new cursor, pulling all updates, until has_more
is false
. When retrieving paginated updates, track both the next_cursor
from the latest response and the original cursor from the first call in which has_more
was true
; if a call to /transactions/sync
fails due to the TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION
error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, /transactions/sync
will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's status.transactions.last_successful_update
field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the /transactions/refresh
endpoint. For newly created Items, data may not be immediately available to /transactions/sync
. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the SYNC_UPDATES_AVAILABLE
webhook. /transactions/sync
does not directly return balance data. To get the balance for an account, call /accounts/get
, which is a free-to-use endpoint that will return the cached balance as of the last successful transactions update.
@required @param transactions_sync_request [Plaid::TransactionsSyncRequest?]
@return [TransactionsSyncResponse]
Get incremental transaction updates on an Item The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. To learn more about migrating from `/transactions/get`, see the Transactions Sync migration guide. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as "adds"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails due to the `TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION` error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. For newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the `SYNC_UPDATES_AVAILABLE` webhook. `/transactions/sync` does not directly return balance data. To get the balance for an account, call `/accounts/get`, which is a free-to-use endpoint that will return the cached balance as of the last successful transactions update. @required @param transactions_sync_request [Plaid::TransactionsSyncRequest?] @return nil
Get incremental transaction updates on an Item The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. To learn more about migrating from `/transactions/get`, see the Transactions Sync migration guide. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as "adds"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails due to the `TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION` error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. For newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the `SYNC_UPDATES_AVAILABLE` webhook. `/transactions/sync` does not directly return balance data. To get the balance for an account, call `/accounts/get`, which is a free-to-use endpoint that will return the cached balance as of the last successful transactions update. @required @param transactions_sync_request [Plaid::TransactionsSyncRequest?] @return [Tuple(TransactionsSyncResponse, Integer, Hash)] TransactionsSyncResponse, response status code and response headers
Obtain user insights based on transactions sent through /transactions/enrich
The /beta/transactions/user_insights/v1/get
gets user insights for clients who have enriched data with /transactions/enrich
. The product is currently in beta.
@required @param transactions_user_insights_get_request [Plaid::TransactionsUserInsightsGetRequest?]
@return [TransactionsUserInsightsGetResponse]
Obtain user insights based on transactions sent through /transactions/enrich The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta. @required @param transactions_user_insights_get_request [Plaid::TransactionsUserInsightsGetRequest?] @return nil
Obtain user insights based on transactions sent through /transactions/enrich The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta. @required @param transactions_user_insights_get_request [Plaid::TransactionsUserInsightsGetRequest?] @return [Tuple(TransactionsUserInsightsGetResponse, Integer, Hash)] TransactionsUserInsightsGetResponse, response status code and response headers
Create a transfer authorization
Use the /transfer/authorization/create
endpoint to authorize a transfer. This endpoint must be called prior to calling /transfer/create
. There are three possible outcomes to calling this endpoint: If the authorization.decision
in the response is declined
, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the authorization.decision
is approved
, and the authorization.rationale_code
is null
, the transfer has passed the risk check and you can proceed to call /transfer/create
. If the authorization.decision
is approved
and the authorization.rationale_code
is non-null
, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with null
rationale code, make an authorization request with an amount
less than the available balance in the account. - To approve a transfer with the rationale code MANUALLY_VERIFIED_ITEM
, create an Item in Link through the Same Day Micro-deposits flow. - To approve a transfer with the rationale code ITEM_LOGIN_REQUIRED
, reset the login for an Item. - To decline a transfer with the rationale code NSF
, the available balance on the account must be less than the authorization amount
. See Create Sandbox test data for details on how to customize data in Sandbox. - To decline a transfer with the rationale code RISK
, the available balance on the account must be exactly $0. See Create Sandbox test data for details on how to customize data in Sandbox.
@required @param transfer_authorization_create_request [Plaid::TransferAuthorizationCreateRequest?]
@return [TransferAuthorizationCreateResponse]
Create a transfer authorization Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. There are three possible outcomes to calling this endpoint: If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the Same Day Micro-deposits flow. - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, reset the login for an Item. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See Create Sandbox test data for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See Create Sandbox test data for details on how to customize data in Sandbox. @required @param transfer_authorization_create_request [Plaid::TransferAuthorizationCreateRequest?] @return nil
Create a transfer authorization Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. There are three possible outcomes to calling this endpoint: If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the Same Day Micro-deposits flow. - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, reset the login for an Item. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See Create Sandbox test data for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See Create Sandbox test data for details on how to customize data in Sandbox. @required @param transfer_authorization_create_request [Plaid::TransferAuthorizationCreateRequest?] @return [Tuple(TransferAuthorizationCreateResponse, Integer, Hash)] TransferAuthorizationCreateResponse, response status code and response headers
Retrieve a balance held with Plaid
Use the /transfer/balance/get
endpoint to view a balance held with Plaid.
@required @param transfer_balance_get_request [Plaid::TransferBalanceGetRequest?]
@return [TransferBalanceGetResponse]
Retrieve a balance held with Plaid Use the `/transfer/balance/get` endpoint to view a balance held with Plaid. @required @param transfer_balance_get_request [Plaid::TransferBalanceGetRequest?] @return nil
Retrieve a balance held with Plaid Use the `/transfer/balance/get` endpoint to view a balance held with Plaid. @required @param transfer_balance_get_request [Plaid::TransferBalanceGetRequest?] @return [Tuple(TransferBalanceGetResponse, Integer, Hash)] TransferBalanceGetResponse, response status code and response headers
Cancel a transfer
Use the /transfer/cancel
endpoint to cancel a transfer. A transfer is eligible for cancellation if the cancellable
property returned by /transfer/get
is true
.
@required @param transfer_cancel_request [Plaid::TransferCancelRequest?]
@return [TransferCancelResponse]
Cancel a transfer Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`. @required @param transfer_cancel_request [Plaid::TransferCancelRequest?] @return nil
Cancel a transfer Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`. @required @param transfer_cancel_request [Plaid::TransferCancelRequest?] @return [Tuple(TransferCancelResponse, Integer, Hash)] TransferCancelResponse, response status code and response headers
Get RTP eligibility information of a transfer
Use the /transfer/capabilities/get
endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligibility in Sandbox, log in using the username user_good
and password pass_good
and use the first two checking and savings accounts in the "First Platypus Bank" institution (ending in 0000 or 1111), which will return true
. Any other account will return false
.
@required @param transfer_capabilities_get_request [Plaid::TransferCapabilitiesGetRequest?]
@return [TransferCapabilitiesGetResponse]
Get RTP eligibility information of a transfer Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the "First Platypus Bank" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`. @required @param transfer_capabilities_get_request [Plaid::TransferCapabilitiesGetRequest?] @return nil
Get RTP eligibility information of a transfer Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the "First Platypus Bank" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`. @required @param transfer_capabilities_get_request [Plaid::TransferCapabilitiesGetRequest?] @return [Tuple(TransferCapabilitiesGetResponse, Integer, Hash)] TransferCapabilitiesGetResponse, response status code and response headers
Get transfer product configuration
Use the /transfer/configuration/get
endpoint to view your transfer product configurations.
@required @param transfer_configuration_get_request [Plaid::TransferConfigurationGetRequest?]
@return [TransferConfigurationGetResponse]
Get transfer product configuration Use the `/transfer/configuration/get` endpoint to view your transfer product configurations. @required @param transfer_configuration_get_request [Plaid::TransferConfigurationGetRequest?] @return nil
Get transfer product configuration Use the `/transfer/configuration/get` endpoint to view your transfer product configurations. @required @param transfer_configuration_get_request [Plaid::TransferConfigurationGetRequest?] @return [Tuple(TransferConfigurationGetResponse, Integer, Hash)] TransferConfigurationGetResponse, response status code and response headers
Create a transfer
Use the /transfer/create
endpoint to initiate a new transfer.
@required @param transfer_create_request [Plaid::TransferCreateRequest?]
@return [TransferCreateResponse]
Create a transfer Use the `/transfer/create` endpoint to initiate a new transfer. @required @param transfer_create_request [Plaid::TransferCreateRequest?] @return nil
Create a transfer Use the `/transfer/create` endpoint to initiate a new transfer. @required @param transfer_create_request [Plaid::TransferCreateRequest?] @return [Tuple(TransferCreateResponse, Integer, Hash)] TransferCreateResponse, response status code and response headers
Upload transfer diligence document on behalf of the originator
Third-party sender customers can use /transfer/diligence/document/upload
endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the client_id
in the PLAID-CLIENT-ID
header and secret
in the PLAID-SECRET
header.
@required @param transfer_diligence_document_upload_request [Plaid::TransferDiligenceDocumentUploadRequest?]
@return [TransferDiligenceDocumentUploadResponse]
Upload transfer diligence document on behalf of the originator Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header. @required @param transfer_diligence_document_upload_request [Plaid::TransferDiligenceDocumentUploadRequest?] @return nil
Upload transfer diligence document on behalf of the originator Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header. @required @param transfer_diligence_document_upload_request [Plaid::TransferDiligenceDocumentUploadRequest?] @return [Tuple(TransferDiligenceDocumentUploadResponse, Integer, Hash)] TransferDiligenceDocumentUploadResponse, response status code and response headers
Submit transfer diligence on behalf of the originator
Use the /transfer/diligence/submit
endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
@required @param transfer_diligence_submit_request [Plaid::TransferDiligenceSubmitRequest?]
@return [TransferDiligenceSubmitResponse]
Submit transfer diligence on behalf of the originator Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer). @required @param transfer_diligence_submit_request [Plaid::TransferDiligenceSubmitRequest?] @return nil
Submit transfer diligence on behalf of the originator Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer). @required @param transfer_diligence_submit_request [Plaid::TransferDiligenceSubmitRequest?] @return [Tuple(TransferDiligenceSubmitResponse, Integer, Hash)] TransferDiligenceSubmitResponse, response status code and response headers
List transfer events
Use the /transfer/event/list
endpoint to get a list of transfer events based on specified filter criteria.
@required @param transfer_event_list_request [Plaid::TransferEventListRequest?]
@return [TransferEventListResponse]
List transfer events Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria. @required @param transfer_event_list_request [Plaid::TransferEventListRequest?] @return nil
List transfer events Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria. @required @param transfer_event_list_request [Plaid::TransferEventListRequest?] @return [Tuple(TransferEventListResponse, Integer, Hash)] TransferEventListResponse, response status code and response headers
Sync transfer events
/transfer/event/sync
allows you to request up to the next 25 transfer events that happened after a specific event_id
. Use the /transfer/event/sync
endpoint to guarantee you have seen all transfer events.
@required @param transfer_event_sync_request [Plaid::TransferEventSyncRequest?]
@return [TransferEventSyncResponse]
Sync transfer events `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events. @required @param transfer_event_sync_request [Plaid::TransferEventSyncRequest?] @return nil
Sync transfer events `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events. @required @param transfer_event_sync_request [Plaid::TransferEventSyncRequest?] @return [Tuple(TransferEventSyncResponse, Integer, Hash)] TransferEventSyncResponse, response status code and response headers
Retrieve a transfer
The /transfer/get
endpoint fetches information about the transfer corresponding to the given transfer_id
.
@required @param transfer_get_request [Plaid::TransferGetRequest?]
@return [TransferGetResponse]
Retrieve a transfer The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`. @required @param transfer_get_request [Plaid::TransferGetRequest?] @return nil
Retrieve a transfer The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`. @required @param transfer_get_request [Plaid::TransferGetRequest?] @return [Tuple(TransferGetResponse, Integer, Hash)] TransferGetResponse, response status code and response headers
Create a transfer intent object to invoke the Transfer UI
Use the /transfer/intent/create
endpoint to generate a transfer intent object and invoke the Transfer UI.
@required @param transfer_intent_create_request [Plaid::TransferIntentCreateRequest?]
@return [TransferIntentCreateResponse]
Create a transfer intent object to invoke the Transfer UI Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI. @required @param transfer_intent_create_request [Plaid::TransferIntentCreateRequest?] @return nil
Create a transfer intent object to invoke the Transfer UI Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI. @required @param transfer_intent_create_request [Plaid::TransferIntentCreateRequest?] @return [Tuple(TransferIntentCreateResponse, Integer, Hash)] TransferIntentCreateResponse, response status code and response headers
Retrieve more information about a transfer intent
Use the /transfer/intent/get
endpoint to retrieve more information about a transfer intent.
@required @param transfer_intent_get_request [Plaid::TransferIntentGetRequest?]
@return [TransferIntentGetResponse]
Retrieve more information about a transfer intent Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent. @required @param transfer_intent_get_request [Plaid::TransferIntentGetRequest?] @return nil
Retrieve more information about a transfer intent Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent. @required @param transfer_intent_get_request [Plaid::TransferIntentGetRequest?] @return [Tuple(TransferIntentGetResponse, Integer, Hash)] TransferIntentGetResponse, response status code and response headers
Deposit funds into a Plaid Ledger balance
Use the /transfer/ledger/deposit
endpoint to deposit funds into Plaid Ledger.
@required @param transfer_ledger_deposit_request [Plaid::TransferLedgerDepositRequest?]
@return [TransferLedgerDepositResponse]
Deposit funds into a Plaid Ledger balance Use the `/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger. @required @param transfer_ledger_deposit_request [Plaid::TransferLedgerDepositRequest?] @return nil
Deposit funds into a Plaid Ledger balance Use the `/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger. @required @param transfer_ledger_deposit_request [Plaid::TransferLedgerDepositRequest?] @return [Tuple(TransferLedgerDepositResponse, Integer, Hash)] TransferLedgerDepositResponse, response status code and response headers
Move available balance between the ledgers of the platform and one of its originators
Use the /transfer/ledger/distribute
endpoint to move available balance between the ledgers of the platform and one of its originators.
@required @param transfer_ledger_distribute_request [Plaid::TransferLedgerDistributeRequest?]
@return [TransferLedgerDistributeResponse]
Move available balance between the ledgers of the platform and one of its originators Use the `/transfer/ledger/distribute` endpoint to move available balance between the ledgers of the platform and one of its originators. @required @param transfer_ledger_distribute_request [Plaid::TransferLedgerDistributeRequest?] @return nil
Move available balance between the ledgers of the platform and one of its originators Use the `/transfer/ledger/distribute` endpoint to move available balance between the ledgers of the platform and one of its originators. @required @param transfer_ledger_distribute_request [Plaid::TransferLedgerDistributeRequest?] @return [Tuple(TransferLedgerDistributeResponse, Integer, Hash)] TransferLedgerDistributeResponse, response status code and response headers
Retrieve Plaid Ledger balance
Use the /transfer/ledger/get
endpoint to view a balance on the ledger held with Plaid.
@required @param transfer_ledger_get_request [Plaid::TransferLedgerGetRequest?]
@return [TransferLedgerGetResponse]
Retrieve Plaid Ledger balance Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid. @required @param transfer_ledger_get_request [Plaid::TransferLedgerGetRequest?] @return nil
Retrieve Plaid Ledger balance Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid. @required @param transfer_ledger_get_request [Plaid::TransferLedgerGetRequest?] @return [Tuple(TransferLedgerGetResponse, Integer, Hash)] TransferLedgerGetResponse, response status code and response headers
Withdraw funds from a Plaid Ledger balance
Use the /transfer/ledger/withdraw
endpoint to withdraw funds from a Plaid Ledger balance.
@required @param transfer_ledger_withdraw_request [Plaid::TransferLedgerWithdrawRequest?]
@return [TransferLedgerWithdrawResponse]
Withdraw funds from a Plaid Ledger balance Use the `/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance. @required @param transfer_ledger_withdraw_request [Plaid::TransferLedgerWithdrawRequest?] @return nil
Withdraw funds from a Plaid Ledger balance Use the `/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance. @required @param transfer_ledger_withdraw_request [Plaid::TransferLedgerWithdrawRequest?] @return [Tuple(TransferLedgerWithdrawResponse, Integer, Hash)] TransferLedgerWithdrawResponse, response status code and response headers
List transfers
Use the /transfer/list
endpoint to see a list of all your transfers and their statuses. Results are paginated; use the count
and offset
query parameters to retrieve the desired transfers.
@required @param transfer_list_request [Plaid::TransferListRequest?]
@return [TransferListResponse]
List transfers Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers. @required @param transfer_list_request [Plaid::TransferListRequest?] @return nil
List transfers Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers. @required @param transfer_list_request [Plaid::TransferListRequest?] @return [Tuple(TransferListResponse, Integer, Hash)] TransferListResponse, response status code and response headers
Get transfer product usage metrics
Use the /transfer/metrics/get
endpoint to view your transfer product usage metrics.
@required @param transfer_metrics_get_request [Plaid::TransferMetricsGetRequest?]
@return [TransferMetricsGetResponse]
Get transfer product usage metrics Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics. @required @param transfer_metrics_get_request [Plaid::TransferMetricsGetRequest?] @return nil
Get transfer product usage metrics Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics. @required @param transfer_metrics_get_request [Plaid::TransferMetricsGetRequest?] @return [Tuple(TransferMetricsGetResponse, Integer, Hash)] TransferMetricsGetResponse, response status code and response headers
Migrate account into Transfers
As an alternative to adding Items via Link, you can also use the /transfer/migrate_account
endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as /accounts/balance/get
, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to /transfer/migrate_account
is not enabled by default; to obtain access, contact your Plaid Account Manager.
@required @param transfer_migrate_account_request [Plaid::TransferMigrateAccountRequest?]
@return [TransferMigrateAccountResponse]
Migrate account into Transfers As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager. @required @param transfer_migrate_account_request [Plaid::TransferMigrateAccountRequest?] @return nil
Migrate account into Transfers As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager. @required @param transfer_migrate_account_request [Plaid::TransferMigrateAccountRequest?] @return [Tuple(TransferMigrateAccountResponse, Integer, Hash)] TransferMigrateAccountResponse, response status code and response headers
Create a new originator
Use the /transfer/originator/create
endpoint to create a new originator and return an originator_client_id
.
@required @param transfer_originator_create_request [Plaid::TransferOriginatorCreateRequest?]
@return [TransferOriginatorCreateResponse]
Create a new originator Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`. @required @param transfer_originator_create_request [Plaid::TransferOriginatorCreateRequest?] @return nil
Create a new originator Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`. @required @param transfer_originator_create_request [Plaid::TransferOriginatorCreateRequest?] @return [Tuple(TransferOriginatorCreateResponse, Integer, Hash)] TransferOriginatorCreateResponse, response status code and response headers
Update the funding account associated with the originator
Use the /transfer/originator/funding_account/update
endpoint to update the funding account associated with the originator.
@required @param transfer_originator_funding_account_update_request [Plaid::TransferOriginatorFundingAccountUpdateRequest?]
@return [TransferOriginatorFundingAccountUpdateResponse]
Update the funding account associated with the originator Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator. @required @param transfer_originator_funding_account_update_request [Plaid::TransferOriginatorFundingAccountUpdateRequest?] @return nil
Update the funding account associated with the originator Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator. @required @param transfer_originator_funding_account_update_request [Plaid::TransferOriginatorFundingAccountUpdateRequest?] @return [Tuple(TransferOriginatorFundingAccountUpdateResponse, Integer, Hash)] TransferOriginatorFundingAccountUpdateResponse, response status code and response headers
Get status of an originator's onboarding
The /transfer/originator/get
endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard.
@required @param transfer_originator_get_request [Plaid::TransferOriginatorGetRequest?]
@return [TransferOriginatorGetResponse]
Get status of an originator's onboarding The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard. @required @param transfer_originator_get_request [Plaid::TransferOriginatorGetRequest?] @return nil
Get status of an originator's onboarding The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard. @required @param transfer_originator_get_request [Plaid::TransferOriginatorGetRequest?] @return [Tuple(TransferOriginatorGetResponse, Integer, Hash)] TransferOriginatorGetResponse, response status code and response headers
Get status of all originators' onboarding
The /transfer/originator/list
endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard.
@required @param transfer_originator_list_request [Plaid::TransferOriginatorListRequest?]
@return [TransferOriginatorListResponse]
Get status of all originators' onboarding The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard. @required @param transfer_originator_list_request [Plaid::TransferOriginatorListRequest?] @return nil
Get status of all originators' onboarding The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard. @required @param transfer_originator_list_request [Plaid::TransferOriginatorListRequest?] @return [Tuple(TransferOriginatorListResponse, Integer, Hash)] TransferOriginatorListResponse, response status code and response headers
Generate a Plaid-hosted onboarding UI URL.
The /transfer/questionnaire/create
endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
@required @param transfer_questionnaire_create_request [Plaid::TransferQuestionnaireCreateRequest?]
@return [TransferQuestionnaireCreateResponse]
Generate a Plaid-hosted onboarding UI URL. The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement. @required @param transfer_questionnaire_create_request [Plaid::TransferQuestionnaireCreateRequest?] @return nil
Generate a Plaid-hosted onboarding UI URL. The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement. @required @param transfer_questionnaire_create_request [Plaid::TransferQuestionnaireCreateRequest?] @return [Tuple(TransferQuestionnaireCreateResponse, Integer, Hash)] TransferQuestionnaireCreateResponse, response status code and response headers
Cancel a recurring transfer.
Use the /transfer/recurring/cancel
endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.
@required @param transfer_recurring_cancel_request [Plaid::TransferRecurringCancelRequest?]
@return [TransferRecurringCancelResponse]
Cancel a recurring transfer. Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled. @required @param transfer_recurring_cancel_request [Plaid::TransferRecurringCancelRequest?] @return nil
Cancel a recurring transfer. Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled. @required @param transfer_recurring_cancel_request [Plaid::TransferRecurringCancelRequest?] @return [Tuple(TransferRecurringCancelResponse, Integer, Hash)] TransferRecurringCancelResponse, response status code and response headers
Create a recurring transfer
Use the /transfer/recurring/create
endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers.
@required @param transfer_recurring_create_request [Plaid::TransferRecurringCreateRequest?]
@return [TransferRecurringCreateResponse]
Create a recurring transfer Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers. @required @param transfer_recurring_create_request [Plaid::TransferRecurringCreateRequest?] @return nil
Create a recurring transfer Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers. @required @param transfer_recurring_create_request [Plaid::TransferRecurringCreateRequest?] @return [Tuple(TransferRecurringCreateResponse, Integer, Hash)] TransferRecurringCreateResponse, response status code and response headers
Retrieve a recurring transfer
The /transfer/recurring/get
fetches information about the recurring transfer corresponding to the given recurring_transfer_id
.
@required @param transfer_recurring_get_request [Plaid::TransferRecurringGetRequest?]
@return [TransferRecurringGetResponse]
Retrieve a recurring transfer The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`. @required @param transfer_recurring_get_request [Plaid::TransferRecurringGetRequest?] @return nil
Retrieve a recurring transfer The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`. @required @param transfer_recurring_get_request [Plaid::TransferRecurringGetRequest?] @return [Tuple(TransferRecurringGetResponse, Integer, Hash)] TransferRecurringGetResponse, response status code and response headers
List recurring transfers
Use the /transfer/recurring/list
endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the count
and offset
query parameters to retrieve the desired recurring transfers.
@required @param transfer_recurring_list_request [Plaid::TransferRecurringListRequest?]
@return [TransferRecurringListResponse]
List recurring transfers Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired recurring transfers. @required @param transfer_recurring_list_request [Plaid::TransferRecurringListRequest?] @return nil
List recurring transfers Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired recurring transfers. @required @param transfer_recurring_list_request [Plaid::TransferRecurringListRequest?] @return [Tuple(TransferRecurringListResponse, Integer, Hash)] TransferRecurringListResponse, response status code and response headers
Cancel a refund
Use the /transfer/refund/cancel
endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.
@required @param transfer_refund_cancel_request [Plaid::TransferRefundCancelRequest?]
@return [TransferRefundCancelResponse]
Cancel a refund Use the `/transfer/refund/cancel` endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network. @required @param transfer_refund_cancel_request [Plaid::TransferRefundCancelRequest?] @return nil
Cancel a refund Use the `/transfer/refund/cancel` endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network. @required @param transfer_refund_cancel_request [Plaid::TransferRefundCancelRequest?] @return [Tuple(TransferRefundCancelResponse, Integer, Hash)] TransferRefundCancelResponse, response status code and response headers
Create a refund
Use the /transfer/refund/create
endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 4 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
@required @param transfer_refund_create_request [Plaid::TransferRefundCreateRequest?]
@return [TransferRefundCreateResponse]
Create a refund Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 4 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked. @required @param transfer_refund_create_request [Plaid::TransferRefundCreateRequest?] @return nil
Create a refund Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 4 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked. @required @param transfer_refund_create_request [Plaid::TransferRefundCreateRequest?] @return [Tuple(TransferRefundCreateResponse, Integer, Hash)] TransferRefundCreateResponse, response status code and response headers
Retrieve a refund
The /transfer/refund/get
endpoint fetches information about the refund corresponding to the given refund_id
.
@required @param transfer_refund_get_request [Plaid::TransferRefundGetRequest?]
@return [TransferRefundGetResponse]
Retrieve a refund The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`. @required @param transfer_refund_get_request [Plaid::TransferRefundGetRequest?] @return nil
Retrieve a refund The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`. @required @param transfer_refund_get_request [Plaid::TransferRefundGetRequest?] @return [Tuple(TransferRefundGetResponse, Integer, Hash)] TransferRefundGetResponse, response status code and response headers
Lists historical repayments
The /transfer/repayment/list
endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given start_time
.
@required @param transfer_repayment_list_request [Plaid::TransferRepaymentListRequest?]
@return [TransferRepaymentListResponse]
Lists historical repayments The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`. @required @param transfer_repayment_list_request [Plaid::TransferRepaymentListRequest?] @return nil
Lists historical repayments The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`. @required @param transfer_repayment_list_request [Plaid::TransferRepaymentListRequest?] @return [Tuple(TransferRepaymentListResponse, Integer, Hash)] TransferRepaymentListResponse, response status code and response headers
List the returns included in a repayment
The /transfer/repayment/return/list
endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.
@required @param transfer_repayment_return_list_request [Plaid::TransferRepaymentReturnListRequest?]
@return [TransferRepaymentReturnListResponse]
List the returns included in a repayment The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment. @required @param transfer_repayment_return_list_request [Plaid::TransferRepaymentReturnListRequest?] @return nil
List the returns included in a repayment The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment. @required @param transfer_repayment_return_list_request [Plaid::TransferRepaymentReturnListRequest?] @return [Tuple(TransferRepaymentReturnListResponse, Integer, Hash)] TransferRepaymentReturnListResponse, response status code and response headers
Retrieve a sweep
The /transfer/sweep/get
endpoint fetches a sweep corresponding to the given sweep_id
.
@required @param transfer_sweep_get_request [Plaid::TransferSweepGetRequest?]
@return [TransferSweepGetResponse]
Retrieve a sweep The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`. @required @param transfer_sweep_get_request [Plaid::TransferSweepGetRequest?] @return nil
Retrieve a sweep The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`. @required @param transfer_sweep_get_request [Plaid::TransferSweepGetRequest?] @return [Tuple(TransferSweepGetResponse, Integer, Hash)] TransferSweepGetResponse, response status code and response headers
List sweeps
The /transfer/sweep/list
endpoint fetches sweeps matching the given filters.
@required @param transfer_sweep_list_request [Plaid::TransferSweepListRequest?]
@return [TransferSweepListResponse]
List sweeps The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters. @required @param transfer_sweep_list_request [Plaid::TransferSweepListRequest?] @return nil
List sweeps The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters. @required @param transfer_sweep_list_request [Plaid::TransferSweepListRequest?] @return [Tuple(TransferSweepListResponse, Integer, Hash)] TransferSweepListResponse, response status code and response headers
Create user
This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same client_user_id
, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given client_user_id
. Ensure that you store the user_token
along with your user's identifier in your database, as it is not possible to retrieve a previously created user_token
.
@required @param user_create_request [Plaid::UserCreateRequest?]
@return [UserCreateResponse]
Create user This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`. @required @param user_create_request [Plaid::UserCreateRequest?] @return nil
Create user This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`. @required @param user_create_request [Plaid::UserCreateRequest?] @return [Tuple(UserCreateResponse, Integer, Hash)] UserCreateResponse, response status code and response headers
Update user information
This endpoint is used to update user information associated with an existing user_token
. The user_token
should be in the response of /user/create
call If you call the endpoint with a non-exist user_token
, the call will fail with an error message indicating that the user token is not found.
@required @param user_update_request [Plaid::UserUpdateRequest?]
@return [UserUpdateResponse]
Update user information This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found. @required @param user_update_request [Plaid::UserUpdateRequest?] @return nil
Update user information This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found. @required @param user_update_request [Plaid::UserUpdateRequest?] @return [Tuple(UserUpdateResponse, Integer, Hash)] UserUpdateResponse, response status code and response headers
Create an e-wallet Create an e-wallet. The response is the newly created e-wallet object. @required @param wallet_create_request [Plaid::WalletCreateRequest?] @return [Plaid::WalletCreateResponse]
Create an e-wallet Create an e-wallet. The response is the newly created e-wallet object. @required @param wallet_create_request [Plaid::WalletCreateRequest?] @return nil
Create an e-wallet Create an e-wallet. The response is the newly created e-wallet object. @required @param wallet_create_request [Plaid::WalletCreateRequest?] @return [Tuple(Plaid::WalletCreateResponse, Integer, Hash)] Plaid::WalletCreateResponse, response status code and response headers
Fetch an e-wallet Fetch an e-wallet. The response includes the current balance. @required @param wallet_get_request [Plaid::WalletGetRequest?] @return [Plaid::WalletGetResponse]
Fetch an e-wallet Fetch an e-wallet. The response includes the current balance. @required @param wallet_get_request [Plaid::WalletGetRequest?] @return nil
Fetch an e-wallet Fetch an e-wallet. The response includes the current balance. @required @param wallet_get_request [Plaid::WalletGetRequest?] @return [Tuple(Plaid::WalletGetResponse, Integer, Hash)] Plaid::WalletGetResponse, response status code and response headers
Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation. @required @param wallet_list_request [Plaid::WalletListRequest?] @return [WalletListResponse]
Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation. @required @param wallet_list_request [Plaid::WalletListRequest?] @return nil
Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation. @required @param wallet_list_request [Plaid::WalletListRequest?] @return [Tuple(WalletListResponse, Integer, Hash)] WalletListResponse, response status code and response headers
Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail. @required @param wallet_transaction_execute_request [Plaid::WalletTransactionExecuteRequest?] @return [WalletTransactionExecuteResponse]
Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail. @required @param wallet_transaction_execute_request [Plaid::WalletTransactionExecuteRequest?] @return nil
Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail. @required @param wallet_transaction_execute_request [Plaid::WalletTransactionExecuteRequest?] @return [Tuple(WalletTransactionExecuteResponse, Integer, Hash)] WalletTransactionExecuteResponse, response status code and response headers
Fetch an e-wallet transaction Fetch a specific e-wallet transaction @required @param wallet_transaction_get_request [Plaid::WalletTransactionGetRequest?] @return [Plaid::WalletTransactionGetResponse]
Fetch an e-wallet transaction Fetch a specific e-wallet transaction @required @param wallet_transaction_get_request [Plaid::WalletTransactionGetRequest?] @return nil
Fetch an e-wallet transaction Fetch a specific e-wallet transaction @required @param wallet_transaction_get_request [Plaid::WalletTransactionGetRequest?] @return [Tuple(Plaid::WalletTransactionGetResponse, Integer, Hash)] Plaid::WalletTransactionGetResponse, response status code and response headers
List e-wallet transactions
This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the created_at
time.
@required @param wallet_transaction_list_request [Plaid::WalletTransactionListRequest?]
@return [WalletTransactionListResponse]
List e-wallet transactions This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time. @required @param wallet_transaction_list_request [Plaid::WalletTransactionListRequest?] @return nil
List e-wallet transactions This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time. @required @param wallet_transaction_list_request [Plaid::WalletTransactionListRequest?] @return [Tuple(WalletTransactionListResponse, Integer, Hash)] WalletTransactionListResponse, response status code and response headers
Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time. @required @param watchlist_screening_entity_create_request [Plaid::WatchlistScreeningEntityCreateRequest?] @return [WatchlistScreeningEntityCreateResponse]
Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time. @required @param watchlist_screening_entity_create_request [Plaid::WatchlistScreeningEntityCreateRequest?] @return nil
Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time. @required @param watchlist_screening_entity_create_request [Plaid::WatchlistScreeningEntityCreateRequest?] @return [Tuple(WatchlistScreeningEntityCreateResponse, Integer, Hash)] WatchlistScreeningEntityCreateResponse, response status code and response headers
Get an entity screening Retrieve an entity watchlist screening. @required @param watchlist_screening_entity_get_request [Plaid::WatchlistScreeningEntityGetRequest?] @return [WatchlistScreeningEntityGetResponse]
Get an entity screening Retrieve an entity watchlist screening. @required @param watchlist_screening_entity_get_request [Plaid::WatchlistScreeningEntityGetRequest?] @return nil
Get an entity screening Retrieve an entity watchlist screening. @required @param watchlist_screening_entity_get_request [Plaid::WatchlistScreeningEntityGetRequest?] @return [Tuple(WatchlistScreeningEntityGetResponse, Integer, Hash)] WatchlistScreeningEntityGetResponse, response status code and response headers
List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. @required @param watchlist_screening_entity_history_list_request [Plaid::WatchlistScreeningEntityHistoryListRequest?] @return [WatchlistScreeningEntityHistoryListResponse]
List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. @required @param watchlist_screening_entity_history_list_request [Plaid::WatchlistScreeningEntityHistoryListRequest?] @return nil
List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. @required @param watchlist_screening_entity_history_list_request [Plaid::WatchlistScreeningEntityHistoryListRequest?] @return [Tuple(WatchlistScreeningEntityHistoryListResponse, Integer, Hash)] WatchlistScreeningEntityHistoryListResponse, response status code and response headers
List hits for entity watchlist screenings List all hits for the entity watchlist screening. @required @param watchlist_screening_entity_hit_list_request [Plaid::WatchlistScreeningEntityHitListRequest?] @return [WatchlistScreeningEntityHitListResponse]
List hits for entity watchlist screenings List all hits for the entity watchlist screening. @required @param watchlist_screening_entity_hit_list_request [Plaid::WatchlistScreeningEntityHitListRequest?] @return nil
List hits for entity watchlist screenings List all hits for the entity watchlist screening. @required @param watchlist_screening_entity_hit_list_request [Plaid::WatchlistScreeningEntityHitListRequest?] @return [Tuple(WatchlistScreeningEntityHitListResponse, Integer, Hash)] WatchlistScreeningEntityHitListResponse, response status code and response headers
List entity watchlist screenings List all entity screenings. @required @param watchlist_screening_entity_list_request [Plaid::WatchlistScreeningEntityListRequest?] @return [WatchlistScreeningEntityListResponse]
List entity watchlist screenings List all entity screenings. @required @param watchlist_screening_entity_list_request [Plaid::WatchlistScreeningEntityListRequest?] @return nil
List entity watchlist screenings List all entity screenings. @required @param watchlist_screening_entity_list_request [Plaid::WatchlistScreeningEntityListRequest?] @return [Tuple(WatchlistScreeningEntityListResponse, Integer, Hash)] WatchlistScreeningEntityListResponse, response status code and response headers
Get entity watchlist screening program Get an entity watchlist screening program @required @param watchlist_screening_entity_program_get_request [Plaid::WatchlistScreeningEntityProgramGetRequest?] @return [WatchlistScreeningEntityProgramGetResponse]
Get entity watchlist screening program Get an entity watchlist screening program @required @param watchlist_screening_entity_program_get_request [Plaid::WatchlistScreeningEntityProgramGetRequest?] @return nil
Get entity watchlist screening program Get an entity watchlist screening program @required @param watchlist_screening_entity_program_get_request [Plaid::WatchlistScreeningEntityProgramGetRequest?] @return [Tuple(WatchlistScreeningEntityProgramGetResponse, Integer, Hash)] WatchlistScreeningEntityProgramGetResponse, response status code and response headers
List entity watchlist screening programs List all entity watchlist screening programs @required @param watchlist_screening_entity_program_list_request [Plaid::WatchlistScreeningEntityProgramListRequest?] @return [WatchlistScreeningEntityProgramListResponse]
List entity watchlist screening programs List all entity watchlist screening programs @required @param watchlist_screening_entity_program_list_request [Plaid::WatchlistScreeningEntityProgramListRequest?] @return nil
List entity watchlist screening programs List all entity watchlist screening programs @required @param watchlist_screening_entity_program_list_request [Plaid::WatchlistScreeningEntityProgramListRequest?] @return [Tuple(WatchlistScreeningEntityProgramListResponse, Integer, Hash)] WatchlistScreeningEntityProgramListResponse, response status code and response headers
Create a review for an entity watchlist screening Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_entity_review_create_request [Plaid::WatchlistScreeningEntityReviewCreateRequest?] @return [WatchlistScreeningEntityReviewCreateResponse]
Create a review for an entity watchlist screening Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_entity_review_create_request [Plaid::WatchlistScreeningEntityReviewCreateRequest?] @return nil
Create a review for an entity watchlist screening Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_entity_review_create_request [Plaid::WatchlistScreeningEntityReviewCreateRequest?] @return [Tuple(WatchlistScreeningEntityReviewCreateResponse, Integer, Hash)] WatchlistScreeningEntityReviewCreateResponse, response status code and response headers
List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_entity_review_list_request [Plaid::WatchlistScreeningEntityReviewListRequest?] @return [WatchlistScreeningEntityReviewListResponse]
List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_entity_review_list_request [Plaid::WatchlistScreeningEntityReviewListRequest?] @return nil
List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_entity_review_list_request [Plaid::WatchlistScreeningEntityReviewListRequest?] @return [Tuple(WatchlistScreeningEntityReviewListResponse, Integer, Hash)] WatchlistScreeningEntityReviewListResponse, response status code and response headers
Update an entity screening Update an entity watchlist screening. @required @param watchlist_screening_entity_update_request [Plaid::WatchlistScreeningEntityUpdateRequest?] The entity screening was successfully updated. @return [WatchlistScreeningEntityUpdateResponse]
Update an entity screening Update an entity watchlist screening. @required @param watchlist_screening_entity_update_request [Plaid::WatchlistScreeningEntityUpdateRequest?] The entity screening was successfully updated. @return nil
Update an entity screening Update an entity watchlist screening. @required @param watchlist_screening_entity_update_request [Plaid::WatchlistScreeningEntityUpdateRequest?] The entity screening was successfully updated. @return [Tuple(WatchlistScreeningEntityUpdateResponse, Integer, Hash)] WatchlistScreeningEntityUpdateResponse, response status code and response headers
Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time. @required @param watchlist_screening_individual_create_request [Plaid::WatchlistScreeningIndividualCreateRequest?] @return [WatchlistScreeningIndividualCreateResponse]
Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time. @required @param watchlist_screening_individual_create_request [Plaid::WatchlistScreeningIndividualCreateRequest?] @return nil
Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time. @required @param watchlist_screening_individual_create_request [Plaid::WatchlistScreeningIndividualCreateRequest?] @return [Tuple(WatchlistScreeningIndividualCreateResponse, Integer, Hash)] WatchlistScreeningIndividualCreateResponse, response status code and response headers
Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening @required @param watchlist_screening_individual_get_request [Plaid::WatchlistScreeningIndividualGetRequest?] @return [WatchlistScreeningIndividualGetResponse]
Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening @required @param watchlist_screening_individual_get_request [Plaid::WatchlistScreeningIndividualGetRequest?] @return nil
Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening @required @param watchlist_screening_individual_get_request [Plaid::WatchlistScreeningIndividualGetRequest?] @return [Tuple(WatchlistScreeningIndividualGetResponse, Integer, Hash)] WatchlistScreeningIndividualGetResponse, response status code and response headers
List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. @required @param watchlist_screening_individual_history_list_request [Plaid::WatchlistScreeningIndividualHistoryListRequest?] @return [WatchlistScreeningIndividualHistoryListResponse]
List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. @required @param watchlist_screening_individual_history_list_request [Plaid::WatchlistScreeningIndividualHistoryListRequest?] @return nil
List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. @required @param watchlist_screening_individual_history_list_request [Plaid::WatchlistScreeningIndividualHistoryListRequest?] @return [Tuple(WatchlistScreeningIndividualHistoryListResponse, Integer, Hash)] WatchlistScreeningIndividualHistoryListResponse, response status code and response headers
List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening. @required @param watchlist_screening_individual_hit_list_request [Plaid::WatchlistScreeningIndividualHitListRequest?] @return [WatchlistScreeningIndividualHitListResponse]
List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening. @required @param watchlist_screening_individual_hit_list_request [Plaid::WatchlistScreeningIndividualHitListRequest?] @return nil
List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening. @required @param watchlist_screening_individual_hit_list_request [Plaid::WatchlistScreeningIndividualHitListRequest?] @return [Tuple(WatchlistScreeningIndividualHitListResponse, Integer, Hash)] WatchlistScreeningIndividualHitListResponse, response status code and response headers
List Individual Watchlist Screenings List previously created watchlist screenings for individuals @required @param watchlist_screening_individual_list_request [Plaid::WatchlistScreeningIndividualListRequest?] @return [WatchlistScreeningIndividualListResponse]
List Individual Watchlist Screenings List previously created watchlist screenings for individuals @required @param watchlist_screening_individual_list_request [Plaid::WatchlistScreeningIndividualListRequest?] @return nil
List Individual Watchlist Screenings List previously created watchlist screenings for individuals @required @param watchlist_screening_individual_list_request [Plaid::WatchlistScreeningIndividualListRequest?] @return [Tuple(WatchlistScreeningIndividualListResponse, Integer, Hash)] WatchlistScreeningIndividualListResponse, response status code and response headers
Get individual watchlist screening program Get an individual watchlist screening program @required @param watchlist_screening_individual_program_get_request [Plaid::WatchlistScreeningIndividualProgramGetRequest?] @return [WatchlistScreeningIndividualProgramGetResponse]
Get individual watchlist screening program Get an individual watchlist screening program @required @param watchlist_screening_individual_program_get_request [Plaid::WatchlistScreeningIndividualProgramGetRequest?] @return nil
Get individual watchlist screening program Get an individual watchlist screening program @required @param watchlist_screening_individual_program_get_request [Plaid::WatchlistScreeningIndividualProgramGetRequest?] @return [Tuple(WatchlistScreeningIndividualProgramGetResponse, Integer, Hash)] WatchlistScreeningIndividualProgramGetResponse, response status code and response headers
List individual watchlist screening programs List all individual watchlist screening programs @required @param watchlist_screening_individual_program_list_request [Plaid::WatchlistScreeningIndividualProgramListRequest?] @return [WatchlistScreeningIndividualProgramListResponse]
List individual watchlist screening programs List all individual watchlist screening programs @required @param watchlist_screening_individual_program_list_request [Plaid::WatchlistScreeningIndividualProgramListRequest?] @return nil
List individual watchlist screening programs List all individual watchlist screening programs @required @param watchlist_screening_individual_program_list_request [Plaid::WatchlistScreeningIndividualProgramListRequest?] @return [Tuple(WatchlistScreeningIndividualProgramListResponse, Integer, Hash)] WatchlistScreeningIndividualProgramListResponse, response status code and response headers
Create a review for an individual watchlist screening Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_individual_review_create_request [Plaid::WatchlistScreeningIndividualReviewCreateRequest?] @return [WatchlistScreeningIndividualReviewCreateResponse]
Create a review for an individual watchlist screening Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_individual_review_create_request [Plaid::WatchlistScreeningIndividualReviewCreateRequest?] @return nil
Create a review for an individual watchlist screening Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. @required @param watchlist_screening_individual_review_create_request [Plaid::WatchlistScreeningIndividualReviewCreateRequest?] @return [Tuple(WatchlistScreeningIndividualReviewCreateResponse, Integer, Hash)] WatchlistScreeningIndividualReviewCreateResponse, response status code and response headers
List reviews for individual watchlist screenings List all reviews for the individual watchlist screening. @required @param watchlist_screening_individual_review_list_request [Plaid::WatchlistScreeningIndividualReviewListRequest?] @return [WatchlistScreeningIndividualReviewListResponse]
List reviews for individual watchlist screenings List all reviews for the individual watchlist screening. @required @param watchlist_screening_individual_review_list_request [Plaid::WatchlistScreeningIndividualReviewListRequest?] @return nil
List reviews for individual watchlist screenings List all reviews for the individual watchlist screening. @required @param watchlist_screening_individual_review_list_request [Plaid::WatchlistScreeningIndividualReviewListRequest?] @return [Tuple(WatchlistScreeningIndividualReviewListResponse, Integer, Hash)] WatchlistScreeningIndividualReviewListResponse, response status code and response headers
Update individual watchlist screening
Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update search_terms
and status
at the same time since editing search_terms
may trigger an automatic status
change.
@required @param watchlist_screening_individual_update_request [Plaid::WatchlistScreeningIndividualUpdateRequest?]
@return [WatchlistScreeningIndividualUpdateResponse]
Update individual watchlist screening Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update `search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change. @required @param watchlist_screening_individual_update_request [Plaid::WatchlistScreeningIndividualUpdateRequest?] @return nil
Update individual watchlist screening Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update `search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change. @required @param watchlist_screening_individual_update_request [Plaid::WatchlistScreeningIndividualUpdateRequest?] @return [Tuple(WatchlistScreeningIndividualUpdateResponse, Integer, Hash)] WatchlistScreeningIndividualUpdateResponse, response status code and response headers
Get webhook verification key
Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the Plaid-Verification
header. The /webhook_verification_key/get
endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
@required @param webhook_verification_key_get_request [Plaid::WebhookVerificationKeyGetRequest?]
@return [WebhookVerificationKeyGetResponse]
Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT. @required @param webhook_verification_key_get_request [Plaid::WebhookVerificationKeyGetRequest?] @return nil
Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT. @required @param webhook_verification_key_get_request [Plaid::WebhookVerificationKeyGetRequest?] @return [Tuple(WebhookVerificationKeyGetResponse, Integer, Hash)] WebhookVerificationKeyGetResponse, response status code and response headers