Class: ThePlaidApi::PlaidApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/the_plaid_api/apis/plaid_api.rb

Overview

PlaidApi

Constant Summary

Constants inherited from BaseApi

BaseApi::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from ThePlaidApi::BaseApi

Instance Method Details

#accounts_balance_get(body) ⇒ ApiResponse

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, `/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. Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use `/signal/evaluate` instead of `/accounts/balance/get`. `/signal/evaluate` returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the [Balance documentation](/docs/balance/#balance-integration-options). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2495

def accounts_balance_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/accounts/balance/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AccountsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#accounts_get(body) ⇒ ApiResponse

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. To return new accounts that were created after the user linked their Item, you can listen for the [`NEW_ACCOUNTS_AVAILABLE`](plaid.com/docs/api/items/#new_accounts_ available) webhook and then use Link’s [update mode](plaid.com/docs/link/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 endpoints `/accounts/balance/get` or `/signal/evaluate` instead. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2284

def accounts_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/accounts/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AccountsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#application_get(body) ⇒ ApiResponse

Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1291

def application_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/application/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ApplicationGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#asset_report_audit_copy_create(body) ⇒ ApiResponse

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 the GSEs on your behalf if you participate in Fannie Mae’s Day 1 Certainty™ program or utilize Freddie Mac’s Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). 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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 257

def asset_report_audit_copy_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/audit_copy/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportAuditCopyCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_audit_copy_get(body) ⇒ ApiResponse

‘/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/get`. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 287

def asset_report_audit_copy_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/audit_copy/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_audit_copy_pdf_get(body) ⇒ ApiResponse

The ‘/asset_report/audit_copy/pdf/get` endpoint retrieves an Asset Report Audit Copy in PDF format. The caller must provide the `audit_copy_token` that was shared via the `/asset_report/audit_copy/create` endpoint. The response to `/asset_report/audit_copy/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](plaid.com/documents/sample-asset-report.pdf). type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 318

def asset_report_audit_copy_pdf_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/audit_copy/pdf/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_audit_copy_remove(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 348

def asset_report_audit_copy_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/audit_copy/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportAuditCopyRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_create(body) ⇒ ApiResponse

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](plaid.com/docs/api/products/assets/#webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 27

def asset_report_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_filter(body) ⇒ ApiResponse

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`](plaid.com/docs/api/products/assets/#product_read y) webhook once generation of the filtered Asset Report has completed. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 187

def asset_report_filter(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/filter',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportFilterResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_get(body) ⇒ ApiResponse

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`](plaid.com/docs/api/products/assets/#product_read y) 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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 72

def asset_report_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_pdf_get(body) ⇒ ApiResponse

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`](plaid.com/docs/api/products/assets/#product_read y) 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](plaid.com/documents/sample-asset-report.pdf). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 106

def asset_report_pdf_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/pdf/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_refresh(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 142

def asset_report_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#asset_report_remove(body) ⇒ ApiResponse

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 access to 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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 221

def asset_report_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/asset_report/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#auth_get(body) ⇒ ApiResponse

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, savings, and cash management accounts, along with high-level account data and balances when available. 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](plaid.com/docs/api/versioning/#version-2018-05-22). here

Parameters:

  • body (AuthGetRequest) —

    Required parameter: TODO: type description

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1468

def auth_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/auth/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AuthGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Default error',
                             ErrorErrorException))
    .execute
end

#auth_verify(body) ⇒ ApiResponse

The ‘/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid’s database via [Database Auth](plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact Sales or your Plaid account manager to request access. here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1498

def auth_verify(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/auth/verify',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AuthVerifyResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Default error',
                             ErrorErrorException))
    .execute
end

#bank_transfer_balance_get(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7058

def bank_transfer_balance_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/balance/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferBalanceGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_cancel(body) ⇒ ApiResponse

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`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6779

def bank_transfer_cancel(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/cancel',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferCancelResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_create(body) ⇒ ApiResponse

Use the ‘/bank_transfer/create` endpoint to initiate a new bank transfer. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6616

def bank_transfer_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_event_list(body) ⇒ ApiResponse

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](plaid.com/docs/auth/coverage/microdeposit-events/). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6861

def bank_transfer_event_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/event/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferEventListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_event_sync(body) ⇒ ApiResponse

‘/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](plaid.com/docs/auth/coverage/microdeposit-events/). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6919

def bank_transfer_event_sync(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/event/sync',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferEventSyncResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_get(body) ⇒ ApiResponse

The ‘/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6175

def bank_transfer_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_list(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6698

def bank_transfer_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_migrate_account(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7090

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/migrate_account',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferMigrateAccountResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_sweep_get(body) ⇒ ApiResponse

The ‘/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6971

def bank_transfer_sweep_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/sweep/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferSweepGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#bank_transfer_sweep_list(body) ⇒ ApiResponse

The ‘/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7023

def bank_transfer_sweep_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/bank_transfer/sweep/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BankTransferSweepListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#beacon_account_risk_evaluate(body) ⇒ ApiResponse

Use ‘/beacon/account_risk/v1/evaluate` to get risk insights for a linked account. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3273

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/account_risk/v1/evaluate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconAccountRiskEvaluateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#beacon_duplicate_get(body) ⇒ ApiResponse

Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are returned for each Duplicate record in either the ‘beacon_user1` or `beacon_user2` response fields. The `analysis` field in the response indicates which fields matched between `beacon_user1` and `beacon_user2`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3572

def beacon_duplicate_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/duplicate/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconDuplicateGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_report_create(body) ⇒ ApiResponse

Create a fraud report for a given Beacon User. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3400

def beacon_report_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/report/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconReportCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_report_get(body) ⇒ ApiResponse

Returns a Beacon report for a given Beacon report id. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3481

def beacon_report_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/report/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconReportGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_report_list(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3429

def beacon_report_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/report/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconReportListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_report_syndication_get(body) ⇒ ApiResponse

Returns a Beacon Report Syndication for a given Beacon Report Syndication id. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3504

def beacon_report_syndication_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/report_syndication/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconReportSyndicationGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_report_syndication_list(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3459

def beacon_report_syndication_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/report_syndication/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconReportSyndicationListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_user_account_insights_get(body) ⇒ ApiResponse

Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3641

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/user/account_insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconUserAccountInsightsGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_user_create(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3313

def beacon_user_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/user/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconUserCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_user_get(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3337

def beacon_user_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/user/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconUserGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_user_history_list(body) ⇒ ApiResponse

List all changes to the Beacon User in reverse-chronological order. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3617

def beacon_user_history_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/user/history/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconUserHistoryListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_user_review(body) ⇒ ApiResponse

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

  1. 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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3378

def beacon_user_review(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/user/review',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconUserGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beacon_user_update(body) ⇒ ApiResponse

Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to ‘/beacon/user/create`, several checks are performed immediately when you submit an identity data change to `/beacon/user/update`:

- The user's updated PII 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 updated 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. Plaid maintains a version history for each Beacon User, so the Beacon User’s identity data before and after the update is retained as separate versions. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3544

def beacon_user_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beacon/user/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BeaconUserUpdateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#beta_ewa_report_v1_get(body) ⇒ ApiResponse

The ‘/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 1–99 Interpretation: Higher scores indicate a greater likelihood of repayment. This endpoint enables clients to assess repayment risk and make data-driven decisions when determining eligibility or limits for earned wage advances. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9514

def beta_ewa_report_v1_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/ewa_report/v1/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BetaEwaReportV1GetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#beta_partner_customer_v1_create(body) ⇒ ApiResponse

The ‘/beta/partner/customer/v1/create` endpoint creates a new end customer record. You can provide as much information as you have available. If any required information is missing for the products you intend to use, it will be listed in the `requirements_due` field of the response. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9849

def beta_partner_customer_v1_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/partner/customer/v1/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BetaPartnerCustomerV1CreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#beta_partner_customer_v1_enable(body) ⇒ ApiResponse

The ‘/beta/partner/customer/v1/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9927

def beta_partner_customer_v1_enable(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/partner/customer/v1/enable',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BetaPartnerCustomerV1EnableResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#beta_partner_customer_v1_get(body) ⇒ ApiResponse

The ‘/beta/partner/customer/v1/get` endpoint is used by reseller partners to retrieve data about a single end customer. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9875

def beta_partner_customer_v1_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/partner/customer/v1/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BetaPartnerCustomerV1GetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#beta_partner_customer_v1_update(body) ⇒ ApiResponse

The ‘/beta/partner/customer/v1/update` endpoint updates an existing end customer record. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9901

def beta_partner_customer_v1_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/partner/customer/v1/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BetaPartnerCustomerV1UpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#business_verification_create(body) ⇒ ApiResponse

Create a new business verification to check a business’s identity and risk profile. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3813

def business_verification_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/business_verification/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BusinessVerificationCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#business_verification_get(body) ⇒ ApiResponse

Retrieve the current state of a specific business verification. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3790

def business_verification_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/business_verification/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(BusinessVerificationGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#cashflow_report_get(body) ⇒ ApiResponse

The ‘/cashflow_report/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. 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](plaid.com/docs/transactions/transactions-data/#pendi ng-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn’t likely to be immediately available to ‘/cashflow_report/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn’t, upon the first call to ‘/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1744

def cashflow_report_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cashflow_report/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CashflowReportGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cashflow_report_insights_get(body) ⇒ ApiResponse

The ‘/cashflow_report/insights/get` endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1815

def cashflow_report_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cashflow_report/insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CashflowReportInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cashflow_report_refresh(body) ⇒ ApiResponse

‘/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an `item_id`). The item must already have Cashflow Report added as a product in order to call `/cashflow_report/refresh`. After calling `/cashflow_report/refresh`, Plaid will fire a webhook `CASHFLOW_REPORT_READY` alerting clients that new transactions data can then be ingested via `/cashflow_report/get` or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the `/cashflow_report/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. 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 up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1700

def cashflow_report_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cashflow_report/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CashflowReportRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cashflow_report_transactions_get(body) ⇒ ApiResponse

The ‘/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. 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](plaid.com/docs/transactions/transactions-data/#pendi ng-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn’t likely to be immediately available to ‘/cashflow_report/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn’t, upon the first call to ‘/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1788

def cashflow_report_transactions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cashflow_report/transactions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CashflowReportTransactionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#categories_get(body) ⇒ ApiResponse

Send a request to the ‘/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to [use the newer `personal_finance_category` taxonomy](plaid.com/docs/transactions/pfc-migration/) instead of the legacy `category` taxonomy supported by this endpoint.

Parameters:

  • body (Object) —

    Required parameter: TODO: type description here

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2314

def categories_get(body)
  warn 'Endpoint categories_get in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/categories/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(APIHelper.method(:json_serialize)))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CategoriesGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#consent_events_get(body) ⇒ ApiResponse

List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Extremely recent events (occurring within the past 12 hours) may not be available via this endpoint. Up to three years of consent logs will be available via the endpoint. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1154

def consent_events_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/consent/events/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ConsentEventsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#consumer_report_pdf_get(body) ⇒ ApiResponse

Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The ‘request_id` is returned in the `Plaid-Request-ID` header. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 958

def consumer_report_pdf_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/consumer_report/pdf/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_base_report_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after you’ve received a ‘CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling ‘/cra/check_report/create`. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 558

def cra_check_report_base_report_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/base_report/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportBaseReportGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_cashflow_insights_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you’ve received a ‘CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_cashflow_insights` product or have generated a report using `/cra/check_report/create`, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 689

def cra_check_report_cashflow_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/cashflow_insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportCashflowInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_create(body) ⇒ ApiResponse

Use ‘/cra/check_report/create` to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the report before it expires. If a report expires, you can call `/cra/check_report/create` again to re-generate it and refresh the data in the report. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 615

def cra_check_report_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_income_insights_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you’ve received a ‘CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is “II2”. Please see [this document](docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_ L_nJeCuMe7Keip4/edit?tab=t.0#heading=h.rudamzinus2i) for guidance on migrating to II2 if you are currently using the II1 version, and [this section](docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L _nJeCuMe7Keip4/edit?tab=t.0#bookmark=id.tdcc2wpk0h60) for an example II1 response along with its [documentation](docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74h oXZNY_L_nJeCuMe7Keip4/edit?tab=t.36c85n2ircqk#heading=h.79dwr5c1iszl). TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 525

def cra_check_report_income_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/income_insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportIncomeInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_lend_score_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you’ve received a ‘CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_lend_score` product or call `/cra/check_report/create` with the `cra_lend_score` product, Plaid will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 726

def cra_check_report_lend_score_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/lend_score/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportLendScoreGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_network_insights_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you’ve received a ‘CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_network_attributes` product or have generated a report using `/cra/check_report/create`, Plaid will generate the attributes when you call this endpoint. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 761

def cra_check_report_network_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/network_insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportNetworkInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_partner_insights_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you’ve received a ‘CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 652

def cra_check_report_partner_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/partner_insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportPartnerInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_pdf_get(body) ⇒ ApiResponse

‘/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Partner Insights or Income Insights report be included in the PDF as well, use the `add-ons` field. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 587

def cra_check_report_pdf_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/pdf/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_verification_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that ‘cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you’ve received a ‘CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.“ TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 796

def cra_check_report_verification_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/verification/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraCheckReportVerificationGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_check_report_verification_pdf_get(body) ⇒ ApiResponse

The ‘/cra/check_report/verification/pdf/get` endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you’ve created a VOA report through Link or the ‘/cra/check_report/create` endpoint, and have received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook. The response to `/cra/check_report/verification/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 828

def cra_check_report_verification_pdf_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/check_report/verification/pdf/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_loans_applications_register(body) ⇒ ApiResponse

‘/cra/loans/applications/register` registers loan applications and decisions. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 853

def cra_loans_applications_register(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/loans/applications/register',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraLoansApplicationsRegisterResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_loans_register(body) ⇒ ApiResponse

‘/cra/loans/register` registers a list of loans to their applicants. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 878

def cra_loans_register(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/loans/register',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraLoansRegisterResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_loans_unregister(body) ⇒ ApiResponse

‘/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 930

def cra_loans_unregister(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/loans/unregister',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraLoanUnregisterResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_loans_update(body) ⇒ ApiResponse

‘/cra/loans/update` updates loan information such as the status and payment history. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 904

def cra_loans_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/loans/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraLoansUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_monitoring_insights_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve a Cash Flow Updates report by passing in the ‘user_id` referred to in the webhook you received. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 428

def cra_monitoring_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/monitoring_insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraMonitoringInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_monitoring_insights_subscribe(body) ⇒ ApiResponse

This endpoint allows you to subscribe to insights for a user’s linked CRA Item, which are updated between one and four times per day (best-effort). In the current Cash Flow Updates beta experience, only one Item per user may be subscribed for monitoring updates. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 376

def cra_monitoring_insights_subscribe(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/monitoring_insights/subscribe',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraMonitoringInsightsSubscribeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_monitoring_insights_unsubscribe(body) ⇒ ApiResponse

This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 402

def cra_monitoring_insights_unsubscribe(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/monitoring_insights/unsubscribe',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraMonitoringInsightsUnsubscribeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#cra_partner_insights_get(body) ⇒ ApiResponse

‘/cra/partner_insights/get` returns cash flow insights for a specified user. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 483

def cra_partner_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/cra/partner_insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CraPartnerInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#create_payment_token(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4850

def create_payment_token(body)
  warn 'Endpoint create_payment_token in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/payment/token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationPaymentTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_asset_report_freddie_mac_get(body) ⇒ ApiResponse

The ‘credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac’s JSON format. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8341

def credit_asset_report_freddie_mac_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/asset_report/freddie_mac/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportFreddieGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_audit_copy_token_create(body) ⇒ ApiResponse

Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government Sponsored Entity (GSE) if you participate in Fannie Mae’s Day 1 Certainty™ program or utilize Freddie Mac’s Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). 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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8285

def credit_audit_copy_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/audit_copy_token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditAuditCopyTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_audit_copy_token_update(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 457

def credit_audit_copy_token_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/audit_copy_token/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditAuditCopyTokenUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_bank_employment_get(body) ⇒ ApiResponse

‘/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8393

def credit_bank_employment_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/credit/v1/bank_employment/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditBankEmploymentGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_bank_income_get(body) ⇒ ApiResponse

‘/credit/bank_income/get` returns the bank income report(s) for a specified user. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](plaid.com/docs/link/multi-item-link). To return older reports, use the `options.count` field. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8423

def credit_bank_income_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/bank_income/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditBankIncomeGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_bank_income_pdf_get(body) ⇒ ApiResponse

‘/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](plaid.com/docs/link/multi-item-link). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8452

def credit_bank_income_pdf_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/bank_income/pdf/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_bank_income_refresh(body) ⇒ ApiResponse

‘/credit/bank_income/refresh` refreshes the most recent bank income report data for a specific user. If the most recent bank income report is no longer valid (i.e. deleted), the endpoint will refresh the most recent valid report instead. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8479

def credit_bank_income_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/bank_income/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditBankIncomeRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_bank_income_webhook_update(body) ⇒ ApiResponse

‘/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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8509

def credit_bank_income_webhook_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/bank_income/webhook/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditBankIncomeWebhookUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_bank_statements_uploads_get(body) ⇒ ApiResponse

‘/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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8563

def credit_bank_statements_uploads_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/bank_statements/uploads/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditBankStatementsUploadsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#credit_employment_get(body) ⇒ ApiResponse

‘/credit/employment/get` returns a list of items with employment information from a user’s payroll provider that was verified by an end user. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8701

def credit_employment_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/employment/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditEmploymentGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_freddie_mac_reports_get(body) ⇒ ApiResponse

The ‘credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8367

def credit_freddie_mac_reports_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/freddie_mac/reports/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditFreddieMacReportsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_payroll_income_get(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8590

def credit_payroll_income_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/payroll_income/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditPayrollIncomeGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_payroll_income_parsing_config_update(body) ⇒ ApiResponse

‘/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8535

def credit_payroll_income_parsing_config_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/payroll_income/parsing_config/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditPayrollIncomeParsingConfigUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_payroll_income_precheck(body) ⇒ ApiResponse

‘/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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8673

def credit_payroll_income_precheck(body)
  warn 'Endpoint credit_payroll_income_precheck in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/payroll_income/precheck',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditPayrollIncomePrecheckResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_payroll_income_refresh(body) ⇒ ApiResponse

‘/credit/payroll_income/refresh` refreshes a given digital payroll income verification. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8727

def credit_payroll_income_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/payroll_income/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditPayrollIncomeRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#credit_payroll_income_risk_signals_get(body) ⇒ ApiResponse

‘/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 `risk_signals`, 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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8630

def credit_payroll_income_risk_signals_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/payroll_income/risk_signals/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditPayrollIncomeRiskSignalsGetReponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_relay_create(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8760

def credit_relay_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/relay/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditRelayCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_relay_get(body) ⇒ ApiResponse

‘/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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8787

def credit_relay_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/relay/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AssetReportGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_relay_pdf_get(body) ⇒ ApiResponse

‘/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`](plaid.com/docs/api/products/assets/#product_read y) 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](plaid.com/documents/sample-asset-report.pdf). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8823

def credit_relay_pdf_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/relay/pdf/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_relay_refresh(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8851

def credit_relay_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/relay/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditRelayRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_relay_remove(body) ⇒ ApiResponse

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`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8881

def credit_relay_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/relay/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditRelayRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_report_audit_copy_remove(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8315

def credit_report_audit_copy_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/audit_copy_token/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditAuditCopyTokenRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#credit_sessions_get(body) ⇒ ApiResponse

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). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5530

def credit_sessions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/credit/sessions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(CreditSessionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#dashboard_user_get(body) ⇒ ApiResponse

The ‘/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2658

def dashboard_user_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/dashboard_user/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(DashboardUserGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#dashboard_user_list(body) ⇒ ApiResponse

The ‘/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2683

def dashboard_user_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/dashboard_user/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(DashboardUserListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#employers_search(body) ⇒ ApiResponse

‘/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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8049

def employers_search(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/employers/search',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(EmployersSearchResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#employment_verification_get(body) ⇒ ApiResponse

‘/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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8252

def employment_verification_get(body)
  warn 'Endpoint employment_verification_get in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/employment/verification/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(EmploymentVerificationGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#fdx_notifications(body) ⇒ ApiResponse

A generic webhook receiver endpoint for FDX Event Notifications description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 10003

def fdx_notifications(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/fdx/notifications',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .is_response_void(true)
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#get_recipient(recipient_id, oauth_state_id: nil) ⇒ ApiResponse

Get a specific recipient Uniquely identifies the recipient passed into the OAuth URI ‘state’ query parameter.

Parameters:

  • recipient_id (String) —

    Required parameter: Recipient Identifier.

  • oauth_state_id (String) (defaults to: nil) —

    Optional parameter: The value that is

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 10047

def get_recipient(recipient_id,
                  oauth_state_id: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/fdx/recipient/{recipientId}',
                                 Server::DEFAULT)
               .template_param(new_parameter(recipient_id, key: 'recipientId')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter(oauth_state_id, key: 'OAUTH-STATE-ID'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(FdxRecipientMetadata.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#get_recipients ⇒ ApiResponse

Returns a list of Recipients

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 10024

def get_recipients
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/fdx/recipients',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(GetRecipientsResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#identity_documents_uploads_get(body) ⇒ ApiResponse

Use ‘/identity/documents/uploads/get` to retrieve identity details when using [Identity Document Upload](plaid.com/docs/identity/identity-document-upload/). type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2555

def identity_documents_uploads_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity/documents/uploads/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityDocumentsUploadsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#identity_get(body) ⇒ ApiResponse

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. 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](plaid.com/docs/api/versioning/#version-2019-05-29). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2528

def identity_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#identity_match(body) ⇒ ApiResponse

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` or `/signal/evaluate` for real-time data. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2586

def identity_match(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity/match',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityMatchResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#identity_refresh(body) ⇒ ApiResponse

‘/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 for any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook [`DEFAULT_UPDATE`](plaid.com/docs/api/products/identity/#default_u pdate). 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. `/identity/refresh` is offered as an add-on to Identity and has a separate [fee model](plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](dashboard.plaid.com/team/products) or contact your Plaid account manager. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2629

def identity_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#identity_verification_autofill_create(body) ⇒ ApiResponse

Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3595

def identity_verification_autofill_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity_verification/autofill/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityVerificationAutofillCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#identity_verification_create(body) ⇒ ApiResponse

Create a new Identity Verification for the user specified by the ‘client_user_id` and/or `user_id` field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the `template_id` provided. If `user_id` is provided, there must be an associated user otherwise an error will be returned. If you don’t know whether an active Identity Verification exists for a given ‘client_user_id` and/or `user_id`, 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/or `user_id`, and `template_id`. If an Identity Verification is found, it will be returned unmodified with a `200 OK` HTTP status code. If `user_id` is not provided, 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. If `user_id` is provided, user information can not be included in the request body. Please use the `/user/update` endpoint to update user data instead. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2722

def identity_verification_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity_verification/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityVerificationCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#identity_verification_get(body) ⇒ ApiResponse

Retrieve a previously created Identity Verification. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2744

def identity_verification_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity_verification/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityVerificationGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#identity_verification_list(body) ⇒ ApiResponse

Filter and list Identity Verifications created by your account type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2766

def identity_verification_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity_verification/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityVerificationListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#identity_verification_retry(body) ⇒ ApiResponse

Allow a customer to retry their Identity Verification type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2788

def identity_verification_retry(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/identity_verification/retry',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IdentityVerificationRetryResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#income_verification_create(body) ⇒ ApiResponse

‘/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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8081

def income_verification_create(body)
  warn 'Endpoint income_verification_create in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/income/verification/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IncomeVerificationCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#income_verification_documents_download(body) ⇒ ApiResponse

‘/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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8150

def income_verification_documents_download(body)
  warn 'Endpoint income_verification_documents_download in PlaidApi is dep'\
       'recated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/income/verification/documents/download',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:dynamic_deserializer))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#income_verification_paystubs_get(body) ⇒ ApiResponse

‘/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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8114

def income_verification_paystubs_get(body)
  warn 'Endpoint income_verification_paystubs_get in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/income/verification/paystubs/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IncomeVerificationPaystubsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#income_verification_precheck(body) ⇒ ApiResponse

‘/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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8223

def income_verification_precheck(body)
  warn 'Endpoint income_verification_precheck in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/income/verification/precheck',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IncomeVerificationPrecheckResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#income_verification_taxforms_get(body) ⇒ ApiResponse

‘/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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8183

def income_verification_taxforms_get(body)
  warn 'Endpoint income_verification_taxforms_get in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/income/verification/taxforms/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IncomeVerificationTaxformsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#institutions_get(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2067

def institutions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/institutions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(InstitutionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#institutions_get_by_id(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2128

def institutions_get_by_id(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/institutions/get_by_id',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(InstitutionsGetByIdResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#institutions_search(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2098

def institutions_search(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/institutions/search',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(InstitutionsSearchResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#investments_auth_get(body) ⇒ ApiResponse

The ‘/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5749

def investments_auth_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/investments/auth/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(InvestmentsAuthGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#investments_holdings_get(body) ⇒ ApiResponse

The ‘/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5623

def investments_holdings_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/investments/holdings/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(InvestmentsHoldingsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#investments_refresh(body) ⇒ ApiResponse

‘/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](plaid.com/docs/api/products/investments/#holdings -default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](plaid.com/docs/api/products/investments/#investme nts_transactions-default_update) if any new investment transactions are detected. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call `/sandbox/item/fire_webhook`. 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. 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. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](dashboard.plaid.com/team/products) or contact your Plaid account manager. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5723

def investments_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/investments/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(InvestmentsRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#investments_transactions_get(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5668

def investments_transactions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/investments/transactions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(InvestmentsTransactionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#issues_get(body) ⇒ ApiResponse

Retrieve detailed information about a specific ‘Issue`. This endpoint returns a single `Issue` object. here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9569

def issues_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/issues/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IssuesGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#issues_search(body) ⇒ ApiResponse

Search for an issue associated with one of the following identifiers: ‘item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list of `Issue` objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9543

def issues_search(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/issues/search',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IssuesSearchResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#issues_subscribe(body) ⇒ ApiResponse

Allows a user to subscribe to updates on a specific ‘Issue` using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9596

def issues_subscribe(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/issues/subscribe',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(IssuesSubscribeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#item_access_token_invalidate(body) ⇒ ApiResponse

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`. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4580

def item_access_token_invalidate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/access_token/invalidate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemAccessTokenInvalidateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#item_activity_list(body) ⇒ ApiResponse

List a historical log of user consent events description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1179

def item_activity_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/activity/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemActivityListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_application_list(body) ⇒ ApiResponse

List a user’s connected applications description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1204

def item_application_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/application/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemApplicationListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_application_scopes_update(body) ⇒ ApiResponse

Enable consumers to update product access on selected accounts for an application. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1265

def item_application_scopes_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/application/scopes/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemApplicationScopesUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_application_unlink(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1239

def item_application_unlink(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/application/unlink',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemApplicationUnlinkResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_create_public_token(body) ⇒ ApiResponse

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](plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is not used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](plaid.com/docs/quickstart) for more information. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5133

def item_create_public_token(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/public_token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemPublicTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#item_get(body) ⇒ ApiResponse

Returns information about the status of an Item. here

Parameters:

  • body (ItemGetRequest) —

    Required parameter: TODO: type description

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1316

def item_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_handle_fraud_report(body) ⇒ ApiResponse

Use this endpoint to create a fraud report and terminate the associated Item. The ‘access_token` associated with the Item will be deactivated and billing for the Item’s products will be ended. This endpoint allows you to report various types of fraud incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2240

def item_handle_fraud_report(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/handle_fraud_report',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemHandleFraudReportResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_import(body) ⇒ ApiResponse

‘/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. here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5965

def item_import(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/import',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemImportResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#item_products_terminate(body) ⇒ ApiResponse

The ‘/item/products/terminate` endpoint allows you to terminate an Item. Once terminated, the `access_token` associated with the Item is no longer valid, billing for the Item’s products is ended, and relevant webhooks are fired. ‘/item/products/terminate` is the recommended way to offboard users or disconnect accounts linked via Plaid. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2204

def item_products_terminate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/products/terminate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemProductsTerminateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_public_token_exchange(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5092

def item_public_token_exchange(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/public_token/exchange',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemPublicTokenExchangeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#item_remove(body) ⇒ ApiResponse

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. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [my.plaid.com/](https://my.plaid.com/)). For more details, see [Subscription fee model](plaid.com/docs/account/billing/#subscription-fee). On a Trial plan, calling `/item/remove` does not impact the number of remaining Trial Items (bank connections) you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. 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. here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2174

def item_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#item_webhook_update(body) ⇒ ApiResponse

The POST ‘/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](plaid.com/docs/api/items/#webhook_ update_acknowledged) webhook to the newly specified webhook URL. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4551

def item_webhook_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/item/webhook/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ItemWebhookUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#liabilities_get(body) ⇒ ApiResponse

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](plaid.com/docs/api/link/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4647

def liabilities_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/liabilities/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(LiabilitiesGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#link_delivery_create(body) ⇒ ApiResponse

Use the ‘/link_delivery/create` endpoint to create a Hosted Link session. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9952

def link_delivery_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/link_delivery/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(LinkDeliveryCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#link_delivery_get(body) ⇒ ApiResponse

Use the ‘/link_delivery/get` endpoint to get the status of a Hosted Link session. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9978

def link_delivery_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/link_delivery/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(LinkDeliveryGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#link_oauth_correlation_id_exchange(body) ⇒ ApiResponse

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`. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6068

def link_oauth_correlation_id_exchange(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/link/oauth/correlation_id/exchange',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(LinkOauthCorrelationIdExchangeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#link_token_create(body) ⇒ ApiResponse

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`. For most Plaid products, the `public_token` is saved and exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. For more details, see the [Link flow overview](plaid.com/docs/link/#link-flow-overview). A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the [update mode](plaid.com/docs/link/update-mode) flow for tokens with expired credentials, or the Identity Verification flow. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6000

def link_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/link/token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(LinkTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#link_token_get(body) ⇒ ApiResponse

The ‘/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don’t provide a public token via frontend callbacks, such as the [Hosted Link flow](plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes. By default, this endpoint will only return complete event data for Hosted Link sessions. To use ‘/link/token/get` to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the `SESSION_FINISHED` and `EVENTS` webhook. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6038

def link_token_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/link/token/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(LinkTokenGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#network_insights_report_get(body) ⇒ ApiResponse

This endpoint allows you to retrieve the Network Insights from a list of ‘access_tokens`. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 10074

def network_insights_report_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/network_insights/report/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(NetworkInsightsReportGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#network_status_get(body) ⇒ ApiResponse

The ‘/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. To access this endpoint, contact your Plaid Account Manager. Note: it is strongly recommended to check for Layer eligibility in the frontend. `/network/status/get` should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](plaid.com/docs/layer/#integration-overview). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1436

def network_status_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/network/status/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(NetworkStatusGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#oauth_introspect(body) ⇒ ApiResponse

‘/oauth/introspect` returns metadata about an access token or refresh token. Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1016

def oauth_introspect(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/oauth/introspect',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(OauthIntrospectResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             OauthErrorResponseException))
    .execute
end

#oauth_revoke(body) ⇒ ApiResponse

‘/oauth/revoke` revokes an access or refresh token, preventing any further use. If a refresh token is revoked, all access and refresh tokens derived from it are also revoked, including exchanged tokens. Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1047

def oauth_revoke(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/oauth/revoke',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(OauthRevokeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             OauthErrorResponseException))
    .execute
end

#oauth_token(body) ⇒ ApiResponse

‘/oauth/token` issues an access token and refresh token depending on the `grant_type` provided. This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification. here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 986

def oauth_token(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/oauth/token',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(OauthTokenResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             OauthErrorResponseException))
    .execute
end

#partner_customer_create(body) ⇒ ApiResponse

The ‘/partner/customer/create` endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9710

def partner_customer_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/partner/customer/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PartnerCustomerCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#partner_customer_enable(body) ⇒ ApiResponse

The ‘/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9762

def partner_customer_enable(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/partner/customer/enable',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PartnerCustomerEnableResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#partner_customer_get(body) ⇒ ApiResponse

The ‘/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9736

def partner_customer_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/partner/customer/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PartnerCustomerGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#partner_customer_oauth_institutions_get(body) ⇒ ApiResponse

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](plaid.com/docs/account/resellers/#enabling-end-cust omers). parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9821

def partner_customer_oauth_institutions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/partner/customer/oauth_institutions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PartnerCustomerOauthInstitutionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#partner_customer_remove(body) ⇒ ApiResponse

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 full Production. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9791

def partner_customer_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/partner/customer/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PartnerCustomerRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_consent_create(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4881

def payment_initiation_consent_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/consent/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationConsentCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_consent_get(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4908

def payment_initiation_consent_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/consent/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationConsentGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_consent_payment_execute(body) ⇒ ApiResponse

The ‘/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4961

def payment_initiation_consent_payment_execute(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/consent/payment/execute',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationConsentPaymentExecuteResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_consent_revoke(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4935

def payment_initiation_consent_revoke(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/consent/revoke',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationConsentRevokeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_payment_create(body) ⇒ ApiResponse

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](plaid.com/docs/api/products/payment-initiation/#payment _initiation-payment-create-request-amount-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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4814

def payment_initiation_payment_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/payment/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationPaymentCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_payment_get(body) ⇒ ApiResponse

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. Polling for status updates in Production is highly discouraged. Repeatedly calling `/payment_initiation/payment/get` to check a payment’s status is unreliable and may trigger API rate limits. Only the ‘payment_status_update` webhook should be used to receive real-time status updates in Production. 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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5569

def payment_initiation_payment_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/payment/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationPaymentGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_payment_list(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5597

def payment_initiation_payment_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/payment/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationPaymentListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_payment_reverse(body) ⇒ ApiResponse

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. Providing counterparty information such as date of birth and address increases the likelihood of refund being successful without human intervention. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4714

def payment_initiation_payment_reverse(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/payment/reverse',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationPaymentReverseResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_recipient_create(body) ⇒ ApiResponse

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](plaid.com/global) 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`. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4679

def payment_initiation_recipient_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/recipient/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationRecipientCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_recipient_get(body) ⇒ ApiResponse

Get details about a payment recipient you have previously created. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4739

def payment_initiation_recipient_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/recipient/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationRecipientGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_initiation_recipient_list(body) ⇒ ApiResponse

The ‘/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4765

def payment_initiation_recipient_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_initiation/recipient/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentInitiationRecipientListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_profile_create(body) ⇒ ApiResponse

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`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9626

def payment_profile_create(body)
  warn 'Endpoint payment_profile_create in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_profile/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentProfileCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_profile_get(body) ⇒ ApiResponse

Use ‘/payment_profile/get` endpoint to get the status of a given Payment Profile. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9653

def payment_profile_get(body)
  warn 'Endpoint payment_profile_get in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_profile/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentProfileGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#payment_profile_remove(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9680

def payment_profile_remove(body)
  warn 'Endpoint payment_profile_remove in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/payment_profile/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(PaymentProfileRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_account_get(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3872

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/account/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorAccountGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_apex_processor_token_create(body) ⇒ ApiResponse

Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5932

def processor_apex_processor_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/apex/processor_token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_auth_get(body) ⇒ ApiResponse

The ‘/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking, savings, or cash management 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](plaid.com/docs/api/versioning/#version-2020-09-14). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3843

def processor_auth_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/auth/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorAuthGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_balance_get(body) ⇒ ApiResponse

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. `/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`.

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4523

def processor_balance_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/balance/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorBalanceGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_bank_transfer_create(body) ⇒ ApiResponse

Use the ‘/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4393

def processor_bank_transfer_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/bank_transfer/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorBankTransferCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_identity_get(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4458

def processor_identity_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/identity/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorIdentityGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_identity_match(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4489

def processor_identity_match(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/identity/match',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorIdentityMatchResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_investments_auth_get(body) ⇒ ApiResponse

The ‘/processor/investments/auth/get` endpoint allows you to retrieve information about the account authorized by a processor token, including account numbers, account owners, holdings, and data provenance information. To receive Investments Auth webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](plaid.com/docs/api/processor-p artners/#processortokenwebhookupdate) endpoint. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3930

def processor_investments_auth_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/investments/auth/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorInvestmentsAuthGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_investments_holdings_get(body) ⇒ ApiResponse

This endpoint returns the stock position data of the account associated with a given processor token. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3898

def processor_investments_holdings_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/investments/holdings/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorInvestmentsHoldingsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_investments_transactions_get(body) ⇒ ApiResponse

The ‘/processor/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for the investment account associated with the processor token. 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 the account, 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 `/processor/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/processor/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 `/processor/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 `/processor/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Investments Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](plaid.com/docs/api/processor-p artners/#processortokenwebhookupdate) endpoint. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3981

def processor_investments_transactions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/investments/transactions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorInvestmentsTransactionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_liabilities_get(body) ⇒ ApiResponse

The ‘/processor/liabilities/get` endpoint returns various details about a loan or credit account. 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`. 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 `/processor/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the processor token. This is because Plaid must communicate directly with the institution to retrieve the additional data. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4431

def processor_liabilities_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/liabilities/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorLiabilitiesGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_signal_decision_report(body) ⇒ ApiResponse

After you call ‘/processor/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/processor/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/processor/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/processor/signal/decision/report` again for the transaction to correct Plaid’s records. If you are using Plaid Transfer as your payment processor, you also do not need to call ‘/processor/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4304

def processor_signal_decision_report(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/signal/decision/report',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorSignalDecisionReportResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#processor_signal_evaluate(body) ⇒ ApiResponse

Use ‘/processor/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. `/processor/signal/evaluate` uses Rulesets that are configured on the end customer’s Dashboard and can be used with either the Signal Transaction Scores product or the Balance product. Which product is used will be determined by the ‘ruleset_key` that you provide. Note that only customer-configured rulesets work with this endpoint; as a processor partner, you cannot create or configure your own rulesets. For more details, see [Signal Rules](plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency if Signal Transaction Scores is being added to an existing Item for the first time, or when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4262

def processor_signal_evaluate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/signal/evaluate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorSignalEvaluateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#processor_signal_prepare(body) ⇒ ApiResponse

When a processor token is not initialized with ‘signal`, call `/processor/signal/prepare` to opt-in that processor token to the data collection process, which will improve the accuracy of the Signal Transaction 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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4367

def processor_signal_prepare(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/signal/prepare',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorSignalPrepareResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#processor_signal_return_report(body) ⇒ ApiResponse

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. If you are using the [Plaid Transfer product](plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4336

def processor_signal_return_report(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/signal/return/report',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorSignalReturnReportResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#processor_stripe_bank_account_token_create(body) ⇒ ApiResponse

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](plaid.com/docs/auth/partnerships/stripe/). 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`. To revoke a bank account token, the entire underlying access token must be revoked using `/item/remove`. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5906

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/stripe/bank_account_token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorStripeBankAccountTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_token_create(body) ⇒ ApiResponse

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. If using multiple processors, multiple different processor tokens can be created for a single access token. Once created, a processor token for a given Item can be modified by calling `/processor/token/permissions/set`. To revoke the processor’s access, the entire Item must be deleted by calling ‘/item/remove`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5781

def processor_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_token_permissions_get(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5838

def processor_token_permissions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/token/permissions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTokenPermissionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_token_permissions_set(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5812

def processor_token_permissions_set(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/token/permissions/set',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTokenPermissionsSetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_token_webhook_update(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5865

def processor_token_webhook_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/token/webhook/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTokenWebhookUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_transactions_get(body) ⇒ ApiResponse

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](plaid.com/docs/transactions/transactions-data/#pendi ng-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`](plaid.com/docs/api/processor-p artners/#processortokenwebhookupdate) endpoint. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4040

def processor_transactions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/transactions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTransactionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_transactions_recurring_get(body) ⇒ ApiResponse

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](dashboard.plaid.com/team/products) 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`](plaid.com/docs/api/products/tran sactions/#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`](plaid.com/docs/api/products/transaction s/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](plaid.com/docs/api/products/transactions/#hi storical_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`](plaid.com/docs/api/products/tran sactions/#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`](plaid.com/docs/api/processor-p artners/#processortokenwebhookupdate) endpoint. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4225

def processor_transactions_recurring_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/transactions/recurring/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTransactionsRecurringGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_transactions_refresh(body) ⇒ ApiResponse

‘/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 one or more times per 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`](plaid.com/docs/api/products/transaction s/#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`](plaid.com/docs/api/products/transactions/ #transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](plaid.com/docs/api/products/transactions/#defau lt_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 `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. 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. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](dashboard.plaid.com/team/products) or contact your Plaid account manager. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4162

def processor_transactions_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/transactions/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTransactionsRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#processor_transactions_sync(body) ⇒ ApiResponse

The ‘/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. 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 (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](plaid.com/docs/er rors/transactions/#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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](plaid.com/docs/account/activity/#troubleshooting-with-it em-debugger) or call `/item/get`; the `item.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 `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](plaid.com/docs/api/products/transaction s/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](plaid.com/docs/api/processor-p artners/#processortokenwebhookupdate) endpoint. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4105

def processor_transactions_sync(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/processor/transactions/sync',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProcessorTransactionsSyncResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#profile_network_status_get(body) ⇒ ApiResponse

The ‘/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1402

def profile_network_status_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/profile/network_status/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProfileNetworkStatusGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#protect_compute(body) ⇒ ApiResponse

Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes. For link-session models, if the Link session is not yet complete, the endpoint returns HTTP 400 with ‘error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3722

def protect_compute(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/protect/compute',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProtectComputeResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#protect_event_get(body) ⇒ ApiResponse

Get information about a user event including Trust Index score and fraud attributes. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3768

def protect_event_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/protect/event/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProtectEventGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#protect_event_send(body) ⇒ ApiResponse

Send a new event to enrich user data and optionally get a Trust Index score for the event. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3745

def protect_event_send(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/protect/event/send',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProtectEventSendResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#protect_report_create(body) ⇒ ApiResponse

Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3696

def protect_report_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/protect/report/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProtectReportCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#protect_user_insights_get(body) ⇒ ApiResponse

Use this endpoint to get basic information about a user as it relates to their fraud profile with Protect. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3664

def protect_user_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/protect/user/insights/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProtectUserInsightsGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#sandbox_bank_income_fire_webhook(body) ⇒ ApiResponse

Use the ‘/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8959

def sandbox_bank_income_fire_webhook(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/bank_income/fire_webhook',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxBankIncomeFireWebhookResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_bank_transfer_fire_webhook(body) ⇒ ApiResponse

Use the ‘/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8907

def sandbox_bank_transfer_fire_webhook(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/bank_transfer/fire_webhook',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxBankTransferFireWebhookResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_bank_transfer_simulate(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7602

def sandbox_bank_transfer_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/bank_transfer/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxBankTransferSimulateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_cra_cashflow_updates_update(body) ⇒ ApiResponse

Use the ‘/sandbox/cra/cashflow_updates/update` endpoint to manually trigger an update for Cash Flow Updates (Monitoring) in the Sandbox environment. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8986

def sandbox_cra_cashflow_updates_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/cra/cashflow_updates/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxCraCashflowUpdatesUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_income_fire_webhook(body) ⇒ ApiResponse

Use the ‘/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8933

def sandbox_income_fire_webhook(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/income/fire_webhook',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxIncomeFireWebhookResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_item_fire_webhook(body) ⇒ ApiResponse

The ‘/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid Sandbox `DEFAULT_UPDATE` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `PENDING_DISCONNECT`: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. `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. `USER_PERMISSION_REVOKED`: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions’ consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. `USER_ACCOUNT_REVOKED`: Fired when an end user has revoked access to their account on the Data Provider’s portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. 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 (except for webhooks of type ‘TRANSFER`). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2449

def sandbox_item_fire_webhook(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/item/fire_webhook',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxItemFireWebhookResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#sandbox_item_reset_login(body) ⇒ ApiResponse

‘/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](plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling ‘/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4995

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/item/reset_login',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxItemResetLoginResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_item_set_verification_status(body) ⇒ ApiResponse

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. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](plaid.com/docs/auth/coverage/testing#). TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5025

def sandbox_item_set_verification_status(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/item/set_verification_status',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxItemSetVerificationStatusResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_oauth_select_accounts(body) ⇒ ApiResponse

Save the selected accounts when connecting to the Platypus Oauth institution type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9012

def sandbox_oauth_select_accounts(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/oauth/select_accounts',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:json_deserialize))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#sandbox_payment_profile_reset_login(body) ⇒ ApiResponse

‘/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](plaid.com/docs/transfer/add-to-app/#create-a-payment-prof ile-optional) and [go through the Link flow](plaid.com/docs/transfer/add-to-app/#create-a-link-token). TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7986

def (body)
  warn 'Endpoint sandbox_payment_profile_reset_login in PlaidApi is deprec'\
       'ated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/payment_profile/reset_login',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxPaymentProfileResetLoginResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_payment_simulate(body) ⇒ ApiResponse

Use the ‘/sandbox/payment/simulate` endpoint to simulate various payment events in the Sandbox environment. This endpoint will trigger the corresponding payment status webhook. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 8015

def sandbox_payment_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/payment/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxPaymentSimulateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#sandbox_processor_token_create(body) ⇒ ApiResponse

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](plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2345

def sandbox_processor_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/processor_token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxProcessorTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#sandbox_public_token_create(body) ⇒ ApiResponse

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](plaid.com/docs/sandbox/user-custom) to generate a test account with custom data, or with Plaid’s [pre-populated Sandbox test accounts](plaid.com/docs/sandbox/test-credentials/). type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2378

def sandbox_public_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/public_token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxPublicTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#sandbox_transactions_create(body) ⇒ ApiResponse

Use the ‘/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1657

def sandbox_transactions_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transactions/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransactionsCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Invalid request',
                             ErrorErrorException)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_fire_webhook(body) ⇒ ApiResponse

Use the ‘/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7824

def sandbox_transfer_fire_webhook(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/fire_webhook',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferFireWebhookResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_ledger_deposit_simulate(body) ⇒ ApiResponse

Use the ‘/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7744

def sandbox_transfer_ledger_deposit_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/ledger/deposit/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferLedgerDepositSimulateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_ledger_simulate_available(body) ⇒ ApiResponse

Use the ‘/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7718

def sandbox_transfer_ledger_simulate_available(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/ledger/simulate_available',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferLedgerSimulateAvailableResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_ledger_withdraw_simulate(body) ⇒ ApiResponse

Use the ‘/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7770

def sandbox_transfer_ledger_withdraw_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/ledger/withdraw/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferLedgerWithdrawSimulateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_refund_simulate(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7691

def sandbox_transfer_refund_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/refund/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferRefundSimulateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_repayment_simulate(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7798

def sandbox_transfer_repayment_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/repayment/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferSimulateResponse1.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_simulate(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7661

def sandbox_transfer_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferSimulateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_sweep_simulate(body) ⇒ ApiResponse

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`. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7632

def sandbox_transfer_sweep_simulate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/sweep/simulate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferSweepSimulateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_test_clock_advance(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7897

def sandbox_transfer_test_clock_advance(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/test_clock/advance',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferTestClockAdvanceResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_test_clock_create(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7854

def sandbox_transfer_test_clock_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/test_clock/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferTestClockCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_test_clock_get(body) ⇒ ApiResponse

Use the ‘/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7923

def sandbox_transfer_test_clock_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/test_clock/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferTestClockGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_transfer_test_clock_list(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7951

def sandbox_transfer_test_clock_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/transfer/test_clock/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxTransferTestClockListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#sandbox_user_reset_login(body) ⇒ ApiResponse

‘/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each 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](plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling ‘/sandbox/user/reset_login`, You can then use Plaid Link update mode to restore Items associated with the User 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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5060

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/sandbox/user/reset_login',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SandboxUserResetLoginResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#session_token_create(body) ⇒ ApiResponse

‘/session/token/create` is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](plaid.com/docs/link/#link-flow-overview). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6096

def session_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/session/token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SessionTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#signal_decision_report(body) ⇒ ApiResponse

After you call ‘/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/signal/decision/report` again for the transaction to correct Plaid’s records. If you are using Plaid Transfer as your payment processor, you also do not need to call ‘/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9117

def signal_decision_report(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/signal/decision/report',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SignalDecisionReportResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#signal_evaluate(body) ⇒ ApiResponse

Use ‘/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using `/signal/evaluate`, you must first [create a ruleset](plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal->Rules**](dashboard.plaid.com/signal/risk-profiles). `/signal/evaluate` can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. Balance-only rulesets may have latency of up to 30 seconds or more; if you encounter errors, you may find it necessary to adjust your timeout period when making requests. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9050

def signal_evaluate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/signal/evaluate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SignalEvaluateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#signal_prepare(body) ⇒ ApiResponse

When an Item is not initialized with ‘signal`, call `/signal/prepare` to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where `signal` was added in the `additional_consented_products` array but not in the `products`, `optional_products`, or `required_if_supported_products` array. If `/signal/prepare` is skipped on an Item that is not initialized with `signal`, the initial call to `/signal/evaluate` on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score. If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score. If run on an Item that is already initialized with `signal`, this endpoint will return a 200 response and will not modify the Item. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9186

def signal_prepare(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/signal/prepare',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SignalPrepareResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#signal_return_report(body) ⇒ ApiResponse

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 trends into your scores and tune rule logic. If using a Balance-only ruleset, this endpoint will not impact scores (as Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9148

def signal_return_report(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/signal/return/report',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SignalReturnReportResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#signal_schedule(body) ⇒ ApiResponse

Use ‘/signal/schedule` to schedule a planned ACH transaction. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9075

def signal_schedule(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/signal/schedule',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SignalScheduleResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#statements_download(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1102

def statements_download(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/statements/download',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#statements_list(body) ⇒ ApiResponse

The ‘/statements/list` endpoint retrieves a list of all statements associated with an item. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1073

def statements_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/statements/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(StatementsListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#statements_refresh(body) ⇒ ApiResponse

‘/statements/refresh` initiates an on-demand extraction to fetch the statements for the provided dates. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1125

def statements_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/statements/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(StatementsRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_enhance(body) ⇒ ApiResponse

The ‘/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9369

def transactions_enhance(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/transactions/v1/enhance',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsEnhanceGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_enrich(body) ⇒ ApiResponse

The ‘/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1965

def transactions_enrich(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transactions/enrich',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsEnrichResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_get(body) ⇒ ApiResponse

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](plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](plaid.com/docs/transactions/transactions-data/#pendi ng-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. To find out when the Item was last updated, use the [Item Debugger](plaid.com/docs/account/activity/#troubleshooting-with-it em-debugger) or call `/item/get`; the `item.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`](plaid.com/docs/api/products/transactions/#initi al_update) and [`HISTORICAL_UPDATE`](plaid.com/docs/api/products/transactions/#hi storical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1567

def transactions_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transactions/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_recurring_get(body) ⇒ ApiResponse

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](dashboard.plaid.com/team/products) 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`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](plaid.com/docs/api/link/#link-token-create-requ est-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](plaid.com/docs/api/products/tran sactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](plaid.com/docs/api/products/transaction s/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](plaid.com/docs/api/products/transactions/#hi storical_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`](plaid.com/docs/api/products/tran sactions/#recurring_transactions_update) webhook to be notified when new updates are available. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1877

def transactions_recurring_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transactions/recurring/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsRecurringGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_refresh(body) ⇒ ApiResponse

‘/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call `/transactions/refresh`. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](plaid.com/docs/api/products/transaction s/#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`](plaid.com/docs/api/products/transactions/ #transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](plaid.com/docs/api/products/transactions/#defau lt_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`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. 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. `/transactions/refresh` is offered as an optional add-on to Transactions and has a separate [fee model](plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](dashboard.plaid.com/team/products) or contact your Plaid account manager. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1626

def transactions_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transactions/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_rules_create(body) ⇒ ApiResponse

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 transactions-feedback@plaid.com. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9399

def transactions_rules_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/transactions/rules/v1/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsRulesCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_rules_list(body) ⇒ ApiResponse

The ‘/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9425

def transactions_rules_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/transactions/rules/v1/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsRulesListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_rules_remove(body) ⇒ ApiResponse

The ‘/transactions/rules/v1/remove` endpoint is used to remove a transaction rule. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9451

def transactions_rules_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/transactions/rules/v1/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsRulesRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_sync(body) ⇒ ApiResponse

The ‘/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. 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 when retrieving a paginated update (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](plaid.com/docs/er rors/transactions/#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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](plaid.com/docs/account/activity/#troubleshooting-with-it em-debugger) or call `/item/get`; the `item.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. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](plaid.com/docs/api/products/transaction s/#sync_updates_available) webhook. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1938

def transactions_sync(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transactions/sync',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsSyncResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transactions_user_insights_get(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9478

def transactions_user_insights_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/beta/transactions/user_insights/v1/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransactionsUserInsightsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_authorization_cancel(body) ⇒ ApiResponse

Use the ‘/transfer/authorization/cancel` endpoint to cancel a transfer authorization. A transfer authorization is eligible for cancellation if it has not yet been used to create a transfer. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6270

def transfer_authorization_cancel(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/authorization/cancel',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferAuthorizationCancelResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_authorization_create(body) ⇒ ApiResponse

Use the ‘/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four 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 `user_action_required`, additional

user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling ‘/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](plaid.com/docs/api/link/#link-token- create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization.

- 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](plaid.com/docs/auth/coverage/testing/#testing-same-day-micro -deposits).

- To get an authorization decision of `user_action_required`, [reset the

login for an Item](plaid.com/docs/sandbox/#item_login_required).

- 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](plaid.com/docs/sandbox/user-custom/) 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](plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6243

def transfer_authorization_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/authorization/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferAuthorizationCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_balance_get(body) ⇒ ApiResponse

(Deprecated) Use the ‘/transfer/balance/get` endpoint to view a balance held with Plaid. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6296

def transfer_balance_get(body)
  warn 'Endpoint transfer_balance_get in PlaidApi is deprecated'
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/balance/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferBalanceGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_cancel(body) ⇒ ApiResponse

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`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6725

def transfer_cancel(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/cancel',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferCancelResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_capabilities_get(body) ⇒ ApiResponse

Use the ‘/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by `/transfer/migrate_account`. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6325

def transfer_capabilities_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/capabilities/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferCapabilitiesGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_configuration_get(body) ⇒ ApiResponse

Use the ‘/transfer/configuration/get` endpoint to view your transfer product configurations. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6351

def transfer_configuration_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/configuration/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferConfigurationGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_create(body) ⇒ ApiResponse

Use the ‘/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `transfer_id` has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](plaid.com/docs/transfer/reconciling-transfers/). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6564

def transfer_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_diligence_document_upload(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7372

def transfer_diligence_document_upload(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/diligence/document/upload',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferDiligenceDocumentUploadResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_diligence_submit(body) ⇒ ApiResponse

Use the ‘/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer). type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7342

def transfer_diligence_submit(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/diligence/submit',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferDiligenceSubmitResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_event_list(body) ⇒ ApiResponse

Use the ‘/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6805

def transfer_event_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/event/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferEventListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_event_sync(body) ⇒ ApiResponse

‘/transfer/event/sync` allows you to request up to the next 500 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6889

def transfer_event_sync(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/event/sync',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferEventSyncResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_get(body) ⇒ ApiResponse

The ‘/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id` or `authorization_id`. One of `transfer_id` or `authorization_id` must be populated but not both. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6123

def transfer_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_intent_create(body) ⇒ ApiResponse

Use the ‘/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7151

def transfer_intent_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/intent/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferIntentCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_intent_get(body) ⇒ ApiResponse

Use the ‘/transfer/intent/get` endpoint to retrieve more information about a transfer intent. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7177

def transfer_intent_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/intent/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferIntentGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_ledger_deposit(body) ⇒ ApiResponse

Use the ‘/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6430

def transfer_ledger_deposit(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/ledger/deposit',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferLedgerDepositResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_ledger_distribute(body) ⇒ ApiResponse

Use the ‘/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you’re a platform, you can move funds between one of your ledgers and one of your customer’s ledger. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6404

def transfer_ledger_distribute(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/ledger/distribute',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferLedgerDistributeResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_ledger_event_list(body) ⇒ ApiResponse

Use the ‘/transfer/ledger/event/list` endpoint to get a list of ledger events for a specific ledger based on specified filter criteria. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6831

def transfer_ledger_event_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/ledger/event/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferLedgerEventListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_ledger_get(body) ⇒ ApiResponse

Use the ‘/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6377

def transfer_ledger_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/ledger/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferLedgerGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_ledger_withdraw(body) ⇒ ApiResponse

Use the ‘/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6456

def transfer_ledger_withdraw(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/ledger/withdraw',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferLedgerWithdrawResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_list(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6643

def transfer_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_metrics_get(body) ⇒ ApiResponse

Use the ‘/transfer/metrics/get` endpoint to view your transfer product usage metrics. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6534

def transfer_metrics_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/metrics/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferMetricsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_migrate_account(body) ⇒ ApiResponse

As an alternative to adding Items via Link, you can also use the ‘/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. 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 or [Support](dashboard.plaid.com/support). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7125

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/migrate_account',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferMigrateAccountResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_originator_create(body) ⇒ ApiResponse

Use the ‘/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7288

def transfer_originator_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/originator/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferOriginatorCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_originator_funding_account_create(body) ⇒ ApiResponse

Use the ‘/transfer/originator/funding_account/create` endpoint to create a new funding account for the originator. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6508

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/originator/funding_account/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferOriginatorFundingAccountCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_originator_funding_account_update(body) ⇒ ApiResponse

Use the ‘/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6482

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/originator/funding_account/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferOriginatorFundingAccountUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_originator_get(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7399

def transfer_originator_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/originator/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferOriginatorGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_originator_list(body) ⇒ ApiResponse

The ‘/transfer/originator/list` endpoint gets status updates for all of your originators’ onboarding. This information is also available via the Plaid dashboard. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7426

def transfer_originator_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/originator/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferOriginatorListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_platform_originator_create(body) ⇒ ApiResponse

Use the ‘/transfer/platform/originator/create` endpoint to submit information about the originator you are onboarding, including the originator’s agreement to the required legal terms. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7545

def transfer_platform_originator_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/platform/originator/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferPlatformOriginatorCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_platform_person_create(body) ⇒ ApiResponse

Use the ‘/transfer/platform/person/create` endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal identification information for them. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7572

def transfer_platform_person_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/platform/person/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferPlatformPersonCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_platform_requirement_submit(body) ⇒ ApiResponse

Use the ‘/transfer/platform/requirement/submit` endpoint to submit additional onboarding information that is needed by Plaid to approve or decline the originator. See [Requirement type schema documentation](docs.google.com/document/d/1NEQkTD0sVK50iAQi6xHigre xDUxZ4QxXqSEfV_FFTiU/) for a list of requirement types and possible values. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7262

def transfer_platform_requirement_submit(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/platform/requirement/submit',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferPlatformRequirementSubmitResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_questionnaire_create(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7316

def transfer_questionnaire_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/questionnaire/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferQuestionnaireCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_recurring_cancel(body) ⇒ ApiResponse

Use the ‘/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn’t been submitted to bank will be cancelled. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6752

def transfer_recurring_cancel(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/recurring/cancel',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRecurringCancelResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_recurring_create(body) ⇒ ApiResponse

Use the ‘/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Transfer for Platforms (beta) customers. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6591

def transfer_recurring_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/recurring/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRecurringCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_recurring_get(body) ⇒ ApiResponse

The ‘/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6149

def transfer_recurring_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/recurring/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRecurringGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_recurring_list(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6671

def transfer_recurring_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/recurring/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRecurringListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_refund_cancel(body) ⇒ ApiResponse

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. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7518

def transfer_refund_cancel(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/refund/cancel',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRefundCancelResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_refund_create(body) ⇒ ApiResponse

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. Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds. A refund can still be issued even if the Item’s ‘access_token` is no longer valid (e.g. if the user revoked OAuth consent or the Item was deleted via `/item/remove`), as long as the account and routing number pair used to make the original transaction is still valid. A refund cannot be issued if the Item has an [invalidated TAN](plaid.com/docs/auth/#tokenized-account-numbers), which can occur at Chase or PNC. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7465

def transfer_refund_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/refund/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRefundCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_refund_get(body) ⇒ ApiResponse

The ‘/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7491

def transfer_refund_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/refund/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRefundCreateResponse1.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_repayment_list(body) ⇒ ApiResponse

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`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7204

def transfer_repayment_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/repayment/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRepaymentListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_repayment_return_list(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 7232

def transfer_repayment_return_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/repayment/return/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferRepaymentReturnListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_sweep_get(body) ⇒ ApiResponse

The ‘/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6945

def transfer_sweep_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/sweep/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferSweepGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#transfer_sweep_list(body) ⇒ ApiResponse

The ‘/transfer/sweep/list` endpoint fetches sweeps matching the given filters. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 6997

def transfer_sweep_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/transfer/sweep/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(TransferSweepListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_account_session_event_send(body) ⇒ ApiResponse

This endpoint allows sending client-specific events related to Layer sessions for analytics and tracking purposes. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1376

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user_account/session/event/send',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserAccountSessionEventSendResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#user_account_session_get(body) ⇒ ApiResponse

This endpoint returns user permissioned account data, including identity and Item access tokens, for use with [Plaid Layer](plaid.com/docs/layer). Note that end users are permitted to edit the prefilled identity data in the Link flow before sharing it with you; you should treat any identity data returned by this endpoint as user-submitted, unverified data. For a verification layer, you can add [Identity Verification](plaid.com/docs/identity-verification/) to your flow, or check the submitted identity data against bank account data from linked accounts using [Identity Match](plaid.com/docs/identity/#identity-match). description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 1350

def (body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user_account/session/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserAccountSessionGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#user_create(body, plaid_new_user_api_enabled: false) ⇒ ApiResponse

For Plaid products and flows that use the user object, ‘/user/create` provides you a single token to access all data associated with the user. You must call this endpoint before calling `/link/token/create` if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect (Identity). If you are using Plaid Protect Link session scoring, you do not need to call `/user/create` first; Plaid will resolve or create the user when `user.client_user_id` is provided in `/link/token/create`. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a `client_user_id` and an `identity` object and will return a `user_id`. For customers who began using it before that date, the endpoint takes a `client_user_id` and a `consumer_report_user_identity` object and will return a `user_token` and `user_id`. For more details, see [New User APIs](plaid.com/docs/api/users/user-apis). In order to create a Plaid Check Consumer Report for a user, the `identity` (new) or `consumer_report_user_identity` (legacy) object must be present. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. In order to generate a Plaid Check Consumer Report, the following `identity` fields, at minimum, are required and must be non-empty: `name`, `date_of_birth`, `emails`, `phone_numbers`, and `addresses`, (with at least one email, phone number, and address designated as `primary`). Plaid Check Consumer Reports can only be created for US-based users; the user’s address country must be ‘US`. If creating a report for sharing with a GSE such as Fannie or Freddie, the user’s full SSN must be provided via the ‘id_numbers` field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an `identity` object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products. here parameter: The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.

Parameters:

  • body (UserCreateRequest) —

    Required parameter: TODO: type description

  • plaid_new_user_api_enabled (TrueClass | FalseClass) (defaults to: false) —

    Optional

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5194

def user_create(body,
                plaid_new_user_api_enabled: false)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter(plaid_new_user_api_enabled, key: 'Plaid-New-User-API-Enabled'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_financial_data_refresh(body) ⇒ ApiResponse

‘/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item. This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/financial_data/refresh` to target all Items for a user instead. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2036

def user_financial_data_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/financial_data/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserFinancialDataRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_get(body, plaid_new_user_api_enabled: false) ⇒ ApiResponse

Get user details using a ‘user_id`. This endpoint only supports users that were created on the new user API flow, without a `user_token`. For more details, see [New User APIs](plaid.com/docs/api/users/user-apis). here parameter: The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.

Parameters:

  • body (UserGetRequest) —

    Required parameter: TODO: type description

  • plaid_new_user_api_enabled (TrueClass | FalseClass) (defaults to: false) —

    Optional

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5226

def user_get(body,
             plaid_new_user_api_enabled: false)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter(plaid_new_user_api_enabled, key: 'Plaid-New-User-API-Enabled'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#user_identity_remove(body, plaid_new_user_api_enabled: false) ⇒ ApiResponse

This endpoint allows customers to explicitly purge identity/PII data provided to Plaid for a given user. This is not exposed to customers by default, as it is meant for special scenarios or requests, but Plaid is obligated to enable customers to delete PII provided to us. description here parameter: The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.

Parameters:

  • body (UserIdentityRemoveRequest) —

    Required parameter: TODO: type

  • plaid_new_user_api_enabled (TrueClass | FalseClass) (defaults to: false) —

    Optional

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5259

def user_identity_remove(body,
                         plaid_new_user_api_enabled: false)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/identity/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter(plaid_new_user_api_enabled, key: 'Plaid-New-User-API-Enabled'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserIdentityRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_items_associate(body) ⇒ ApiResponse

Associates Items to the target user. If an Item is already associated to another user, the Item will be disassociated with the existing user and associated to the target user. This operation supports a max of 100 Items. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5410

def user_items_associate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/items/associate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserItemsAssociateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_items_get(body) ⇒ ApiResponse

Returns Items associated with a ‘user_id`, along with their corresponding statuses. Plaid associates an Item with a User when it has been successfully connected within a Link session initialized with that `user_id`. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5383

def user_items_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/items/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserItemsGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_items_remove(body) ⇒ ApiResponse

Removes specific Items associated with a user. It is equivalent to calling ‘/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to `/item/remove`, this deletes Item product data, terminates billing on the Item’s products, and fires webhooks to the financial institution. Once removed, Items cannot be reconnected without going through Link again. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5441

def user_items_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/items/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserItemsRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_products_terminate(body) ⇒ ApiResponse

‘/user/products/terminate` terminates user-based recurring subscriptions for a given client user. This will remove user-based products (Financial Management, Protect, and CRA products) from all items associated with the user. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5355

def user_products_terminate(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/products/terminate',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserProductsTerminateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_remove(body, plaid_new_user_api_enabled: false) ⇒ ApiResponse

‘/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user. here parameter: The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.

Parameters:

  • body (UserRemoveRequest) —

    Required parameter: TODO: type description

  • plaid_new_user_api_enabled (TrueClass | FalseClass) (defaults to: false) —

    Optional

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5325

def user_remove(body,
                plaid_new_user_api_enabled: false)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter(plaid_new_user_api_enabled, key: 'Plaid-New-User-API-Enabled'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_third_party_token_create(body) ⇒ ApiResponse

This endpoint is used to create a third-party user token. This token can be shared with and used by a specified third-party client to access data associated with the user through supported endpoints. Ensure you store the ‘third_party_user_token` along with the `user_token` and `third_party_client_id`, as it is not possible to retrieve a previously created `third_party_user_token`. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5471

def user_third_party_token_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/third_party_token/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserThirdPartyTokenCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#user_third_party_token_remove(body) ⇒ ApiResponse

This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5500

def user_third_party_token_remove(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/third_party_token/remove',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserThirdPartyTokenRemoveResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             ErrorErrorException))
    .execute
end

#user_transactions_refresh(body) ⇒ ApiResponse

‘/user/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Transactions bundle. This bundle refreshes only the Transactions product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item. This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/transactions/refresh` to target all Items for a user instead. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2000

def user_transactions_refresh(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/transactions/refresh',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserTransactionsRefreshResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#user_update(body, plaid_new_user_api_enabled: false) ⇒ ApiResponse

This endpoint updates user information for an existing ‘user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. creating a Consumer Report) use `/user/update` to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged. here parameter: The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.

Parameters:

  • body (UserUpdateRequest) —

    Required parameter: TODO: type description

  • plaid_new_user_api_enabled (TrueClass | FalseClass) (defaults to: false) —

    Optional

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 5294

def user_update(body,
                plaid_new_user_api_enabled: false)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter(plaid_new_user_api_enabled, key: 'Plaid-New-User-API-Enabled'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UserUpdateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#wallet_create(body) ⇒ ApiResponse

Create an e-wallet. The response is the newly created e-wallet object. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9211

def wallet_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/wallet/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WalletCreateResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#wallet_get(body) ⇒ ApiResponse

Fetch an e-wallet. The response includes the current balance. here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9236

def wallet_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/wallet/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WalletGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#wallet_list(body) ⇒ ApiResponse

This endpoint lists all e-wallets in descending order of creation. here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9261

def wallet_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/wallet/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WalletListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#wallet_transaction_execute(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9291

def wallet_transaction_execute(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/wallet/transaction/execute',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WalletTransactionExecuteResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#wallet_transaction_get(body) ⇒ ApiResponse

Fetch a specific e-wallet transaction description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9316

def wallet_transaction_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/wallet/transaction/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WalletTransactionGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#wallet_transaction_list(body) ⇒ ApiResponse

This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the ‘created_at` time. description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 9342

def wallet_transaction_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/wallet/transaction/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WalletTransactionListResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end

#watchlist_screening_entity_create(body) ⇒ ApiResponse

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. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2813

def watchlist_screening_entity_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_get(body) ⇒ ApiResponse

Retrieve an entity watchlist screening. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2835

def watchlist_screening_entity_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_history_list(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2859

def watchlist_screening_entity_history_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/history/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityHistoryListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_hit_list(body) ⇒ ApiResponse

List all hits for the entity watchlist screening. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2881

def watchlist_screening_entity_hit_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/hit/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityHitListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_list(body) ⇒ ApiResponse

List all entity screenings. TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2903

def watchlist_screening_entity_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_program_get(body) ⇒ ApiResponse

Get an entity watchlist screening program parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2925

def watchlist_screening_entity_program_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/program/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityProgramGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_program_list(body) ⇒ ApiResponse

List all entity watchlist screening programs parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2947

def watchlist_screening_entity_program_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/program/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityProgramListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_review_create(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2971

def watchlist_screening_entity_review_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/review/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityReviewCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_review_list(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 2995

def watchlist_screening_entity_review_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/review/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityReviewListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_entity_update(body) ⇒ ApiResponse

Update an entity watchlist screening. The entity screening was successfully updated.

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3017

def watchlist_screening_entity_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/entity/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningEntityUpdateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_create(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3042

def watchlist_screening_individual_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_get(body) ⇒ ApiResponse

Retrieve a previously created individual watchlist screening TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3064

def watchlist_screening_individual_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_history_list(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3088

def watchlist_screening_individual_history_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/history/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualHistoryListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_hit_list(body) ⇒ ApiResponse

List all hits found by Plaid for a particular individual watchlist screening. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3111

def watchlist_screening_individual_hit_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/hit/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualHitListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_list(body) ⇒ ApiResponse

List previously created watchlist screenings for individuals TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3133

def watchlist_screening_individual_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_program_get(body) ⇒ ApiResponse

Get an individual watchlist screening program parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3155

def watchlist_screening_individual_program_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/program/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualProgramGetResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_program_list(body) ⇒ ApiResponse

List all individual watchlist screening programs parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3177

def watchlist_screening_individual_program_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/program/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualProgramListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_review_create(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3201

def watchlist_screening_individual_review_create(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/review/create',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualReviewCreateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_review_list(body) ⇒ ApiResponse

List all reviews for the individual watchlist screening. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3223

def watchlist_screening_individual_review_list(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/review/list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualReviewListResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#watchlist_screening_individual_update(body) ⇒ ApiResponse

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. parameter: TODO: type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 3250

def watchlist_screening_individual_update(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/watchlist_screening/individual/update',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WatchlistScreeningIndividualUpdateResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end

#webhook_verification_key_get(body) ⇒ ApiResponse

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. type description here

Parameters:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
 
# File 'lib/the_plaid_api/apis/plaid_api.rb', line 4610

def webhook_verification_key_get(body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/webhook_verification_key/get',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body)
                            .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('clientId', 'secret', 'plaidVersion')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(WebhookVerificationKeyGetResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             ErrorErrorException))
    .execute
end