Class: Plaid::PlaidApi

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/api/plaid_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PlaidApi

Returns a new instance of PlaidApi.



19
20
21
 
# File 'lib/plaid/api/plaid_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/plaid/api/plaid_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#accounts_balance_get(accounts_balance_get_request, opts = {}) ⇒ AccountsGetResponse

Retrieve real-time balance data The ‘/accounts/balance/get` endpoint returns the real-time balance for each of an Item’s accounts. While other endpoints, such as ‘/accounts/get`, return a balance object, `/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).

Parameters:

Returns:



27
28
29
30
 
# File 'lib/plaid/api/plaid_api.rb', line 27

def accounts_balance_get(accounts_balance_get_request, opts = {})
  data, _status_code, _headers = accounts_balance_get_with_http_info(accounts_balance_get_request, opts)
  data
end

#accounts_balance_get_with_http_info(accounts_balance_get_request, opts = {}) ⇒ Array<(AccountsGetResponse, Integer, Hash)>

Retrieve real-time balance data The &#x60;/accounts/balance/get&#x60; endpoint returns the real-time balance for each of an Item&#39;s accounts. While other endpoints, such as &#x60;/accounts/get&#x60;, return a balance object, &#x60;/accounts/balance/get&#x60; 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, &#x60;balance&#x60; 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 &#x60;/signal/evaluate&#x60; instead of &#x60;/accounts/balance/get&#x60;. &#x60;/signal/evaluate&#x60; 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).

Parameters:

Returns:

  • (Array<(AccountsGetResponse, Integer, Hash)>) —

    AccountsGetResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/plaid/api/plaid_api.rb', line 37

def accounts_balance_get_with_http_info(accounts_balance_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.accounts_balance_get ...'
  end
  # verify the required parameter 'accounts_balance_get_request' is set
  if @api_client.config.client_side_validation && accounts_balance_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'accounts_balance_get_request' when calling PlaidApi.accounts_balance_get"
  end
  # resource path
  local_var_path = '/accounts/balance/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(accounts_balance_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AccountsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.accounts_balance_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#accounts_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#accounts_get(accounts_get_request, opts = {}) ⇒ AccountsGetResponse

Retrieve accounts The ‘/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. 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.

Parameters:

  • accounts_get_request (AccountsGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/plaid/api/plaid_api.rb', line 95

def accounts_get(accounts_get_request, opts = {})
  data, _status_code, _headers = accounts_get_with_http_info(accounts_get_request, opts)
  data
end

#accounts_get_with_http_info(accounts_get_request, opts = {}) ⇒ Array<(AccountsGetResponse, Integer, Hash)>

Retrieve accounts The &#x60;/accounts/get&#x60; 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 [&#x60;NEW_ACCOUNTS_AVAILABLE&#x60;](plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link&#39;s [update mode](plaid.com/docs/link/update-mode/) to request that the user share this new account with you. &#x60;/accounts/get&#x60; 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 &#x60;/accounts/balance/get&#x60; or &#x60;/signal/evaluate&#x60; instead.

Parameters:

  • accounts_get_request (AccountsGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AccountsGetResponse, Integer, Hash)>) —

    AccountsGetResponse data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/plaid/api/plaid_api.rb', line 105

def accounts_get_with_http_info(accounts_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.accounts_get ...'
  end
  # verify the required parameter 'accounts_get_request' is set
  if @api_client.config.client_side_validation && accounts_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'accounts_get_request' when calling PlaidApi.accounts_get"
  end
  # resource path
  local_var_path = '/accounts/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(accounts_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AccountsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.accounts_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#accounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#application_get(application_get_request, opts = {}) ⇒ ApplicationGetResponse

Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences

Parameters:

  • application_get_request (ApplicationGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/plaid/api/plaid_api.rb', line 163

def application_get(application_get_request, opts = {})
  data, _status_code, _headers = application_get_with_http_info(application_get_request, opts)
  data
end

#application_get_with_http_info(application_get_request, opts = {}) ⇒ Array<(ApplicationGetResponse, Integer, Hash)>

Retrieve information about a Plaid application Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences

Parameters:

  • application_get_request (ApplicationGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicationGetResponse, Integer, Hash)>) —

    ApplicationGetResponse data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/plaid/api/plaid_api.rb', line 173

def application_get_with_http_info(application_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.application_get ...'
  end
  # verify the required parameter 'application_get_request' is set
  if @api_client.config.client_side_validation && application_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'application_get_request' when calling PlaidApi.application_get"
  end
  # resource path
  local_var_path = '/application/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(application_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ApplicationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.application_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#application_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_audit_copy_create(asset_report_audit_copy_create_request, opts = {}) ⇒ AssetReportAuditCopyCreateResponse

Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to 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.

Parameters:

Returns:



231
232
233
234
 
# File 'lib/plaid/api/plaid_api.rb', line 231

def asset_report_audit_copy_create(asset_report_audit_copy_create_request, opts = {})
  data, _status_code, _headers = asset_report_audit_copy_create_with_http_info(asset_report_audit_copy_create_request, opts)
  data
end

#asset_report_audit_copy_create_with_http_info(asset_report_audit_copy_create_request, opts = {}) ⇒ Array<(AssetReportAuditCopyCreateResponse, Integer, Hash)>

Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on your behalf if you participate in Fannie Mae&#39;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 &#x60;/asset_report/audit_copy/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;auditor_id&#x60;, for example &#x60;fannie_mae&#x60;. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.

Parameters:

Returns:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/plaid/api/plaid_api.rb', line 241

def asset_report_audit_copy_create_with_http_info(asset_report_audit_copy_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_create ...'
  end
  # verify the required parameter 'asset_report_audit_copy_create_request' is set
  if @api_client.config.client_side_validation && asset_report_audit_copy_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_create_request' when calling PlaidApi.asset_report_audit_copy_create"
  end
  # resource path
  local_var_path = '/asset_report/audit_copy/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportAuditCopyCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_audit_copy_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_audit_copy_get(asset_report_audit_copy_get_request, opts = {}) ⇒ AssetReportGetResponse

Retrieve an Asset Report Audit Copy ‘/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/get`.

Parameters:

Returns:



299
300
301
302
 
# File 'lib/plaid/api/plaid_api.rb', line 299

def asset_report_audit_copy_get(asset_report_audit_copy_get_request, opts = {})
  data, _status_code, _headers = asset_report_audit_copy_get_with_http_info(asset_report_audit_copy_get_request, opts)
  data
end

#asset_report_audit_copy_get_with_http_info(asset_report_audit_copy_get_request, opts = {}) ⇒ Array<(AssetReportGetResponse, Integer, Hash)>

Retrieve an Asset Report Audit Copy &#x60;/asset_report/audit_copy/get&#x60; allows auditors to get a copy of an Asset Report that was previously shared via the &#x60;/asset_report/audit_copy/create&#x60; endpoint. The caller of &#x60;/asset_report/audit_copy/create&#x60; must provide the &#x60;audit_copy_token&#x60; to the auditor. This token can then be used to call &#x60;/asset_report/audit_copy/get&#x60;.

Parameters:

Returns:

  • (Array<(AssetReportGetResponse, Integer, Hash)>) —

    AssetReportGetResponse data, response status code and response headers



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/plaid/api/plaid_api.rb', line 309

def asset_report_audit_copy_get_with_http_info(asset_report_audit_copy_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_get ...'
  end
  # verify the required parameter 'asset_report_audit_copy_get_request' is set
  if @api_client.config.client_side_validation && asset_report_audit_copy_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_get_request' when calling PlaidApi.asset_report_audit_copy_get"
  end
  # resource path
  local_var_path = '/asset_report/audit_copy/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_audit_copy_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_audit_copy_pdf_get(asset_report_audit_copy_pdf_get_request, opts = {}) ⇒ File

Retrieve a PDF Asset Report Audit Copy 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).

Parameters:

Returns:

  • (File) 


367
368
369
370
 
# File 'lib/plaid/api/plaid_api.rb', line 367

def asset_report_audit_copy_pdf_get(asset_report_audit_copy_pdf_get_request, opts = {})
  data, _status_code, _headers = asset_report_audit_copy_pdf_get_with_http_info(asset_report_audit_copy_pdf_get_request, opts)
  data
end

#asset_report_audit_copy_pdf_get_with_http_info(asset_report_audit_copy_pdf_get_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

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

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/plaid/api/plaid_api.rb', line 377

def asset_report_audit_copy_pdf_get_with_http_info(asset_report_audit_copy_pdf_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_pdf_get ...'
  end
  # verify the required parameter 'asset_report_audit_copy_pdf_get_request' is set
  if @api_client.config.client_side_validation && asset_report_audit_copy_pdf_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_pdf_get_request' when calling PlaidApi.asset_report_audit_copy_pdf_get"
  end
  # resource path
  local_var_path = '/asset_report/audit_copy/pdf/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_pdf_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_audit_copy_pdf_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_audit_copy_remove(asset_report_audit_copy_remove_request, opts = {}) ⇒ AssetReportAuditCopyRemoveResponse

Remove Asset Report Audit Copy The ‘/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.

Parameters:

Returns:



435
436
437
438
 
# File 'lib/plaid/api/plaid_api.rb', line 435

def asset_report_audit_copy_remove(asset_report_audit_copy_remove_request, opts = {})
  data, _status_code, _headers = asset_report_audit_copy_remove_with_http_info(asset_report_audit_copy_remove_request, opts)
  data
end

#asset_report_audit_copy_remove_with_http_info(asset_report_audit_copy_remove_request, opts = {}) ⇒ Array<(AssetReportAuditCopyRemoveResponse, Integer, Hash)>

Remove Asset Report Audit Copy The &#x60;/asset_report/audit_copy/remove&#x60; endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the &#x60;audit_copy_token&#x60; 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.

Parameters:

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/plaid/api/plaid_api.rb', line 445

def asset_report_audit_copy_remove_with_http_info(asset_report_audit_copy_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_remove ...'
  end
  # verify the required parameter 'asset_report_audit_copy_remove_request' is set
  if @api_client.config.client_side_validation && asset_report_audit_copy_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_remove_request' when calling PlaidApi.asset_report_audit_copy_remove"
  end
  # resource path
  local_var_path = '/asset_report/audit_copy/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportAuditCopyRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_audit_copy_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_create(asset_report_create_request, opts = {}) ⇒ AssetReportCreateResponse

Create an Asset Report The ‘/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. The exact amount of time to create the report will vary depending on how many days of history are requested and will typically range from a few seconds to about one minute. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](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.

Parameters:

Returns:



503
504
505
506
 
# File 'lib/plaid/api/plaid_api.rb', line 503

def asset_report_create(asset_report_create_request, opts = {})
  data, _status_code, _headers = asset_report_create_with_http_info(asset_report_create_request, opts)
  data
end

#asset_report_create_with_http_info(asset_report_create_request, opts = {}) ⇒ Array<(AssetReportCreateResponse, Integer, Hash)>

Create an Asset Report The &#x60;/asset_report/create&#x60; endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the &#x60;asset_report_token&#x60; return value to the &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60; endpoints. The Asset Report takes some time to be created and is not available immediately after calling &#x60;/asset_report/create&#x60;. 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 &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60;, Plaid will fire a &#x60;PRODUCT_READY&#x60; webhook. For full details of the webhook schema, see [Asset Report webhooks](plaid.com/docs/api/products/assets/#webhooks). The &#x60;/asset_report/create&#x60; endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the &#x60;/asset_report/refresh&#x60; endpoint.

Parameters:

Returns:

  • (Array<(AssetReportCreateResponse, Integer, Hash)>) —

    AssetReportCreateResponse data, response status code and response headers



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/plaid/api/plaid_api.rb', line 513

def asset_report_create_with_http_info(asset_report_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_create ...'
  end
  # verify the required parameter 'asset_report_create_request' is set
  if @api_client.config.client_side_validation && asset_report_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_create_request' when calling PlaidApi.asset_report_create"
  end
  # resource path
  local_var_path = '/asset_report/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_filter(asset_report_filter_request, opts = {}) ⇒ AssetReportFilterResponse

Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the ‘/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report’s data. Because Asset Reports are immutable, calling ‘/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](plaid.com/docs/api/products/assets/#product_ready) webhook once generation of the filtered Asset Report has completed.

Parameters:

Returns:



571
572
573
574
 
# File 'lib/plaid/api/plaid_api.rb', line 571

def asset_report_filter(asset_report_filter_request, opts = {})
  data, _status_code, _headers = asset_report_filter_with_http_info(asset_report_filter_request, opts)
  data
end

#asset_report_filter_with_http_info(asset_report_filter_request, opts = {}) ⇒ Array<(AssetReportFilterResponse, Integer, Hash)>

Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the &#x60;/accounts/get&#x60; endpoint. To narrow an Asset Report to only a subset of accounts, use the &#x60;/asset_report/filter&#x60; endpoint. To exclude certain Accounts from an Asset Report, first use the &#x60;/asset_report/create&#x60; endpoint to create the report, then send the &#x60;asset_report_token&#x60; along with a list of &#x60;account_ids&#x60; to exclude to the &#x60;/asset_report/filter&#x60; endpoint, to create a new Asset Report which contains only a subset of the original Asset Report&#39;s data. Because Asset Reports are immutable, calling &#x60;/asset_report/filter&#x60; does not alter the original Asset Report in any way; rather, &#x60;/asset_report/filter&#x60; creates a new Asset Report with a new token and id. Asset Reports created via &#x60;/asset_report/filter&#x60; do not contain new Asset data, and are not billed. Plaid will fire a [&#x60;PRODUCT_READY&#x60;](plaid.com/docs/api/products/assets/#product_ready) webhook once generation of the filtered Asset Report has completed.

Parameters:

Returns:

  • (Array<(AssetReportFilterResponse, Integer, Hash)>) —

    AssetReportFilterResponse data, response status code and response headers



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/plaid/api/plaid_api.rb', line 581

def asset_report_filter_with_http_info(asset_report_filter_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_filter ...'
  end
  # verify the required parameter 'asset_report_filter_request' is set
  if @api_client.config.client_side_validation && asset_report_filter_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_filter_request' when calling PlaidApi.asset_report_filter"
  end
  # resource path
  local_var_path = '/asset_report/filter'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_filter_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportFilterResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_filter",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_get(asset_report_get_request, opts = {}) ⇒ AssetReportGetResponse

Retrieve an Asset Report The ‘/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `["fast_assets"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.

Parameters:

  • asset_report_get_request (AssetReportGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



639
640
641
642
 
# File 'lib/plaid/api/plaid_api.rb', line 639

def asset_report_get(asset_report_get_request, opts = {})
  data, _status_code, _headers = asset_report_get_with_http_info(asset_report_get_request, opts)
  data
end

#asset_report_get_with_http_info(asset_report_get_request, opts = {}) ⇒ Array<(AssetReportGetResponse, Integer, Hash)>

Retrieve an Asset Report The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;. For latency-sensitive applications, you can optionally call &#x60;/asset_report/create&#x60; with &#x60;options.add_ons&#x60; set to &#x60;&#x60;. 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.

Parameters:

  • asset_report_get_request (AssetReportGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AssetReportGetResponse, Integer, Hash)>) —

    AssetReportGetResponse data, response status code and response headers



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/plaid/api/plaid_api.rb', line 649

def asset_report_get_with_http_info(asset_report_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_get ...'
  end
  # verify the required parameter 'asset_report_get_request' is set
  if @api_client.config.client_side_validation && asset_report_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_get_request' when calling PlaidApi.asset_report_get"
  end
  # resource path
  local_var_path = '/asset_report/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_pdf_get(asset_report_pdf_get_request, opts = {}) ⇒ File

Retrieve a PDF Asset Report The ‘/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](plaid.com/documents/sample-asset-report.pdf).

Parameters:

Returns:

  • (File) 


707
708
709
710
 
# File 'lib/plaid/api/plaid_api.rb', line 707

def asset_report_pdf_get(asset_report_pdf_get_request, opts = {})
  data, _status_code, _headers = asset_report_pdf_get_with_http_info(asset_report_pdf_get_request, opts)
  data
end

#asset_report_pdf_get_with_http_info(asset_report_pdf_get_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve a PDF Asset Report The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](plaid.com/documents/sample-asset-report.pdf).

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/plaid/api/plaid_api.rb', line 717

def asset_report_pdf_get_with_http_info(asset_report_pdf_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_pdf_get ...'
  end
  # verify the required parameter 'asset_report_pdf_get_request' is set
  if @api_client.config.client_side_validation && asset_report_pdf_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_pdf_get_request' when calling PlaidApi.asset_report_pdf_get"
  end
  # resource path
  local_var_path = '/asset_report/pdf/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_pdf_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_pdf_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_refresh(asset_report_refresh_request, opts = {}) ⇒ AssetReportRefreshResponse

Refresh an Asset Report An Asset Report is an immutable snapshot of a user’s assets. In order to "refresh" an Asset Report you created previously, you can use the ‘/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available. The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string ("") for any previously-populated fields you would like set as empty.

Parameters:

Returns:



775
776
777
778
 
# File 'lib/plaid/api/plaid_api.rb', line 775

def asset_report_refresh(asset_report_refresh_request, opts = {})
  data, _status_code, _headers = asset_report_refresh_with_http_info(asset_report_refresh_request, opts)
  data
end

#asset_report_refresh_with_http_info(asset_report_refresh_request, opts = {}) ⇒ Array<(AssetReportRefreshResponse, Integer, Hash)>

Refresh an Asset Report An Asset Report is an immutable snapshot of a user&#39;s assets. In order to &quot;refresh&quot; an Asset Report you created previously, you can use the &#x60;/asset_report/refresh&#x60; 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 &#x60;/asset_report/filter&#x60;. By default, the new Asset Report will also use the same parameters you submitted with your original &#x60;/asset_report/create&#x60; request, but the original &#x60;days_requested&#x60; value and the values of any parameters in the &#x60;options&#x60; object can be overridden with new values. To change these arguments, simply supply new values for them in your request to &#x60;/asset_report/refresh&#x60;. Submit an empty string (&quot;&quot;) for any previously-populated fields you would like set as empty.

Parameters:

Returns:

  • (Array<(AssetReportRefreshResponse, Integer, Hash)>) —

    AssetReportRefreshResponse data, response status code and response headers



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/plaid/api/plaid_api.rb', line 785

def asset_report_refresh_with_http_info(asset_report_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_refresh ...'
  end
  # verify the required parameter 'asset_report_refresh_request' is set
  if @api_client.config.client_side_validation && asset_report_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_refresh_request' when calling PlaidApi.asset_report_refresh"
  end
  # resource path
  local_var_path = '/asset_report/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#asset_report_remove(asset_report_remove_request, opts = {}) ⇒ AssetReportRemoveResponse

Delete an Asset Report The ‘/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove 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.

Parameters:

Returns:



843
844
845
846
 
# File 'lib/plaid/api/plaid_api.rb', line 843

def asset_report_remove(asset_report_remove_request, opts = {})
  data, _status_code, _headers = asset_report_remove_with_http_info(asset_report_remove_request, opts)
  data
end

#asset_report_remove_with_http_info(asset_report_remove_request, opts = {}) ⇒ Array<(AssetReportRemoveResponse, Integer, Hash)>

Delete an Asset Report The &#x60;/item/remove&#x60; endpoint allows you to invalidate an &#x60;access_token&#x60;, 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 &#x60;/asset_report/remove&#x60; endpoint allows you to remove access to an Asset Report. Removing an Asset Report invalidates its &#x60;asset_report_token&#x60;, 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 &#x60;audit_copy_tokens&#x60; associated with the Asset Report.

Parameters:

Returns:

  • (Array<(AssetReportRemoveResponse, Integer, Hash)>) —

    AssetReportRemoveResponse data, response status code and response headers



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/plaid/api/plaid_api.rb', line 853

def asset_report_remove_with_http_info(asset_report_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_remove ...'
  end
  # verify the required parameter 'asset_report_remove_request' is set
  if @api_client.config.client_side_validation && asset_report_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'asset_report_remove_request' when calling PlaidApi.asset_report_remove"
  end
  # resource path
  local_var_path = '/asset_report/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.asset_report_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#asset_report_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#auth_get(auth_get_request, opts = {}) ⇒ AuthGetResponse

Retrieve auth data The ‘/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item’s checking, 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).

Parameters:

  • auth_get_request (AuthGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



911
912
913
914
 
# File 'lib/plaid/api/plaid_api.rb', line 911

def auth_get(auth_get_request, opts = {})
  data, _status_code, _headers = auth_get_with_http_info(auth_get_request, opts)
  data
end

#auth_get_with_http_info(auth_get_request, opts = {}) ⇒ Array<(AuthGetResponse, Integer, Hash)>

Retrieve auth data The &#x60;/auth/get&#x60; endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item&#39;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 &#x60;numbers&#x60; object returned by this endpoint is substantially different. For details, see [Plaid API versioning](plaid.com/docs/api/versioning/#version-2018-05-22).

Parameters:

  • auth_get_request (AuthGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AuthGetResponse, Integer, Hash)>) —

    AuthGetResponse data, response status code and response headers



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/plaid/api/plaid_api.rb', line 921

def auth_get_with_http_info(auth_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.auth_get ...'
  end
  # verify the required parameter 'auth_get_request' is set
  if @api_client.config.client_side_validation && auth_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'auth_get_request' when calling PlaidApi.auth_get"
  end
  # resource path
  local_var_path = '/auth/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(auth_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AuthGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.auth_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#auth_verify(auth_verify_request, opts = {}) ⇒ AuthVerifyResponse

Verify auth data 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.

Parameters:

  • auth_verify_request (AuthVerifyRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



979
980
981
982
 
# File 'lib/plaid/api/plaid_api.rb', line 979

def auth_verify(auth_verify_request, opts = {})
  data, _status_code, _headers = auth_verify_with_http_info(auth_verify_request, opts)
  data
end

#auth_verify_with_http_info(auth_verify_request, opts = {}) ⇒ Array<(AuthVerifyResponse, Integer, Hash)>

Verify auth data The &#x60;/auth/verify&#x60; endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid&#39;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.

Parameters:

  • auth_verify_request (AuthVerifyRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AuthVerifyResponse, Integer, Hash)>) —

    AuthVerifyResponse data, response status code and response headers



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/plaid/api/plaid_api.rb', line 989

def auth_verify_with_http_info(auth_verify_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.auth_verify ...'
  end
  # verify the required parameter 'auth_verify_request' is set
  if @api_client.config.client_side_validation && auth_verify_request.nil?
    fail ArgumentError, "Missing the required parameter 'auth_verify_request' when calling PlaidApi.auth_verify"
  end
  # resource path
  local_var_path = '/auth/verify'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(auth_verify_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AuthVerifyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.auth_verify",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#auth_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_balance_get(bank_transfer_balance_get_request, opts = {}) ⇒ BankTransferBalanceGetResponse

Get balance of your Bank Transfer account Use the ‘/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.

Parameters:

Returns:



1047
1048
1049
1050
 
# File 'lib/plaid/api/plaid_api.rb', line 1047

def bank_transfer_balance_get(bank_transfer_balance_get_request, opts = {})
  data, _status_code, _headers = bank_transfer_balance_get_with_http_info(bank_transfer_balance_get_request, opts)
  data
end

#bank_transfer_balance_get_with_http_info(bank_transfer_balance_get_request, opts = {}) ⇒ Array<(BankTransferBalanceGetResponse, Integer, Hash)>

Get balance of your Bank Transfer account Use the &#x60;/bank_transfer/balance/get&#x60; 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.

Parameters:

Returns:



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/plaid/api/plaid_api.rb', line 1057

def bank_transfer_balance_get_with_http_info(bank_transfer_balance_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_balance_get ...'
  end
  # verify the required parameter 'bank_transfer_balance_get_request' is set
  if @api_client.config.client_side_validation && bank_transfer_balance_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_balance_get_request' when calling PlaidApi.bank_transfer_balance_get"
  end
  # resource path
  local_var_path = '/bank_transfer/balance/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_balance_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferBalanceGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_balance_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_cancel(bank_transfer_cancel_request, opts = {}) ⇒ BankTransferCancelResponse

Cancel a bank transfer Use the ‘/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.

Parameters:

Returns:



1115
1116
1117
1118
 
# File 'lib/plaid/api/plaid_api.rb', line 1115

def bank_transfer_cancel(bank_transfer_cancel_request, opts = {})
  data, _status_code, _headers = bank_transfer_cancel_with_http_info(bank_transfer_cancel_request, opts)
  data
end

#bank_transfer_cancel_with_http_info(bank_transfer_cancel_request, opts = {}) ⇒ Array<(BankTransferCancelResponse, Integer, Hash)>

Cancel a bank transfer Use the &#x60;/bank_transfer/cancel&#x60; endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the &#x60;cancellable&#x60; property returned by &#x60;/bank_transfer/get&#x60; is &#x60;true&#x60;.

Parameters:

Returns:

  • (Array<(BankTransferCancelResponse, Integer, Hash)>) —

    BankTransferCancelResponse data, response status code and response headers



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/plaid/api/plaid_api.rb', line 1125

def bank_transfer_cancel_with_http_info(bank_transfer_cancel_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_cancel ...'
  end
  # verify the required parameter 'bank_transfer_cancel_request' is set
  if @api_client.config.client_side_validation && bank_transfer_cancel_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_cancel_request' when calling PlaidApi.bank_transfer_cancel"
  end
  # resource path
  local_var_path = '/bank_transfer/cancel'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_cancel_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferCancelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_cancel",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_create(bank_transfer_create_request, opts = {}) ⇒ BankTransferCreateResponse

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

Parameters:

Returns:



1183
1184
1185
1186
 
# File 'lib/plaid/api/plaid_api.rb', line 1183

def bank_transfer_create(bank_transfer_create_request, opts = {})
  data, _status_code, _headers = bank_transfer_create_with_http_info(bank_transfer_create_request, opts)
  data
end

#bank_transfer_create_with_http_info(bank_transfer_create_request, opts = {}) ⇒ Array<(BankTransferCreateResponse, Integer, Hash)>

Create a bank transfer Use the &#x60;/bank_transfer/create&#x60; endpoint to initiate a new bank transfer.

Parameters:

Returns:

  • (Array<(BankTransferCreateResponse, Integer, Hash)>) —

    BankTransferCreateResponse data, response status code and response headers



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/plaid/api/plaid_api.rb', line 1193

def bank_transfer_create_with_http_info(bank_transfer_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_create ...'
  end
  # verify the required parameter 'bank_transfer_create_request' is set
  if @api_client.config.client_side_validation && bank_transfer_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_create_request' when calling PlaidApi.bank_transfer_create"
  end
  # resource path
  local_var_path = '/bank_transfer/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_event_list(bank_transfer_event_list_request, opts = {}) ⇒ BankTransferEventListResponse

List bank transfer events Use the ‘/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](plaid.com/docs/auth/coverage/microdeposit-events/).

Parameters:

Returns:



1251
1252
1253
1254
 
# File 'lib/plaid/api/plaid_api.rb', line 1251

def bank_transfer_event_list(bank_transfer_event_list_request, opts = {})
  data, _status_code, _headers = bank_transfer_event_list_with_http_info(bank_transfer_event_list_request, opts)
  data
end

#bank_transfer_event_list_with_http_info(bank_transfer_event_list_request, opts = {}) ⇒ Array<(BankTransferEventListResponse, Integer, Hash)>

List bank transfer events Use the &#x60;/bank_transfer/event/list&#x60; 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/).

Parameters:

Returns:



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/plaid/api/plaid_api.rb', line 1261

def bank_transfer_event_list_with_http_info(bank_transfer_event_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_event_list ...'
  end
  # verify the required parameter 'bank_transfer_event_list_request' is set
  if @api_client.config.client_side_validation && bank_transfer_event_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_event_list_request' when calling PlaidApi.bank_transfer_event_list"
  end
  # resource path
  local_var_path = '/bank_transfer/event/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_event_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferEventListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_event_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_event_sync(bank_transfer_event_sync_request, opts = {}) ⇒ BankTransferEventSyncResponse

Sync bank transfer events ‘/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](plaid.com/docs/auth/coverage/microdeposit-events/).

Parameters:

Returns:



1319
1320
1321
1322
 
# File 'lib/plaid/api/plaid_api.rb', line 1319

def bank_transfer_event_sync(bank_transfer_event_sync_request, opts = {})
  data, _status_code, _headers = bank_transfer_event_sync_with_http_info(bank_transfer_event_sync_request, opts)
  data
end

#bank_transfer_event_sync_with_http_info(bank_transfer_event_sync_request, opts = {}) ⇒ Array<(BankTransferEventSyncResponse, Integer, Hash)>

Sync bank transfer events &#x60;/bank_transfer/event/sync&#x60; allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific &#x60;event_id&#x60;. 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/).

Parameters:

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/plaid/api/plaid_api.rb', line 1329

def bank_transfer_event_sync_with_http_info(bank_transfer_event_sync_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_event_sync ...'
  end
  # verify the required parameter 'bank_transfer_event_sync_request' is set
  if @api_client.config.client_side_validation && bank_transfer_event_sync_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_event_sync_request' when calling PlaidApi.bank_transfer_event_sync"
  end
  # resource path
  local_var_path = '/bank_transfer/event/sync'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_event_sync_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferEventSyncResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_event_sync",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_event_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_get(bank_transfer_get_request, opts = {}) ⇒ BankTransferGetResponse

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

Parameters:

  • bank_transfer_get_request (BankTransferGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1387
1388
1389
1390
 
# File 'lib/plaid/api/plaid_api.rb', line 1387

def bank_transfer_get(bank_transfer_get_request, opts = {})
  data, _status_code, _headers = bank_transfer_get_with_http_info(bank_transfer_get_request, opts)
  data
end

#bank_transfer_get_with_http_info(bank_transfer_get_request, opts = {}) ⇒ Array<(BankTransferGetResponse, Integer, Hash)>

Retrieve a bank transfer The &#x60;/bank_transfer/get&#x60; fetches information about the bank transfer corresponding to the given &#x60;bank_transfer_id&#x60;.

Parameters:

  • bank_transfer_get_request (BankTransferGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BankTransferGetResponse, Integer, Hash)>) —

    BankTransferGetResponse data, response status code and response headers



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/plaid/api/plaid_api.rb', line 1397

def bank_transfer_get_with_http_info(bank_transfer_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_get ...'
  end
  # verify the required parameter 'bank_transfer_get_request' is set
  if @api_client.config.client_side_validation && bank_transfer_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_get_request' when calling PlaidApi.bank_transfer_get"
  end
  # resource path
  local_var_path = '/bank_transfer/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_list(bank_transfer_list_request, opts = {}) ⇒ BankTransferListResponse

List bank transfers Use the ‘/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.

Parameters:

Returns:



1455
1456
1457
1458
 
# File 'lib/plaid/api/plaid_api.rb', line 1455

def bank_transfer_list(bank_transfer_list_request, opts = {})
  data, _status_code, _headers = bank_transfer_list_with_http_info(bank_transfer_list_request, opts)
  data
end

#bank_transfer_list_with_http_info(bank_transfer_list_request, opts = {}) ⇒ Array<(BankTransferListResponse, Integer, Hash)>

List bank transfers Use the &#x60;/bank_transfer/list&#x60; endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired bank transfers.

Parameters:

Returns:

  • (Array<(BankTransferListResponse, Integer, Hash)>) —

    BankTransferListResponse data, response status code and response headers



1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/plaid/api/plaid_api.rb', line 1465

def bank_transfer_list_with_http_info(bank_transfer_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_list ...'
  end
  # verify the required parameter 'bank_transfer_list_request' is set
  if @api_client.config.client_side_validation && bank_transfer_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_list_request' when calling PlaidApi.bank_transfer_list"
  end
  # resource path
  local_var_path = '/bank_transfer/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_migrate_account(bank_transfer_migrate_account_request, opts = {}) ⇒ BankTransferMigrateAccountResponse

Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the ‘/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.

Parameters:

Returns:



1523
1524
1525
1526
 
# File 'lib/plaid/api/plaid_api.rb', line 1523

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#bank_transfer_migrate_account_with_http_info(bank_transfer_migrate_account_request, opts = {}) ⇒ Array<(BankTransferMigrateAccountResponse, Integer, Hash)>

Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the &#x60;/bank_transfer/migrate_account&#x60; 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 &#x60;/accounts/balance/get&#x60;, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/bank_transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.

Parameters:

Returns:



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
 
# File 'lib/plaid/api/plaid_api.rb', line 1533

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_migrate_account ...'
  end
  # verify the required parameter 'bank_transfer_migrate_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_migrate_account_request' when calling PlaidApi.bank_transfer_migrate_account"
  end
  # resource path
  local_var_path = '/bank_transfer/migrate_account'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferMigrateAccountResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_migrate_account",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_sweep_get(bank_transfer_sweep_get_request, opts = {}) ⇒ BankTransferSweepGetResponse

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

Parameters:

Returns:



1591
1592
1593
1594
 
# File 'lib/plaid/api/plaid_api.rb', line 1591

def bank_transfer_sweep_get(bank_transfer_sweep_get_request, opts = {})
  data, _status_code, _headers = bank_transfer_sweep_get_with_http_info(bank_transfer_sweep_get_request, opts)
  data
end

#bank_transfer_sweep_get_with_http_info(bank_transfer_sweep_get_request, opts = {}) ⇒ Array<(BankTransferSweepGetResponse, Integer, Hash)>

Retrieve a sweep The &#x60;/bank_transfer/sweep/get&#x60; endpoint fetches information about the sweep corresponding to the given &#x60;sweep_id&#x60;.

Parameters:

Returns:



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
 
# File 'lib/plaid/api/plaid_api.rb', line 1601

def bank_transfer_sweep_get_with_http_info(bank_transfer_sweep_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_sweep_get ...'
  end
  # verify the required parameter 'bank_transfer_sweep_get_request' is set
  if @api_client.config.client_side_validation && bank_transfer_sweep_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_sweep_get_request' when calling PlaidApi.bank_transfer_sweep_get"
  end
  # resource path
  local_var_path = '/bank_transfer/sweep/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_sweep_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferSweepGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_sweep_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_sweep_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bank_transfer_sweep_list(bank_transfer_sweep_list_request, opts = {}) ⇒ BankTransferSweepListResponse

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

Parameters:

Returns:



1659
1660
1661
1662
 
# File 'lib/plaid/api/plaid_api.rb', line 1659

def bank_transfer_sweep_list(bank_transfer_sweep_list_request, opts = {})
  data, _status_code, _headers = bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts)
  data
end

#bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts = {}) ⇒ Array<(BankTransferSweepListResponse, Integer, Hash)>

List sweeps The &#x60;/bank_transfer/sweep/list&#x60; endpoint fetches information about the sweeps matching the given filters.

Parameters:

Returns:



1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
 
# File 'lib/plaid/api/plaid_api.rb', line 1669

def bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_sweep_list ...'
  end
  # verify the required parameter 'bank_transfer_sweep_list_request' is set
  if @api_client.config.client_side_validation && bank_transfer_sweep_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_sweep_list_request' when calling PlaidApi.bank_transfer_sweep_list"
  end
  # resource path
  local_var_path = '/bank_transfer/sweep/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_sweep_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BankTransferSweepListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.bank_transfer_sweep_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_sweep_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_account_risk_evaluate(beacon_account_risk_evaluate_request, opts = {}) ⇒ BeaconAccountRiskEvaluateResponse

Evaluate risk of a bank account Use ‘/beacon/account_risk/v1/evaluate` to get risk insights for a linked account.

Parameters:

Returns:



1727
1728
1729
1730
 
# File 'lib/plaid/api/plaid_api.rb', line 1727

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#beacon_account_risk_evaluate_with_http_info(beacon_account_risk_evaluate_request, opts = {}) ⇒ Array<(BeaconAccountRiskEvaluateResponse, Integer, Hash)>

Evaluate risk of a bank account Use &#x60;/beacon/account_risk/v1/evaluate&#x60; to get risk insights for a linked account.

Parameters:

Returns:



1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
 
# File 'lib/plaid/api/plaid_api.rb', line 1737

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_account_risk_evaluate ...'
  end
  # verify the required parameter 'beacon_account_risk_evaluate_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'beacon_account_risk_evaluate_request' when calling PlaidApi.beacon_account_risk_evaluate"
  end
  # resource path
  local_var_path = '/beacon/account_risk/v1/evaluate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconAccountRiskEvaluateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_account_risk_evaluate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_account_risk_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_duplicate_get(beacon_duplicate_get_request, opts = {}) ⇒ BeaconDuplicateGetResponse

Get a Beacon Duplicate 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`.

Parameters:

Returns:



1795
1796
1797
1798
 
# File 'lib/plaid/api/plaid_api.rb', line 1795

def beacon_duplicate_get(beacon_duplicate_get_request, opts = {})
  data, _status_code, _headers = beacon_duplicate_get_with_http_info(beacon_duplicate_get_request, opts)
  data
end

#beacon_duplicate_get_with_http_info(beacon_duplicate_get_request, opts = {}) ⇒ Array<(BeaconDuplicateGetResponse, Integer, Hash)>

Get a Beacon Duplicate 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 &#x60;beacon_user1&#x60; or &#x60;beacon_user2&#x60; response fields. The &#x60;analysis&#x60; field in the response indicates which fields matched between &#x60;beacon_user1&#x60; and &#x60;beacon_user2&#x60;.

Parameters:

Returns:

  • (Array<(BeaconDuplicateGetResponse, Integer, Hash)>) —

    BeaconDuplicateGetResponse data, response status code and response headers



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/plaid/api/plaid_api.rb', line 1805

def beacon_duplicate_get_with_http_info(beacon_duplicate_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_duplicate_get ...'
  end
  # verify the required parameter 'beacon_duplicate_get_request' is set
  if @api_client.config.client_side_validation && beacon_duplicate_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_duplicate_get_request' when calling PlaidApi.beacon_duplicate_get"
  end
  # resource path
  local_var_path = '/beacon/duplicate/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_duplicate_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconDuplicateGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_duplicate_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_duplicate_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_report_create(beacon_report_create_request, opts = {}) ⇒ BeaconReportCreateResponse

Create a Beacon Report Create a fraud report for a given Beacon User.

Parameters:

Returns:



1863
1864
1865
1866
 
# File 'lib/plaid/api/plaid_api.rb', line 1863

def beacon_report_create(beacon_report_create_request, opts = {})
  data, _status_code, _headers = beacon_report_create_with_http_info(beacon_report_create_request, opts)
  data
end

#beacon_report_create_with_http_info(beacon_report_create_request, opts = {}) ⇒ Array<(BeaconReportCreateResponse, Integer, Hash)>

Create a Beacon Report Create a fraud report for a given Beacon User.

Parameters:

Returns:

  • (Array<(BeaconReportCreateResponse, Integer, Hash)>) —

    BeaconReportCreateResponse data, response status code and response headers



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
 
# File 'lib/plaid/api/plaid_api.rb', line 1873

def beacon_report_create_with_http_info(beacon_report_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_create ...'
  end
  # verify the required parameter 'beacon_report_create_request' is set
  if @api_client.config.client_side_validation && beacon_report_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_report_create_request' when calling PlaidApi.beacon_report_create"
  end
  # resource path
  local_var_path = '/beacon/report/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconReportCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_report_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_report_get(beacon_report_get_request, opts = {}) ⇒ BeaconReportGetResponse

Get a Beacon Report Returns a Beacon report for a given Beacon report id.

Parameters:

  • beacon_report_get_request (BeaconReportGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1931
1932
1933
1934
 
# File 'lib/plaid/api/plaid_api.rb', line 1931

def beacon_report_get(beacon_report_get_request, opts = {})
  data, _status_code, _headers = beacon_report_get_with_http_info(beacon_report_get_request, opts)
  data
end

#beacon_report_get_with_http_info(beacon_report_get_request, opts = {}) ⇒ Array<(BeaconReportGetResponse, Integer, Hash)>

Get a Beacon Report Returns a Beacon report for a given Beacon report id.

Parameters:

  • beacon_report_get_request (BeaconReportGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BeaconReportGetResponse, Integer, Hash)>) —

    BeaconReportGetResponse data, response status code and response headers



1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
 
# File 'lib/plaid/api/plaid_api.rb', line 1941

def beacon_report_get_with_http_info(beacon_report_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_get ...'
  end
  # verify the required parameter 'beacon_report_get_request' is set
  if @api_client.config.client_side_validation && beacon_report_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_report_get_request' when calling PlaidApi.beacon_report_get"
  end
  # resource path
  local_var_path = '/beacon/report/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconReportGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_report_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_report_list(beacon_report_list_request, opts = {}) ⇒ BeaconReportListResponse

List Beacon Reports for a Beacon User Use the ‘/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.

Parameters:

Returns:



1999
2000
2001
2002
 
# File 'lib/plaid/api/plaid_api.rb', line 1999

def beacon_report_list(beacon_report_list_request, opts = {})
  data, _status_code, _headers = beacon_report_list_with_http_info(beacon_report_list_request, opts)
  data
end

#beacon_report_list_with_http_info(beacon_report_list_request, opts = {}) ⇒ Array<(BeaconReportListResponse, Integer, Hash)>

List Beacon Reports for a Beacon User Use the &#x60;/beacon/report/list&#x60; 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 &#x60;next_cursor&#x60; field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the &#x60;next_cursor&#x60; value as the &#x60;cursor&#x60; parameter in the next request.

Parameters:

Returns:

  • (Array<(BeaconReportListResponse, Integer, Hash)>) —

    BeaconReportListResponse data, response status code and response headers



2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'lib/plaid/api/plaid_api.rb', line 2009

def beacon_report_list_with_http_info(beacon_report_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_list ...'
  end
  # verify the required parameter 'beacon_report_list_request' is set
  if @api_client.config.client_side_validation && beacon_report_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_report_list_request' when calling PlaidApi.beacon_report_list"
  end
  # resource path
  local_var_path = '/beacon/report/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconReportListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_report_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_report_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_report_syndication_get(beacon_report_syndication_get_request, opts = {}) ⇒ BeaconReportSyndicationGetResponse

Get a Beacon Report Syndication Returns a Beacon Report Syndication for a given Beacon Report Syndication id.

Parameters:

Returns:



2067
2068
2069
2070
 
# File 'lib/plaid/api/plaid_api.rb', line 2067

def beacon_report_syndication_get(beacon_report_syndication_get_request, opts = {})
  data, _status_code, _headers = beacon_report_syndication_get_with_http_info(beacon_report_syndication_get_request, opts)
  data
end

#beacon_report_syndication_get_with_http_info(beacon_report_syndication_get_request, opts = {}) ⇒ Array<(BeaconReportSyndicationGetResponse, Integer, Hash)>

Get a Beacon Report Syndication Returns a Beacon Report Syndication for a given Beacon Report Syndication id.

Parameters:

Returns:



2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
 
# File 'lib/plaid/api/plaid_api.rb', line 2077

def beacon_report_syndication_get_with_http_info(beacon_report_syndication_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_syndication_get ...'
  end
  # verify the required parameter 'beacon_report_syndication_get_request' is set
  if @api_client.config.client_side_validation && beacon_report_syndication_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_report_syndication_get_request' when calling PlaidApi.beacon_report_syndication_get"
  end
  # resource path
  local_var_path = '/beacon/report_syndication/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_syndication_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconReportSyndicationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_report_syndication_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_report_syndication_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_report_syndication_list(beacon_report_syndication_list_request, opts = {}) ⇒ BeaconReportSyndicationListResponse

List Beacon Report Syndications for a Beacon User Use the ‘/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.

Parameters:

Returns:



2135
2136
2137
2138
 
# File 'lib/plaid/api/plaid_api.rb', line 2135

def beacon_report_syndication_list(beacon_report_syndication_list_request, opts = {})
  data, _status_code, _headers = beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts)
  data
end

#beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts = {}) ⇒ Array<(BeaconReportSyndicationListResponse, Integer, Hash)>

List Beacon Report Syndications for a Beacon User Use the &#x60;/beacon/report_syndication/list&#x60; 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 &#x60;next_cursor&#x60; field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the &#x60;next_cursor&#x60; value as the &#x60;cursor&#x60; parameter in the next request.

Parameters:

Returns:



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
 
# File 'lib/plaid/api/plaid_api.rb', line 2145

def beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_syndication_list ...'
  end
  # verify the required parameter 'beacon_report_syndication_list_request' is set
  if @api_client.config.client_side_validation && beacon_report_syndication_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_report_syndication_list_request' when calling PlaidApi.beacon_report_syndication_list"
  end
  # resource path
  local_var_path = '/beacon/report_syndication/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_syndication_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconReportSyndicationListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_report_syndication_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_report_syndication_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_user_account_insights_get(beacon_user_account_insights_get_request, opts = {}) ⇒ BeaconUserAccountInsightsGetResponse

Get Account Insights for a Beacon User 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.

Parameters:

Returns:



2203
2204
2205
2206
 
# File 'lib/plaid/api/plaid_api.rb', line 2203

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#beacon_user_account_insights_get_with_http_info(beacon_user_account_insights_get_request, opts = {}) ⇒ Array<(BeaconUserAccountInsightsGetResponse, Integer, Hash)>

Get Account Insights for a Beacon User 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.

Parameters:

Returns:



2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
 
# File 'lib/plaid/api/plaid_api.rb', line 2213

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_account_insights_get ...'
  end
  # verify the required parameter 'beacon_user_account_insights_get_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'beacon_user_account_insights_get_request' when calling PlaidApi.beacon_user_account_insights_get"
  end
  # resource path
  local_var_path = '/beacon/user/account_insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconUserAccountInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_user_account_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_user_account_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_user_create(beacon_user_create_request, opts = {}) ⇒ BeaconUserCreateResponse

Create a Beacon User Create and scan a Beacon User against your Beacon Program, according to your program’s settings. When you submit a new user to ‘/beacon/user/create`, several checks are performed immediately: - The user’s PII (provided within the ‘user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program’s "Duplicate Information Filtering" settings, the user will be returned with a status of ‘pending_review`. - The user’s PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user’s data matches a fraud report that your team created, the user will be returned with a status of ‘rejected`. - Finally, the user’s PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a ‘pending_review` status if your program has enabled automatic flagging based on network fraud.

Parameters:

Returns:



2271
2272
2273
2274
 
# File 'lib/plaid/api/plaid_api.rb', line 2271

def beacon_user_create(beacon_user_create_request, opts = {})
  data, _status_code, _headers = beacon_user_create_with_http_info(beacon_user_create_request, opts)
  data
end

#beacon_user_create_with_http_info(beacon_user_create_request, opts = {}) ⇒ Array<(BeaconUserCreateResponse, Integer, Hash)>

Create a Beacon User Create and scan a Beacon User against your Beacon Program, according to your program&#39;s settings. When you submit a new user to &#x60;/beacon/user/create&#x60;, several checks are performed immediately: - The user&#39;s PII (provided within the &#x60;user&#x60; object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s &quot;Duplicate Information Filtering&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;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 &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud.

Parameters:

Returns:

  • (Array<(BeaconUserCreateResponse, Integer, Hash)>) —

    BeaconUserCreateResponse data, response status code and response headers



2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
 
# File 'lib/plaid/api/plaid_api.rb', line 2281

def beacon_user_create_with_http_info(beacon_user_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_create ...'
  end
  # verify the required parameter 'beacon_user_create_request' is set
  if @api_client.config.client_side_validation && beacon_user_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_user_create_request' when calling PlaidApi.beacon_user_create"
  end
  # resource path
  local_var_path = '/beacon/user/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconUserCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_user_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_user_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_user_get(beacon_user_get_request, opts = {}) ⇒ BeaconUserGetResponse

Get a Beacon User Fetch a Beacon User. The Beacon User is returned with all of their associated information and a ‘status` based on the Beacon Network duplicate record and fraud checks.

Parameters:

  • beacon_user_get_request (BeaconUserGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2339
2340
2341
2342
 
# File 'lib/plaid/api/plaid_api.rb', line 2339

def beacon_user_get(beacon_user_get_request, opts = {})
  data, _status_code, _headers = beacon_user_get_with_http_info(beacon_user_get_request, opts)
  data
end

#beacon_user_get_with_http_info(beacon_user_get_request, opts = {}) ⇒ Array<(BeaconUserGetResponse, Integer, Hash)>

Get a Beacon User Fetch a Beacon User. The Beacon User is returned with all of their associated information and a &#x60;status&#x60; based on the Beacon Network duplicate record and fraud checks.

Parameters:

  • beacon_user_get_request (BeaconUserGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BeaconUserGetResponse, Integer, Hash)>) —

    BeaconUserGetResponse data, response status code and response headers



2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
 
# File 'lib/plaid/api/plaid_api.rb', line 2349

def beacon_user_get_with_http_info(beacon_user_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_get ...'
  end
  # verify the required parameter 'beacon_user_get_request' is set
  if @api_client.config.client_side_validation && beacon_user_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_user_get_request' when calling PlaidApi.beacon_user_get"
  end
  # resource path
  local_var_path = '/beacon/user/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconUserGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_user_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_user_history_list(beacon_user_history_list_request, opts = {}) ⇒ BeaconUserHistoryListResponse

List a Beacon User’s history List all changes to the Beacon User in reverse-chronological order.

Parameters:

Returns:



2407
2408
2409
2410
 
# File 'lib/plaid/api/plaid_api.rb', line 2407

def beacon_user_history_list(beacon_user_history_list_request, opts = {})
  data, _status_code, _headers = beacon_user_history_list_with_http_info(beacon_user_history_list_request, opts)
  data
end

#beacon_user_history_list_with_http_info(beacon_user_history_list_request, opts = {}) ⇒ Array<(BeaconUserHistoryListResponse, Integer, Hash)>

List a Beacon User&#39;s history List all changes to the Beacon User in reverse-chronological order.

Parameters:

Returns:



2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
 
# File 'lib/plaid/api/plaid_api.rb', line 2417

def beacon_user_history_list_with_http_info(beacon_user_history_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_history_list ...'
  end
  # verify the required parameter 'beacon_user_history_list_request' is set
  if @api_client.config.client_side_validation && beacon_user_history_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_user_history_list_request' when calling PlaidApi.beacon_user_history_list"
  end
  # resource path
  local_var_path = '/beacon/user/history/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_history_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconUserHistoryListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_user_history_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_user_history_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_user_review(beacon_user_review_request, opts = {}) ⇒ BeaconUserGetResponse

Review a Beacon User Update the status of a Beacon User. When updating a Beacon User’s status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User’s status to ‘rejected`, we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User’s status to ‘cleared`, we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User’s status to ‘cleared`. There are no restrictions on updating a Beacon User’s status to ‘pending_review`. If these conditions are not met, the request will be rejected with an error explaining the issue.

Parameters:

Returns:



2475
2476
2477
2478
 
# File 'lib/plaid/api/plaid_api.rb', line 2475

def beacon_user_review(beacon_user_review_request, opts = {})
  data, _status_code, _headers = beacon_user_review_with_http_info(beacon_user_review_request, opts)
  data
end

#beacon_user_review_with_http_info(beacon_user_review_request, opts = {}) ⇒ Array<(BeaconUserGetResponse, Integer, Hash)>

Review a Beacon User Update the status of a Beacon User. When updating a Beacon User&#39;s status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User&#39;s status to &#x60;rejected&#x60;, 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&#39;s status to &#x60;cleared&#x60;, 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&#39;s status to &#x60;cleared&#x60;. There are no restrictions on updating a Beacon User&#39;s status to &#x60;pending_review&#x60;. If these conditions are not met, the request will be rejected with an error explaining the issue.

Parameters:

Returns:

  • (Array<(BeaconUserGetResponse, Integer, Hash)>) —

    BeaconUserGetResponse data, response status code and response headers



2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
 
# File 'lib/plaid/api/plaid_api.rb', line 2485

def beacon_user_review_with_http_info(beacon_user_review_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_review ...'
  end
  # verify the required parameter 'beacon_user_review_request' is set
  if @api_client.config.client_side_validation && beacon_user_review_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_user_review_request' when calling PlaidApi.beacon_user_review"
  end
  # resource path
  local_var_path = '/beacon/user/review'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_review_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconUserGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_user_review",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_user_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beacon_user_update(beacon_user_update_request, opts = {}) ⇒ BeaconUserUpdateResponse

Update the identity data of a Beacon User 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.

Parameters:

Returns:



2543
2544
2545
2546
 
# File 'lib/plaid/api/plaid_api.rb', line 2543

def beacon_user_update(beacon_user_update_request, opts = {})
  data, _status_code, _headers = beacon_user_update_with_http_info(beacon_user_update_request, opts)
  data
end

#beacon_user_update_with_http_info(beacon_user_update_request, opts = {}) ⇒ Array<(BeaconUserUpdateResponse, Integer, Hash)>

Update the identity data of a Beacon User Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to &#x60;/beacon/user/create&#x60;, several checks are performed immediately when you submit an identity data change to &#x60;/beacon/user/update&#x60;: - The user&#39;s updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s &quot;Duplicate Information Filtering&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;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 &#x60;pending_review&#x60; 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&#39;s identity data before and after the update is retained as separate versions.

Parameters:

Returns:

  • (Array<(BeaconUserUpdateResponse, Integer, Hash)>) —

    BeaconUserUpdateResponse data, response status code and response headers



2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
 
# File 'lib/plaid/api/plaid_api.rb', line 2553

def beacon_user_update_with_http_info(beacon_user_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_update ...'
  end
  # verify the required parameter 'beacon_user_update_request' is set
  if @api_client.config.client_side_validation && beacon_user_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'beacon_user_update_request' when calling PlaidApi.beacon_user_update"
  end
  # resource path
  local_var_path = '/beacon/user/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BeaconUserUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beacon_user_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beacon_user_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beta_ewa_report_v1_get(beta_ewa_report_v1_get_request, opts = {}) ⇒ BetaEwaReportV1GetResponse

Get EWA Score Report 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.

Parameters:

Returns:



2611
2612
2613
2614
 
# File 'lib/plaid/api/plaid_api.rb', line 2611

def beta_ewa_report_v1_get(beta_ewa_report_v1_get_request, opts = {})
  data, _status_code, _headers = beta_ewa_report_v1_get_with_http_info(beta_ewa_report_v1_get_request, opts)
  data
end

#beta_ewa_report_v1_get_with_http_info(beta_ewa_report_v1_get_request, opts = {}) ⇒ Array<(BetaEwaReportV1GetResponse, Integer, Hash)>

Get EWA Score Report The &#x60;/beta/ewa_report/v1/get&#x60; 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.

Parameters:

Returns:

  • (Array<(BetaEwaReportV1GetResponse, Integer, Hash)>) —

    BetaEwaReportV1GetResponse data, response status code and response headers



2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
 
# File 'lib/plaid/api/plaid_api.rb', line 2621

def beta_ewa_report_v1_get_with_http_info(beta_ewa_report_v1_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beta_ewa_report_v1_get ...'
  end
  # verify the required parameter 'beta_ewa_report_v1_get_request' is set
  if @api_client.config.client_side_validation && beta_ewa_report_v1_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'beta_ewa_report_v1_get_request' when calling PlaidApi.beta_ewa_report_v1_get"
  end
  # resource path
  local_var_path = '/beta/ewa_report/v1/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beta_ewa_report_v1_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BetaEwaReportV1GetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beta_ewa_report_v1_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beta_ewa_report_v1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beta_partner_customer_v1_create(beta_partner_customer_v1_create_request, opts = {}) ⇒ BetaPartnerCustomerV1CreateResponse

Creates a new end customer for a Plaid reseller. 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.

Parameters:

Returns:



2679
2680
2681
2682
 
# File 'lib/plaid/api/plaid_api.rb', line 2679

def beta_partner_customer_v1_create(beta_partner_customer_v1_create_request, opts = {})
  data, _status_code, _headers = beta_partner_customer_v1_create_with_http_info(beta_partner_customer_v1_create_request, opts)
  data
end

#beta_partner_customer_v1_create_with_http_info(beta_partner_customer_v1_create_request, opts = {}) ⇒ Array<(BetaPartnerCustomerV1CreateResponse, Integer, Hash)>

Creates a new end customer for a Plaid reseller. The &#x60;/beta/partner/customer/v1/create&#x60; 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 &#x60;requirements_due&#x60; field of the response.

Parameters:

Returns:



2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
 
# File 'lib/plaid/api/plaid_api.rb', line 2689

def beta_partner_customer_v1_create_with_http_info(beta_partner_customer_v1_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_create ...'
  end
  # verify the required parameter 'beta_partner_customer_v1_create_request' is set
  if @api_client.config.client_side_validation && beta_partner_customer_v1_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'beta_partner_customer_v1_create_request' when calling PlaidApi.beta_partner_customer_v1_create"
  end
  # resource path
  local_var_path = '/beta/partner/customer/v1/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beta_partner_customer_v1_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1CreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beta_partner_customer_v1_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beta_partner_customer_v1_enable(request_body, opts = {}) ⇒ BetaPartnerCustomerV1EnableResponse

Enables a Plaid reseller’s end customer in the Production environment. The ‘/beta/partner/customer/v1/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2747
2748
2749
2750
 
# File 'lib/plaid/api/plaid_api.rb', line 2747

def beta_partner_customer_v1_enable(request_body, opts = {})
  data, _status_code, _headers = beta_partner_customer_v1_enable_with_http_info(request_body, opts)
  data
end

#beta_partner_customer_v1_enable_with_http_info(request_body, opts = {}) ⇒ Array<(BetaPartnerCustomerV1EnableResponse, Integer, Hash)>

Enables a Plaid reseller&#39;s end customer in the Production environment. The &#x60;/beta/partner/customer/v1/enable&#x60; endpoint is used by reseller partners to enable an end customer in the full Production environment.

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
 
# File 'lib/plaid/api/plaid_api.rb', line 2757

def beta_partner_customer_v1_enable_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_enable ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.beta_partner_customer_v1_enable"
  end
  # resource path
  local_var_path = '/beta/partner/customer/v1/enable'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1EnableResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beta_partner_customer_v1_enable",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_enable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beta_partner_customer_v1_get(beta_partner_customer_v1_get_request, opts = {}) ⇒ BetaPartnerCustomerV1GetResponse

Retrieves the details of a Plaid reseller’s end customer. The ‘/beta/partner/customer/v1/get` endpoint is used by reseller partners to retrieve data about a single end customer.

Parameters:

Returns:



2815
2816
2817
2818
 
# File 'lib/plaid/api/plaid_api.rb', line 2815

def beta_partner_customer_v1_get(beta_partner_customer_v1_get_request, opts = {})
  data, _status_code, _headers = beta_partner_customer_v1_get_with_http_info(beta_partner_customer_v1_get_request, opts)
  data
end

#beta_partner_customer_v1_get_with_http_info(beta_partner_customer_v1_get_request, opts = {}) ⇒ Array<(BetaPartnerCustomerV1GetResponse, Integer, Hash)>

Retrieves the details of a Plaid reseller&#39;s end customer. The &#x60;/beta/partner/customer/v1/get&#x60; endpoint is used by reseller partners to retrieve data about a single end customer.

Parameters:

Returns:



2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/plaid/api/plaid_api.rb', line 2825

def beta_partner_customer_v1_get_with_http_info(beta_partner_customer_v1_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_get ...'
  end
  # verify the required parameter 'beta_partner_customer_v1_get_request' is set
  if @api_client.config.client_side_validation && beta_partner_customer_v1_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'beta_partner_customer_v1_get_request' when calling PlaidApi.beta_partner_customer_v1_get"
  end
  # resource path
  local_var_path = '/beta/partner/customer/v1/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(beta_partner_customer_v1_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1GetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beta_partner_customer_v1_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#beta_partner_customer_v1_update(request_body, opts = {}) ⇒ BetaPartnerCustomerV1UpdateResponse

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

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2883
2884
2885
2886
 
# File 'lib/plaid/api/plaid_api.rb', line 2883

def beta_partner_customer_v1_update(request_body, opts = {})
  data, _status_code, _headers = beta_partner_customer_v1_update_with_http_info(request_body, opts)
  data
end

#beta_partner_customer_v1_update_with_http_info(request_body, opts = {}) ⇒ Array<(BetaPartnerCustomerV1UpdateResponse, Integer, Hash)>

Updates an existing end customer. The &#x60;/beta/partner/customer/v1/update&#x60; endpoint updates an existing end customer record.

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
 
# File 'lib/plaid/api/plaid_api.rb', line 2893

def beta_partner_customer_v1_update_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_update ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.beta_partner_customer_v1_update"
  end
  # resource path
  local_var_path = '/beta/partner/customer/v1/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1UpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.beta_partner_customer_v1_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#business_verification_create(business_verification_create_request, opts = {}) ⇒ BusinessVerificationCreateResponse

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

Parameters:

Returns:



2951
2952
2953
2954
 
# File 'lib/plaid/api/plaid_api.rb', line 2951

def business_verification_create(business_verification_create_request, opts = {})
  data, _status_code, _headers = business_verification_create_with_http_info(business_verification_create_request, opts)
  data
end

#business_verification_create_with_http_info(business_verification_create_request, opts = {}) ⇒ Array<(BusinessVerificationCreateResponse, Integer, Hash)>

Create a business verification Create a new business verification to check a business&#39;s identity and risk profile.

Parameters:

Returns:



2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
 
# File 'lib/plaid/api/plaid_api.rb', line 2961

def business_verification_create_with_http_info(business_verification_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.business_verification_create ...'
  end
  # verify the required parameter 'business_verification_create_request' is set
  if @api_client.config.client_side_validation && business_verification_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'business_verification_create_request' when calling PlaidApi.business_verification_create"
  end
  # resource path
  local_var_path = '/business_verification/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(business_verification_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BusinessVerificationCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.business_verification_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#business_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#business_verification_get(business_verification_get_request, opts = {}) ⇒ BusinessVerificationGetResponse

Get a business verification Retrieve the current state of a specific business verification.

Parameters:

Returns:



3019
3020
3021
3022
 
# File 'lib/plaid/api/plaid_api.rb', line 3019

def business_verification_get(business_verification_get_request, opts = {})
  data, _status_code, _headers = business_verification_get_with_http_info(business_verification_get_request, opts)
  data
end

#business_verification_get_with_http_info(business_verification_get_request, opts = {}) ⇒ Array<(BusinessVerificationGetResponse, Integer, Hash)>

Get a business verification Retrieve the current state of a specific business verification.

Parameters:

Returns:



3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
 
# File 'lib/plaid/api/plaid_api.rb', line 3029

def business_verification_get_with_http_info(business_verification_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.business_verification_get ...'
  end
  # verify the required parameter 'business_verification_get_request' is set
  if @api_client.config.client_side_validation && business_verification_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'business_verification_get_request' when calling PlaidApi.business_verification_get"
  end
  # resource path
  local_var_path = '/business_verification/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(business_verification_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'BusinessVerificationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.business_verification_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#business_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cashflow_report_get(cashflow_report_get_request, opts = {}) ⇒ CashflowReportGetResponse

Gets transaction data in ‘cashflow_report` 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/#pending-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.

Parameters:

Returns:



3087
3088
3089
3090
 
# File 'lib/plaid/api/plaid_api.rb', line 3087

def cashflow_report_get(cashflow_report_get_request, opts = {})
  data, _status_code, _headers = cashflow_report_get_with_http_info(cashflow_report_get_request, opts)
  data
end

#cashflow_report_get_with_http_info(cashflow_report_get_request, opts = {}) ⇒ Array<(CashflowReportGetResponse, Integer, Hash)>

Gets transaction data in &#x60;cashflow_report&#x60; The &#x60;/cashflow_report/get&#x60; 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 &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;cashflow_report&#x60;, or if it wasn&#39;t, upon the first call to &#x60;/cashflow_report/refresh&#x60;. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.

Parameters:

Returns:

  • (Array<(CashflowReportGetResponse, Integer, Hash)>) —

    CashflowReportGetResponse data, response status code and response headers



3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
 
# File 'lib/plaid/api/plaid_api.rb', line 3097

def cashflow_report_get_with_http_info(cashflow_report_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_get ...'
  end
  # verify the required parameter 'cashflow_report_get_request' is set
  if @api_client.config.client_side_validation && cashflow_report_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cashflow_report_get_request' when calling PlaidApi.cashflow_report_get"
  end
  # resource path
  local_var_path = '/cashflow_report/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CashflowReportGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cashflow_report_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cashflow_report_insights_get(cashflow_report_insights_get_request, opts = {}) ⇒ CashflowReportInsightsGetResponse

Gets insights data in Cashflow Report The ‘/cashflow_report/insights/get` endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts.

Parameters:

Returns:



3155
3156
3157
3158
 
# File 'lib/plaid/api/plaid_api.rb', line 3155

def cashflow_report_insights_get(cashflow_report_insights_get_request, opts = {})
  data, _status_code, _headers = cashflow_report_insights_get_with_http_info(cashflow_report_insights_get_request, opts)
  data
end

#cashflow_report_insights_get_with_http_info(cashflow_report_insights_get_request, opts = {}) ⇒ Array<(CashflowReportInsightsGetResponse, Integer, Hash)>

Gets insights data in Cashflow Report The &#x60;/cashflow_report/insights/get&#x60; endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts.

Parameters:

Returns:



3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
 
# File 'lib/plaid/api/plaid_api.rb', line 3165

def cashflow_report_insights_get_with_http_info(cashflow_report_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_insights_get ...'
  end
  # verify the required parameter 'cashflow_report_insights_get_request' is set
  if @api_client.config.client_side_validation && cashflow_report_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cashflow_report_insights_get_request' when calling PlaidApi.cashflow_report_insights_get"
  end
  # resource path
  local_var_path = '/cashflow_report/insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CashflowReportInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cashflow_report_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cashflow_report_refresh(cashflow_report_refresh_request, opts = {}) ⇒ CashflowReportRefreshResponse

Refresh transaction data in ‘cashflow_report` `/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.

Parameters:

Returns:



3223
3224
3225
3226
 
# File 'lib/plaid/api/plaid_api.rb', line 3223

def cashflow_report_refresh(cashflow_report_refresh_request, opts = {})
  data, _status_code, _headers = cashflow_report_refresh_with_http_info(cashflow_report_refresh_request, opts)
  data
end

#cashflow_report_refresh_with_http_info(cashflow_report_refresh_request, opts = {}) ⇒ Array<(CashflowReportRefreshResponse, Integer, Hash)>

Refresh transaction data in &#x60;cashflow_report&#x60; &#x60;/cashflow_report/refresh&#x60; is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an &#x60;item_id&#x60;). The item must already have Cashflow Report added as a product in order to call &#x60;/cashflow_report/refresh&#x60;. After calling &#x60;/cashflow_report/refresh&#x60;, Plaid will fire a webhook &#x60;CASHFLOW_REPORT_READY&#x60; alerting clients that new transactions data can then be ingested via &#x60;/cashflow_report/get&#x60; or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the &#x60;/cashflow_report/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; 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.

Parameters:

Returns:



3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
 
# File 'lib/plaid/api/plaid_api.rb', line 3233

def cashflow_report_refresh_with_http_info(cashflow_report_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_refresh ...'
  end
  # verify the required parameter 'cashflow_report_refresh_request' is set
  if @api_client.config.client_side_validation && cashflow_report_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'cashflow_report_refresh_request' when calling PlaidApi.cashflow_report_refresh"
  end
  # resource path
  local_var_path = '/cashflow_report/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CashflowReportRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cashflow_report_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cashflow_report_transactions_get(cashflow_report_transactions_get_request, opts = {}) ⇒ CashflowReportTransactionsGetResponse

Gets transaction data in cashflow_report 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/#pending-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.

Parameters:

Returns:



3291
3292
3293
3294
 
# File 'lib/plaid/api/plaid_api.rb', line 3291

def cashflow_report_transactions_get(cashflow_report_transactions_get_request, opts = {})
  data, _status_code, _headers = cashflow_report_transactions_get_with_http_info(cashflow_report_transactions_get_request, opts)
  data
end

#cashflow_report_transactions_get_with_http_info(cashflow_report_transactions_get_request, opts = {}) ⇒ Array<(CashflowReportTransactionsGetResponse, Integer, Hash)>

Gets transaction data in cashflow_report The &#x60;/cashflow_report/transactions/get&#x60; 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 &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;cashflow_report&#x60;, or if it wasn&#39;t, upon the first call to &#x60;/cashflow_report/refresh&#x60;. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.

Parameters:

Returns:



3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
 
# File 'lib/plaid/api/plaid_api.rb', line 3301

def cashflow_report_transactions_get_with_http_info(cashflow_report_transactions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_transactions_get ...'
  end
  # verify the required parameter 'cashflow_report_transactions_get_request' is set
  if @api_client.config.client_side_validation && cashflow_report_transactions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cashflow_report_transactions_get_request' when calling PlaidApi.cashflow_report_transactions_get"
  end
  # resource path
  local_var_path = '/cashflow_report/transactions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_transactions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CashflowReportTransactionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cashflow_report_transactions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#categories_get(body, opts = {}) ⇒ CategoriesGetResponse

(Deprecated) Get legacy categories 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)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3359
3360
3361
3362
 
# File 'lib/plaid/api/plaid_api.rb', line 3359

def categories_get(body, opts = {})
  data, _status_code, _headers = categories_get_with_http_info(body, opts)
  data
end

#categories_get_with_http_info(body, opts = {}) ⇒ Array<(CategoriesGetResponse, Integer, Hash)>

(Deprecated) Get legacy categories Send a request to the &#x60;/categories/get&#x60; 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 &#x60;personal_finance_category&#x60; taxonomy](plaid.com/docs/transactions/pfc-migration/) instead of the legacy &#x60;category&#x60; taxonomy supported by this endpoint.

Parameters:

  • body (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CategoriesGetResponse, Integer, Hash)>) —

    CategoriesGetResponse data, response status code and response headers



3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/plaid/api/plaid_api.rb', line 3369

def categories_get_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.categories_get ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PlaidApi.categories_get"
  end
  # resource path
  local_var_path = '/categories/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'CategoriesGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"PlaidApi.categories_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consent_events_get(consent_events_get_request, opts = {}) ⇒ ConsentEventsGetResponse

List a historical log of item consent events 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.

Parameters:

Returns:



3427
3428
3429
3430
 
# File 'lib/plaid/api/plaid_api.rb', line 3427

def consent_events_get(consent_events_get_request, opts = {})
  data, _status_code, _headers = consent_events_get_with_http_info(consent_events_get_request, opts)
  data
end

#consent_events_get_with_http_info(consent_events_get_request, opts = {}) ⇒ Array<(ConsentEventsGetResponse, Integer, Hash)>

List a historical log of item consent events 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.

Parameters:

Returns:

  • (Array<(ConsentEventsGetResponse, Integer, Hash)>) —

    ConsentEventsGetResponse data, response status code and response headers



3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
 
# File 'lib/plaid/api/plaid_api.rb', line 3437

def consent_events_get_with_http_info(consent_events_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
  end
  # verify the required parameter 'consent_events_get_request' is set
  if @api_client.config.client_side_validation && consent_events_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'consent_events_get_request' when calling PlaidApi.consent_events_get"
  end
  # resource path
  local_var_path = '/consent/events/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(consent_events_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.consent_events_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#consent_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {}) ⇒ File

Retrieve a PDF Reports 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.

Parameters:

Returns:

  • (File) 


3495
3496
3497
3498
 
# File 'lib/plaid/api/plaid_api.rb', line 3495

def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
  data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
  data
end

#consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve a PDF Reports Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
 
# File 'lib/plaid/api/plaid_api.rb', line 3505

def consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
  end
  # verify the required parameter 'consumer_report_pdf_get_request' is set
  if @api_client.config.client_side_validation && consumer_report_pdf_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'consumer_report_pdf_get_request' when calling PlaidApi.consumer_report_pdf_get"
  end
  # resource path
  local_var_path = '/consumer_report/pdf/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(consumer_report_pdf_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.consumer_report_pdf_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_base_report_get(cra_check_report_base_report_get_request, opts = {}) ⇒ CraCheckReportBaseReportGetResponse

Retrieve a Base Report 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`.

Parameters:

Returns:



3563
3564
3565
3566
 
# File 'lib/plaid/api/plaid_api.rb', line 3563

def cra_check_report_base_report_get(cra_check_report_base_report_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts)
  data
end

#cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts = {}) ⇒ Array<(CraCheckReportBaseReportGetResponse, Integer, Hash)>

Retrieve a Base Report 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&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn&#39;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 &#x60;/cra/check_report/create&#x60;.

Parameters:

Returns:



3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
 
# File 'lib/plaid/api/plaid_api.rb', line 3573

def cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_base_report_get ...'
  end
  # verify the required parameter 'cra_check_report_base_report_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_base_report_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_base_report_get_request' when calling PlaidApi.cra_check_report_base_report_get"
  end
  # resource path
  local_var_path = '/cra/check_report/base_report/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_base_report_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportBaseReportGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_base_report_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_cashflow_insights_get(cra_check_report_cashflow_insights_get_request, opts = {}) ⇒ CraCheckReportCashflowInsightsGetResponse

Retrieve cash flow insights from your user’s banking data 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.

Parameters:

Returns:



3631
3632
3633
3634
 
# File 'lib/plaid/api/plaid_api.rb', line 3631

def cra_check_report_cashflow_insights_get(cra_check_report_cashflow_insights_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_cashflow_insights_get_with_http_info(cra_check_report_cashflow_insights_get_request, opts)
  data
end

#cra_check_report_cashflow_insights_get_with_http_info(cra_check_report_cashflow_insights_get_request, opts = {}) ⇒ Array<(CraCheckReportCashflowInsightsGetResponse, Integer, Hash)>

Retrieve cash flow insights from your user&#39;s banking data This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. 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 &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;cra_cashflow_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.

Parameters:

Returns:



3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
 
# File 'lib/plaid/api/plaid_api.rb', line 3641

def cra_check_report_cashflow_insights_get_with_http_info(cra_check_report_cashflow_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_cashflow_insights_get ...'
  end
  # verify the required parameter 'cra_check_report_cashflow_insights_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_cashflow_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_cashflow_insights_get_request' when calling PlaidApi.cra_check_report_cashflow_insights_get"
  end
  # resource path
  local_var_path = '/cra/check_report/cashflow_insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_cashflow_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportCashflowInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_cashflow_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_cashflow_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_create(cra_check_report_create_request, opts = {}) ⇒ CraCheckReportCreateResponse

Refresh or create a Consumer Report 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.

Parameters:

Returns:



3699
3700
3701
3702
 
# File 'lib/plaid/api/plaid_api.rb', line 3699

def cra_check_report_create(cra_check_report_create_request, opts = {})
  data, _status_code, _headers = cra_check_report_create_with_http_info(cra_check_report_create_request, opts)
  data
end

#cra_check_report_create_with_http_info(cra_check_report_create_request, opts = {}) ⇒ Array<(CraCheckReportCreateResponse, Integer, Hash)>

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

Parameters:

Returns:



3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'lib/plaid/api/plaid_api.rb', line 3709

def cra_check_report_create_with_http_info(cra_check_report_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_create ...'
  end
  # verify the required parameter 'cra_check_report_create_request' is set
  if @api_client.config.client_side_validation && cra_check_report_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_create_request' when calling PlaidApi.cra_check_report_create"
  end
  # resource path
  local_var_path = '/cra/check_report/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_income_insights_get(cra_check_report_income_insights_get_request, opts = {}) ⇒ CraCheckReportIncomeInsightsGetResponse

Retrieve cash flow information from your user’s banks 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-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.36c85n2ircqk#heading=h.79dwr5c1iszl).

Parameters:

Returns:



3767
3768
3769
3770
 
# File 'lib/plaid/api/plaid_api.rb', line 3767

def cra_check_report_income_insights_get(cra_check_report_income_insights_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_income_insights_get_with_http_info(cra_check_report_income_insights_get_request, opts)
  data
end

#cra_check_report_income_insights_get_with_http_info(cra_check_report_income_insights_get_request, opts = {}) ⇒ Array<(CraCheckReportIncomeInsightsGetResponse, Integer, Hash)>

Retrieve cash flow information from your user&#39;s banks This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you’ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. 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 &#x60;/cra/check_report/create&#x60;. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is &quot;II2&quot;. Please see [this document](docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.0#heading&#x3D;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&#x3D;t.0#bookmark&#x3D;id.tdcc2wpk0h60) for an example II1 response along with its [documentation](docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.36c85n2ircqk#heading&#x3D;h.79dwr5c1iszl).

Parameters:

Returns:



3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
 
# File 'lib/plaid/api/plaid_api.rb', line 3777

def cra_check_report_income_insights_get_with_http_info(cra_check_report_income_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_income_insights_get ...'
  end
  # verify the required parameter 'cra_check_report_income_insights_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_income_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_income_insights_get_request' when calling PlaidApi.cra_check_report_income_insights_get"
  end
  # resource path
  local_var_path = '/cra/check_report/income_insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_income_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportIncomeInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_income_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_income_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_lend_score_get(cra_check_report_lend_score_get_request, opts = {}) ⇒ CraCheckReportLendScoreGetResponse

Retrieve the LendScore from your user’s banking data 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.

Parameters:

Returns:



3835
3836
3837
3838
 
# File 'lib/plaid/api/plaid_api.rb', line 3835

def cra_check_report_lend_score_get(cra_check_report_lend_score_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_lend_score_get_with_http_info(cra_check_report_lend_score_get_request, opts)
  data
end

#cra_check_report_lend_score_get_with_http_info(cra_check_report_lend_score_get_request, opts = {}) ⇒ Array<(CraCheckReportLendScoreGetResponse, Integer, Hash)>

Retrieve the LendScore from your user&#39;s banking data This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. 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 &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;cra_lend_score&#x60; product or call &#x60;/cra/check_report/create&#x60; with the &#x60;cra_lend_score&#x60; product, Plaid will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.

Parameters:

Returns:



3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
 
# File 'lib/plaid/api/plaid_api.rb', line 3845

def cra_check_report_lend_score_get_with_http_info(cra_check_report_lend_score_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_lend_score_get ...'
  end
  # verify the required parameter 'cra_check_report_lend_score_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_lend_score_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_lend_score_get_request' when calling PlaidApi.cra_check_report_lend_score_get"
  end
  # resource path
  local_var_path = '/cra/check_report/lend_score/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_lend_score_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportLendScoreGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_lend_score_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_lend_score_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_network_insights_get(cra_check_report_network_insights_get_request, opts = {}) ⇒ CraCheckReportNetworkInsightsGetResponse

Retrieve network attributes for the user 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.

Parameters:

Returns:



3903
3904
3905
3906
 
# File 'lib/plaid/api/plaid_api.rb', line 3903

def cra_check_report_network_insights_get(cra_check_report_network_insights_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts)
  data
end

#cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts = {}) ⇒ Array<(CraCheckReportNetworkInsightsGetResponse, Integer, Hash)>

Retrieve network attributes for the user This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. 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 &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;cra_network_attributes&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, Plaid will generate the attributes when you call this endpoint.

Parameters:

Returns:



3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
 
# File 'lib/plaid/api/plaid_api.rb', line 3913

def cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_network_insights_get ...'
  end
  # verify the required parameter 'cra_check_report_network_insights_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_network_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_network_insights_get_request' when calling PlaidApi.cra_check_report_network_insights_get"
  end
  # resource path
  local_var_path = '/cra/check_report/network_insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_network_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportNetworkInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_network_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_network_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_partner_insights_get(cra_check_report_partner_insights_get_request, opts = {}) ⇒ CraCheckReportPartnerInsightsGetResponse

Retrieve cash flow insights from partners 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.

Parameters:

Returns:



3971
3972
3973
3974
 
# File 'lib/plaid/api/plaid_api.rb', line 3971

def cra_check_report_partner_insights_get(cra_check_report_partner_insights_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_partner_insights_get_with_http_info(cra_check_report_partner_insights_get_request, opts)
  data
end

#cra_check_report_partner_insights_get_with_http_info(cra_check_report_partner_insights_get_request, opts = {}) ⇒ Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>

Retrieve cash flow insights from partners This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. 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 &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;credit_partner_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.

Parameters:

Returns:



3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
 
# File 'lib/plaid/api/plaid_api.rb', line 3981

def cra_check_report_partner_insights_get_with_http_info(cra_check_report_partner_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_partner_insights_get ...'
  end
  # verify the required parameter 'cra_check_report_partner_insights_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_partner_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_partner_insights_get_request' when calling PlaidApi.cra_check_report_partner_insights_get"
  end
  # resource path
  local_var_path = '/cra/check_report/partner_insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_partner_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportPartnerInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_partner_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_partner_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_pdf_get(cra_check_report_pdf_get_request, opts = {}) ⇒ File

Retrieve Consumer Reports as a PDF ‘/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.

Parameters:

Returns:

  • (File) 


4039
4040
4041
4042
 
# File 'lib/plaid/api/plaid_api.rb', line 4039

def cra_check_report_pdf_get(cra_check_report_pdf_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, opts)
  data
end

#cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve Consumer Reports as a PDF &#x60;/cra/check_report/pdf/get&#x60; 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 &#x60;add-ons&#x60; field.

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
 
# File 'lib/plaid/api/plaid_api.rb', line 4049

def cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_pdf_get ...'
  end
  # verify the required parameter 'cra_check_report_pdf_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_pdf_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_pdf_get_request' when calling PlaidApi.cra_check_report_pdf_get"
  end
  # resource path
  local_var_path = '/cra/check_report/pdf/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_pdf_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_pdf_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_verification_get(cra_check_report_verification_get_request, opts = {}) ⇒ CraCheckReportVerificationGetResponse

Retrieve various home lending reports for a user. 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`."

Parameters:

Returns:



4107
4108
4109
4110
 
# File 'lib/plaid/api/plaid_api.rb', line 4107

def cra_check_report_verification_get(cra_check_report_verification_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_verification_get_with_http_info(cra_check_report_verification_get_request, opts)
  data
end

#cra_check_report_verification_get_with_http_info(cra_check_report_verification_get_request, opts = {}) ⇒ Array<(CraCheckReportVerificationGetResponse, Integer, Hash)>

Retrieve various home lending reports for a user. 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 &#x60;cra_base_report&#x60; is included in the &#x60;products&#x60; parameter when calling &#x60;/link/token/create&#x60; or &#x60;/cra/check_report/create&#x60;. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. 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 &#x60;/cra/check_report/create&#x60;.&quot;

Parameters:

Returns:



4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
 
# File 'lib/plaid/api/plaid_api.rb', line 4117

def cra_check_report_verification_get_with_http_info(cra_check_report_verification_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_verification_get ...'
  end
  # verify the required parameter 'cra_check_report_verification_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_verification_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_verification_get_request' when calling PlaidApi.cra_check_report_verification_get"
  end
  # resource path
  local_var_path = '/cra/check_report/verification/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_verification_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraCheckReportVerificationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_verification_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_check_report_verification_pdf_get(cra_check_report_verification_pdf_get_request, opts = {}) ⇒ File

Retrieve Consumer Reports as a Verification PDF 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.

Parameters:

Returns:

  • (File) 


4175
4176
4177
4178
 
# File 'lib/plaid/api/plaid_api.rb', line 4175

def cra_check_report_verification_pdf_get(cra_check_report_verification_pdf_get_request, opts = {})
  data, _status_code, _headers = cra_check_report_verification_pdf_get_with_http_info(cra_check_report_verification_pdf_get_request, opts)
  data
end

#cra_check_report_verification_pdf_get_with_http_info(cra_check_report_verification_pdf_get_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve Consumer Reports as a Verification PDF The &#x60;/cra/check_report/verification/pdf/get&#x60; 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&#39;ve created a VOA report through Link or the &#x60;/cra/check_report/create&#x60; endpoint, and have received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook. The response to &#x60;/cra/check_report/verification/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
 
# File 'lib/plaid/api/plaid_api.rb', line 4185

def cra_check_report_verification_pdf_get_with_http_info(cra_check_report_verification_pdf_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_verification_pdf_get ...'
  end
  # verify the required parameter 'cra_check_report_verification_pdf_get_request' is set
  if @api_client.config.client_side_validation && cra_check_report_verification_pdf_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_check_report_verification_pdf_get_request' when calling PlaidApi.cra_check_report_verification_pdf_get"
  end
  # resource path
  local_var_path = '/cra/check_report/verification/pdf/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_verification_pdf_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_check_report_verification_pdf_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_verification_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_loans_applications_register(cra_loans_applications_register_request, opts = {}) ⇒ CraLoansApplicationsRegisterResponse

Register loan applications and decisions. ‘/cra/loans/applications/register` registers loan applications and decisions.

Parameters:

Returns:



4243
4244
4245
4246
 
# File 'lib/plaid/api/plaid_api.rb', line 4243

def cra_loans_applications_register(cra_loans_applications_register_request, opts = {})
  data, _status_code, _headers = cra_loans_applications_register_with_http_info(cra_loans_applications_register_request, opts)
  data
end

#cra_loans_applications_register_with_http_info(cra_loans_applications_register_request, opts = {}) ⇒ Array<(CraLoansApplicationsRegisterResponse, Integer, Hash)>

Register loan applications and decisions. &#x60;/cra/loans/applications/register&#x60; registers loan applications and decisions.

Parameters:

Returns:



4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/plaid/api/plaid_api.rb', line 4253

def cra_loans_applications_register_with_http_info(cra_loans_applications_register_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_applications_register ...'
  end
  # verify the required parameter 'cra_loans_applications_register_request' is set
  if @api_client.config.client_side_validation && cra_loans_applications_register_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_loans_applications_register_request' when calling PlaidApi.cra_loans_applications_register"
  end
  # resource path
  local_var_path = '/cra/loans/applications/register'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_applications_register_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraLoansApplicationsRegisterResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_loans_applications_register",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_loans_applications_register\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_loans_register(cra_loans_register_request, opts = {}) ⇒ CraLoansRegisterResponse

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

Parameters:

Returns:



4311
4312
4313
4314
 
# File 'lib/plaid/api/plaid_api.rb', line 4311

def cra_loans_register(cra_loans_register_request, opts = {})
  data, _status_code, _headers = cra_loans_register_with_http_info(cra_loans_register_request, opts)
  data
end

#cra_loans_register_with_http_info(cra_loans_register_request, opts = {}) ⇒ Array<(CraLoansRegisterResponse, Integer, Hash)>

Register a list of loans to their applicants. &#x60;/cra/loans/register&#x60; registers a list of loans to their applicants.

Parameters:

Returns:

  • (Array<(CraLoansRegisterResponse, Integer, Hash)>) —

    CraLoansRegisterResponse data, response status code and response headers



4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
 
# File 'lib/plaid/api/plaid_api.rb', line 4321

def cra_loans_register_with_http_info(cra_loans_register_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_register ...'
  end
  # verify the required parameter 'cra_loans_register_request' is set
  if @api_client.config.client_side_validation && cra_loans_register_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_loans_register_request' when calling PlaidApi.cra_loans_register"
  end
  # resource path
  local_var_path = '/cra/loans/register'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_register_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraLoansRegisterResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_loans_register",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_loans_register\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_loans_unregister(cra_loans_unregister_request, opts = {}) ⇒ CraLoanUnregisterResponse

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

Parameters:

Returns:



4379
4380
4381
4382
 
# File 'lib/plaid/api/plaid_api.rb', line 4379

def cra_loans_unregister(cra_loans_unregister_request, opts = {})
  data, _status_code, _headers = cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts)
  data
end

#cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts = {}) ⇒ Array<(CraLoanUnregisterResponse, Integer, Hash)>

Unregister a list of loans. &#x60;/cra/loans/unregister&#x60; indicates the loans have reached a final status and no further updates are expected.

Parameters:

Returns:

  • (Array<(CraLoanUnregisterResponse, Integer, Hash)>) —

    CraLoanUnregisterResponse data, response status code and response headers



4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'lib/plaid/api/plaid_api.rb', line 4389

def cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_unregister ...'
  end
  # verify the required parameter 'cra_loans_unregister_request' is set
  if @api_client.config.client_side_validation && cra_loans_unregister_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_loans_unregister_request' when calling PlaidApi.cra_loans_unregister"
  end
  # resource path
  local_var_path = '/cra/loans/unregister'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_unregister_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraLoanUnregisterResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_loans_unregister",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_loans_unregister\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_loans_update(cra_loans_update_request, opts = {}) ⇒ CraLoansUpdateResponse

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

Parameters:

  • cra_loans_update_request (CraLoansUpdateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4447
4448
4449
4450
 
# File 'lib/plaid/api/plaid_api.rb', line 4447

def cra_loans_update(cra_loans_update_request, opts = {})
  data, _status_code, _headers = cra_loans_update_with_http_info(cra_loans_update_request, opts)
  data
end

#cra_loans_update_with_http_info(cra_loans_update_request, opts = {}) ⇒ Array<(CraLoansUpdateResponse, Integer, Hash)>

Updates loan data. &#x60;/cra/loans/update&#x60; updates loan information such as the status and payment history.

Parameters:

  • cra_loans_update_request (CraLoansUpdateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CraLoansUpdateResponse, Integer, Hash)>) —

    CraLoansUpdateResponse data, response status code and response headers



4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
 
# File 'lib/plaid/api/plaid_api.rb', line 4457

def cra_loans_update_with_http_info(cra_loans_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_update ...'
  end
  # verify the required parameter 'cra_loans_update_request' is set
  if @api_client.config.client_side_validation && cra_loans_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_loans_update_request' when calling PlaidApi.cra_loans_update"
  end
  # resource path
  local_var_path = '/cra/loans/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraLoansUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_loans_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_loans_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_monitoring_insights_get(cra_monitoring_insights_get_request, opts = {}) ⇒ CraMonitoringInsightsGetResponse

Retrieve a Monitoring Insights Report This endpoint allows you to retrieve a Cash Flow Updates report by passing in the ‘user_id` referred to in the webhook you received.

Parameters:

Returns:



4515
4516
4517
4518
 
# File 'lib/plaid/api/plaid_api.rb', line 4515

def cra_monitoring_insights_get(cra_monitoring_insights_get_request, opts = {})
  data, _status_code, _headers = cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts)
  data
end

#cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts = {}) ⇒ Array<(CraMonitoringInsightsGetResponse, Integer, Hash)>

Retrieve a Monitoring Insights Report This endpoint allows you to retrieve a Cash Flow Updates report by passing in the &#x60;user_id&#x60; referred to in the webhook you received.

Parameters:

Returns:



4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
 
# File 'lib/plaid/api/plaid_api.rb', line 4525

def cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_get ...'
  end
  # verify the required parameter 'cra_monitoring_insights_get_request' is set
  if @api_client.config.client_side_validation && cra_monitoring_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_get_request' when calling PlaidApi.cra_monitoring_insights_get"
  end
  # resource path
  local_var_path = '/cra/monitoring_insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraMonitoringInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_monitoring_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_monitoring_insights_subscribe(cra_monitoring_insights_subscribe_request, opts = {}) ⇒ CraMonitoringInsightsSubscribeResponse

Subscribe to Monitoring Insights 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.

Parameters:

Returns:



4583
4584
4585
4586
 
# File 'lib/plaid/api/plaid_api.rb', line 4583

def cra_monitoring_insights_subscribe(cra_monitoring_insights_subscribe_request, opts = {})
  data, _status_code, _headers = cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts)
  data
end

#cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts = {}) ⇒ Array<(CraMonitoringInsightsSubscribeResponse, Integer, Hash)>

Subscribe to Monitoring Insights This endpoint allows you to subscribe to insights for a user&#39;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.

Parameters:

Returns:



4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
 
# File 'lib/plaid/api/plaid_api.rb', line 4593

def cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_subscribe ...'
  end
  # verify the required parameter 'cra_monitoring_insights_subscribe_request' is set
  if @api_client.config.client_side_validation && cra_monitoring_insights_subscribe_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_subscribe_request' when calling PlaidApi.cra_monitoring_insights_subscribe"
  end
  # resource path
  local_var_path = '/cra/monitoring_insights/subscribe'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_subscribe_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraMonitoringInsightsSubscribeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_monitoring_insights_subscribe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_monitoring_insights_unsubscribe(cra_monitoring_insights_unsubscribe_request, opts = {}) ⇒ CraMonitoringInsightsUnsubscribeResponse

Unsubscribe from Monitoring Insights This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.

Parameters:

Returns:



4651
4652
4653
4654
 
# File 'lib/plaid/api/plaid_api.rb', line 4651

def cra_monitoring_insights_unsubscribe(cra_monitoring_insights_unsubscribe_request, opts = {})
  data, _status_code, _headers = cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts)
  data
end

#cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts = {}) ⇒ Array<(CraMonitoringInsightsUnsubscribeResponse, Integer, Hash)>

Unsubscribe from Monitoring Insights This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.

Parameters:

Returns:



4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
 
# File 'lib/plaid/api/plaid_api.rb', line 4661

def cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_unsubscribe ...'
  end
  # verify the required parameter 'cra_monitoring_insights_unsubscribe_request' is set
  if @api_client.config.client_side_validation && cra_monitoring_insights_unsubscribe_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_unsubscribe_request' when calling PlaidApi.cra_monitoring_insights_unsubscribe"
  end
  # resource path
  local_var_path = '/cra/monitoring_insights/unsubscribe'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_unsubscribe_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraMonitoringInsightsUnsubscribeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_monitoring_insights_unsubscribe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cra_partner_insights_get(cra_partner_insights_get_request, opts = {}) ⇒ CraPartnerInsightsGetResponse

Retrieve cash flow insights from the bank accounts used for income verification ‘/cra/partner_insights/get` returns cash flow insights for a specified user.

Parameters:

Returns:



4719
4720
4721
4722
 
# File 'lib/plaid/api/plaid_api.rb', line 4719

def cra_partner_insights_get(cra_partner_insights_get_request, opts = {})
  data, _status_code, _headers = cra_partner_insights_get_with_http_info(cra_partner_insights_get_request, opts)
  data
end

#cra_partner_insights_get_with_http_info(cra_partner_insights_get_request, opts = {}) ⇒ Array<(CraPartnerInsightsGetResponse, Integer, Hash)>

Retrieve cash flow insights from the bank accounts used for income verification &#x60;/cra/partner_insights/get&#x60; returns cash flow insights for a specified user.

Parameters:

Returns:



4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
 
# File 'lib/plaid/api/plaid_api.rb', line 4729

def cra_partner_insights_get_with_http_info(cra_partner_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.cra_partner_insights_get ...'
  end
  # verify the required parameter 'cra_partner_insights_get_request' is set
  if @api_client.config.client_side_validation && cra_partner_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'cra_partner_insights_get_request' when calling PlaidApi.cra_partner_insights_get"
  end
  # resource path
  local_var_path = '/cra/partner_insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_partner_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CraPartnerInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.cra_partner_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#cra_partner_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_payment_token(payment_initiation_payment_token_create_request, opts = {}) ⇒ PaymentInitiationPaymentTokenCreateResponse

Create payment token The ‘/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.

Parameters:

Returns:



4787
4788
4789
4790
 
# File 'lib/plaid/api/plaid_api.rb', line 4787

def create_payment_token(payment_initiation_payment_token_create_request, opts = {})
  data, _status_code, _headers = create_payment_token_with_http_info(payment_initiation_payment_token_create_request, opts)
  data
end

#create_payment_token_with_http_info(payment_initiation_payment_token_create_request, opts = {}) ⇒ Array<(PaymentInitiationPaymentTokenCreateResponse, Integer, Hash)>

Create payment token The &#x60;/payment_initiation/payment/token/create&#x60; endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, &#x60;link_token&#x60;-based flow. The recommended flow is to provide the &#x60;payment_id&#x60; to &#x60;/link/token/create&#x60;, which returns a &#x60;link_token&#x60; used to initialize Link. The &#x60;/payment_initiation/payment/token/create&#x60; is used to create a &#x60;payment_token&#x60;, which can then be used in Link initialization to enter a payment initiation flow. You can only use a &#x60;payment_token&#x60; 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.

Parameters:

Returns:



4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'lib/plaid/api/plaid_api.rb', line 4797

def create_payment_token_with_http_info(payment_initiation_payment_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.create_payment_token ...'
  end
  # verify the required parameter 'payment_initiation_payment_token_create_request' is set
  if @api_client.config.client_side_validation && payment_initiation_payment_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_token_create_request' when calling PlaidApi.create_payment_token"
  end
  # resource path
  local_var_path = '/payment_initiation/payment/token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.create_payment_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#create_payment_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_asset_report_freddie_mac_get(request_body, opts = {}) ⇒ AssetReportFreddieGetResponse

Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. The ‘credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac’s JSON format.

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4855
4856
4857
4858
 
# File 'lib/plaid/api/plaid_api.rb', line 4855

def credit_asset_report_freddie_mac_get(request_body, opts = {})
  data, _status_code, _headers = credit_asset_report_freddie_mac_get_with_http_info(request_body, opts)
  data
end

#credit_asset_report_freddie_mac_get_with_http_info(request_body, opts = {}) ⇒ Array<(AssetReportFreddieGetResponse, Integer, Hash)>

Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. The &#x60;credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Asset Report in Freddie Mac&#39;s JSON format.

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
 
# File 'lib/plaid/api/plaid_api.rb', line 4865

def credit_asset_report_freddie_mac_get_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_asset_report_freddie_mac_get ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_asset_report_freddie_mac_get"
  end
  # resource path
  local_var_path = '/credit/asset_report/freddie_mac/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportFreddieGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_asset_report_freddie_mac_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_asset_report_freddie_mac_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_audit_copy_token_create(credit_audit_copy_token_create_request, opts = {}) ⇒ CreditAuditCopyTokenCreateResponse

Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with 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.

Parameters:

Returns:



4923
4924
4925
4926
 
# File 'lib/plaid/api/plaid_api.rb', line 4923

def credit_audit_copy_token_create(credit_audit_copy_token_create_request, opts = {})
  data, _status_code, _headers = credit_audit_copy_token_create_with_http_info(credit_audit_copy_token_create_request, opts)
  data
end

#credit_audit_copy_token_create_with_http_info(credit_audit_copy_token_create_request, opts = {}) ⇒ Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>

Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government Sponsored Entity (GSE) if you participate in Fannie Mae&#39;s Day 1 Certainty™ program or utilize Freddie Mac&#39;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 &#x60;/credit/payroll_income/get&#x60;). Use the &#x60;/credit/audit_copy_token/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the GSE who needs access.

Parameters:

Returns:



4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
 
# File 'lib/plaid/api/plaid_api.rb', line 4933

def credit_audit_copy_token_create_with_http_info(credit_audit_copy_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_audit_copy_token_create ...'
  end
  # verify the required parameter 'credit_audit_copy_token_create_request' is set
  if @api_client.config.client_side_validation && credit_audit_copy_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_create_request' when calling PlaidApi.credit_audit_copy_token_create"
  end
  # resource path
  local_var_path = '/credit/audit_copy_token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_audit_copy_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_audit_copy_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_audit_copy_token_update(credit_audit_copy_token_update_request, opts = {}) ⇒ CreditAuditCopyTokenUpdateResponse

Update an Audit Copy Token The ‘/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.

Parameters:

Returns:



4991
4992
4993
4994
 
# File 'lib/plaid/api/plaid_api.rb', line 4991

def credit_audit_copy_token_update(credit_audit_copy_token_update_request, opts = {})
  data, _status_code, _headers = credit_audit_copy_token_update_with_http_info(credit_audit_copy_token_update_request, opts)
  data
end

#credit_audit_copy_token_update_with_http_info(credit_audit_copy_token_update_request, opts = {}) ⇒ Array<(CreditAuditCopyTokenUpdateResponse, Integer, Hash)>

Update an Audit Copy Token The &#x60;/credit/audit_copy_token/update&#x60; endpoint updates an existing Audit Copy Token by adding the report tokens in the &#x60;report_tokens&#x60; field to the &#x60;audit_copy_token&#x60;. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the &#x60;report_tokens&#x60; field.

Parameters:

Returns:



5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
 
# File 'lib/plaid/api/plaid_api.rb', line 5001

def credit_audit_copy_token_update_with_http_info(credit_audit_copy_token_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_audit_copy_token_update ...'
  end
  # verify the required parameter 'credit_audit_copy_token_update_request' is set
  if @api_client.config.client_side_validation && credit_audit_copy_token_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_update_request' when calling PlaidApi.credit_audit_copy_token_update"
  end
  # resource path
  local_var_path = '/credit/audit_copy_token/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_audit_copy_token_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_audit_copy_token_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_bank_employment_get(credit_bank_employment_get_request, opts = {}) ⇒ CreditBankEmploymentGetResponse

Retrieve information from the bank accounts used for employment verification ‘/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.

Parameters:

Returns:



5059
5060
5061
5062
 
# File 'lib/plaid/api/plaid_api.rb', line 5059

def credit_bank_employment_get(credit_bank_employment_get_request, opts = {})
  data, _status_code, _headers = credit_bank_employment_get_with_http_info(credit_bank_employment_get_request, opts)
  data
end

#credit_bank_employment_get_with_http_info(credit_bank_employment_get_request, opts = {}) ⇒ Array<(CreditBankEmploymentGetResponse, Integer, Hash)>

Retrieve information from the bank accounts used for employment verification &#x60;/credit/bank_employment/get&#x60; returns the employment report(s) derived from bank transaction data for a specified user.

Parameters:

Returns:



5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
 
# File 'lib/plaid/api/plaid_api.rb', line 5069

def credit_bank_employment_get_with_http_info(credit_bank_employment_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_employment_get ...'
  end
  # verify the required parameter 'credit_bank_employment_get_request' is set
  if @api_client.config.client_side_validation && credit_bank_employment_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_bank_employment_get_request' when calling PlaidApi.credit_bank_employment_get"
  end
  # resource path
  local_var_path = '/beta/credit/v1/bank_employment/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_employment_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditBankEmploymentGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_bank_employment_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_bank_employment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_bank_income_get(credit_bank_income_get_request, opts = {}) ⇒ CreditBankIncomeGetResponse

Retrieve information from the bank accounts used for income verification ‘/credit/bank_income/get` returns the bank income report(s) for a specified user. 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.

Parameters:

Returns:



5127
5128
5129
5130
 
# File 'lib/plaid/api/plaid_api.rb', line 5127

def credit_bank_income_get(credit_bank_income_get_request, opts = {})
  data, _status_code, _headers = credit_bank_income_get_with_http_info(credit_bank_income_get_request, opts)
  data
end

#credit_bank_income_get_with_http_info(credit_bank_income_get_request, opts = {}) ⇒ Array<(CreditBankIncomeGetResponse, Integer, Hash)>

Retrieve information from the bank accounts used for income verification &#x60;/credit/bank_income/get&#x60; 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 &#x60;options.count&#x60; field.

Parameters:

Returns:

  • (Array<(CreditBankIncomeGetResponse, Integer, Hash)>) —

    CreditBankIncomeGetResponse data, response status code and response headers



5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
 
# File 'lib/plaid/api/plaid_api.rb', line 5137

def credit_bank_income_get_with_http_info(credit_bank_income_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_get ...'
  end
  # verify the required parameter 'credit_bank_income_get_request' is set
  if @api_client.config.client_side_validation && credit_bank_income_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_bank_income_get_request' when calling PlaidApi.credit_bank_income_get"
  end
  # resource path
  local_var_path = '/credit/bank_income/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditBankIncomeGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_bank_income_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_bank_income_pdf_get(credit_bank_income_pdf_get_request, opts = {}) ⇒ File

Retrieve information from the bank accounts used for income verification in PDF format ‘/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. 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).

Parameters:

Returns:

  • (File) 


5195
5196
5197
5198
 
# File 'lib/plaid/api/plaid_api.rb', line 5195

def credit_bank_income_pdf_get(credit_bank_income_pdf_get_request, opts = {})
  data, _status_code, _headers = credit_bank_income_pdf_get_with_http_info(credit_bank_income_pdf_get_request, opts)
  data
end

#credit_bank_income_pdf_get_with_http_info(credit_bank_income_pdf_get_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve information from the bank accounts used for income verification in PDF format &#x60;/credit/bank_income/pdf/get&#x60; 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).

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
 
# File 'lib/plaid/api/plaid_api.rb', line 5205

def credit_bank_income_pdf_get_with_http_info(credit_bank_income_pdf_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_pdf_get ...'
  end
  # verify the required parameter 'credit_bank_income_pdf_get_request' is set
  if @api_client.config.client_side_validation && credit_bank_income_pdf_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_bank_income_pdf_get_request' when calling PlaidApi.credit_bank_income_pdf_get"
  end
  # resource path
  local_var_path = '/credit/bank_income/pdf/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_pdf_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_bank_income_pdf_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_bank_income_refresh(credit_bank_income_refresh_request, opts = {}) ⇒ CreditBankIncomeRefreshResponse

Refresh a user’s bank income information ‘/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.

Parameters:

Returns:



5263
5264
5265
5266
 
# File 'lib/plaid/api/plaid_api.rb', line 5263

def credit_bank_income_refresh(credit_bank_income_refresh_request, opts = {})
  data, _status_code, _headers = credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts)
  data
end

#credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts = {}) ⇒ Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>

Refresh a user&#39;s bank income information &#x60;/credit/bank_income/refresh&#x60; 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.

Parameters:

Returns:



5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
 
# File 'lib/plaid/api/plaid_api.rb', line 5273

def credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_refresh ...'
  end
  # verify the required parameter 'credit_bank_income_refresh_request' is set
  if @api_client.config.client_side_validation && credit_bank_income_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_bank_income_refresh_request' when calling PlaidApi.credit_bank_income_refresh"
  end
  # resource path
  local_var_path = '/credit/bank_income/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditBankIncomeRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_bank_income_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_bank_income_webhook_update(credit_bank_income_webhook_update_request, opts = {}) ⇒ CreditBankIncomeWebhookUpdateResponse

Subscribe and unsubscribe to proactive notifications for a user’s income profile ‘/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user’s income profile, you will receive a ‘BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.

Parameters:

Returns:



5331
5332
5333
5334
 
# File 'lib/plaid/api/plaid_api.rb', line 5331

def credit_bank_income_webhook_update(credit_bank_income_webhook_update_request, opts = {})
  data, _status_code, _headers = credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts)
  data
end

#credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts = {}) ⇒ Array<(CreditBankIncomeWebhookUpdateResponse, Integer, Hash)>

Subscribe and unsubscribe to proactive notifications for a user&#39;s income profile &#x60;/credit/bank_income/webhook/update&#x60; 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&#39;s income profile, you will receive a &#x60;BANK_INCOME_REFRESH_UPDATE&#x60; webhook, prompting you to refresh bank income data for the user.

Parameters:

Returns:



5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
 
# File 'lib/plaid/api/plaid_api.rb', line 5341

def credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_webhook_update ...'
  end
  # verify the required parameter 'credit_bank_income_webhook_update_request' is set
  if @api_client.config.client_side_validation && credit_bank_income_webhook_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_bank_income_webhook_update_request' when calling PlaidApi.credit_bank_income_webhook_update"
  end
  # resource path
  local_var_path = '/credit/bank_income/webhook/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_webhook_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditBankIncomeWebhookUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_bank_income_webhook_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_bank_statements_uploads_get(credit_bank_statements_uploads_get_request, opts = {}) ⇒ CreditBankStatementsUploadsGetResponse

Retrieve data for a user’s uploaded bank statements ‘/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document Parsing, contact your account manager to request access.

Parameters:

Returns:



5399
5400
5401
5402
 
# File 'lib/plaid/api/plaid_api.rb', line 5399

def credit_bank_statements_uploads_get(credit_bank_statements_uploads_get_request, opts = {})
  data, _status_code, _headers = credit_bank_statements_uploads_get_with_http_info(credit_bank_statements_uploads_get_request, opts)
  data
end

#credit_bank_statements_uploads_get_with_http_info(credit_bank_statements_uploads_get_request, opts = {}) ⇒ Array<(CreditBankStatementsUploadsGetResponse, Integer, Hash)>

Retrieve data for a user&#39;s uploaded bank statements &#x60;/credit/bank_statements/uploads/get&#x60; 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.

Parameters:

Returns:



5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
 
# File 'lib/plaid/api/plaid_api.rb', line 5409

def credit_bank_statements_uploads_get_with_http_info(credit_bank_statements_uploads_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_statements_uploads_get ...'
  end
  # verify the required parameter 'credit_bank_statements_uploads_get_request' is set
  if @api_client.config.client_side_validation && credit_bank_statements_uploads_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_bank_statements_uploads_get_request' when calling PlaidApi.credit_bank_statements_uploads_get"
  end
  # resource path
  local_var_path = '/credit/bank_statements/uploads/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_statements_uploads_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditBankStatementsUploadsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_bank_statements_uploads_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_bank_statements_uploads_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_employment_get(credit_employment_get_request, opts = {}) ⇒ CreditEmploymentGetResponse

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

Parameters:

Returns:



5467
5468
5469
5470
 
# File 'lib/plaid/api/plaid_api.rb', line 5467

def credit_employment_get(credit_employment_get_request, opts = {})
  data, _status_code, _headers = credit_employment_get_with_http_info(credit_employment_get_request, opts)
  data
end

#credit_employment_get_with_http_info(credit_employment_get_request, opts = {}) ⇒ Array<(CreditEmploymentGetResponse, Integer, Hash)>

Retrieve a summary of an individual&#39;s employment information &#x60;/credit/employment/get&#x60; returns a list of items with employment information from a user&#39;s payroll provider that was verified by an end user.

Parameters:

Returns:

  • (Array<(CreditEmploymentGetResponse, Integer, Hash)>) —

    CreditEmploymentGetResponse data, response status code and response headers



5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
 
# File 'lib/plaid/api/plaid_api.rb', line 5477

def credit_employment_get_with_http_info(credit_employment_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_employment_get ...'
  end
  # verify the required parameter 'credit_employment_get_request' is set
  if @api_client.config.client_side_validation && credit_employment_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_employment_get_request' when calling PlaidApi.credit_employment_get"
  end
  # resource path
  local_var_path = '/credit/employment/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_employment_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditEmploymentGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_employment_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_employment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_freddie_mac_reports_get(credit_freddie_mac_reports_get_request, opts = {}) ⇒ CreditFreddieMacReportsGetResponse

Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint. The ‘credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.

Parameters:

Returns:



5535
5536
5537
5538
 
# File 'lib/plaid/api/plaid_api.rb', line 5535

def credit_freddie_mac_reports_get(credit_freddie_mac_reports_get_request, opts = {})
  data, _status_code, _headers = credit_freddie_mac_reports_get_with_http_info(credit_freddie_mac_reports_get_request, opts)
  data
end

#credit_freddie_mac_reports_get_with_http_info(credit_freddie_mac_reports_get_request, opts = {}) ⇒ Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>

Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint. The &#x60;credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Verification of Assets and Verification of Employment reports.

Parameters:

Returns:



5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
 
# File 'lib/plaid/api/plaid_api.rb', line 5545

def credit_freddie_mac_reports_get_with_http_info(credit_freddie_mac_reports_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_freddie_mac_reports_get ...'
  end
  # verify the required parameter 'credit_freddie_mac_reports_get_request' is set
  if @api_client.config.client_side_validation && credit_freddie_mac_reports_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_freddie_mac_reports_get_request' when calling PlaidApi.credit_freddie_mac_reports_get"
  end
  # resource path
  local_var_path = '/credit/freddie_mac/reports/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_freddie_mac_reports_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditFreddieMacReportsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_freddie_mac_reports_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_freddie_mac_reports_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_payroll_income_get(credit_payroll_income_get_request, opts = {}) ⇒ CreditPayrollIncomeGetResponse

Retrieve a user’s payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.

Parameters:

Returns:



5603
5604
5605
5606
 
# File 'lib/plaid/api/plaid_api.rb', line 5603

def credit_payroll_income_get(credit_payroll_income_get_request, opts = {})
  data, _status_code, _headers = credit_payroll_income_get_with_http_info(credit_payroll_income_get_request, opts)
  data
end

#credit_payroll_income_get_with_http_info(credit_payroll_income_get_request, opts = {}) ⇒ Array<(CreditPayrollIncomeGetResponse, Integer, Hash)>

Retrieve a user&#39;s payroll information This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.

Parameters:

Returns:



5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
 
# File 'lib/plaid/api/plaid_api.rb', line 5613

def credit_payroll_income_get_with_http_info(credit_payroll_income_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_get ...'
  end
  # verify the required parameter 'credit_payroll_income_get_request' is set
  if @api_client.config.client_side_validation && credit_payroll_income_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_payroll_income_get_request' when calling PlaidApi.credit_payroll_income_get"
  end
  # resource path
  local_var_path = '/credit/payroll_income/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditPayrollIncomeGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_payroll_income_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_payroll_income_parsing_config_update(request_body, opts = {}) ⇒ CreditPayrollIncomeParsingConfigUpdateResponse

Update the parsing configuration for a document income verification ‘/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5671
5672
5673
5674
 
# File 'lib/plaid/api/plaid_api.rb', line 5671

def credit_payroll_income_parsing_config_update(request_body, opts = {})
  data, _status_code, _headers = credit_payroll_income_parsing_config_update_with_http_info(request_body, opts)
  data
end

#credit_payroll_income_parsing_config_update_with_http_info(request_body, opts = {}) ⇒ Array<(CreditPayrollIncomeParsingConfigUpdateResponse, Integer, Hash)>

Update the parsing configuration for a document income verification &#x60;/credit/payroll_income/parsing_config/update&#x60; updates the parsing configuration for a document income verification.

Parameters:

  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
 
# File 'lib/plaid/api/plaid_api.rb', line 5681

def credit_payroll_income_parsing_config_update_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_parsing_config_update ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_payroll_income_parsing_config_update"
  end
  # resource path
  local_var_path = '/credit/payroll_income/parsing_config/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditPayrollIncomeParsingConfigUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_payroll_income_parsing_config_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_parsing_config_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_payroll_income_precheck(credit_payroll_income_precheck_request, opts = {}) ⇒ CreditPayrollIncomePrecheckResponse

Check income verification eligibility and optimize conversion ‘/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.

Parameters:

Returns:



5739
5740
5741
5742
 
# File 'lib/plaid/api/plaid_api.rb', line 5739

def credit_payroll_income_precheck(credit_payroll_income_precheck_request, opts = {})
  data, _status_code, _headers = credit_payroll_income_precheck_with_http_info(credit_payroll_income_precheck_request, opts)
  data
end

#credit_payroll_income_precheck_with_http_info(credit_payroll_income_precheck_request, opts = {}) ⇒ Array<(CreditPayrollIncomePrecheckResponse, Integer, Hash)>

Check income verification eligibility and optimize conversion &#x60;/credit/payroll_income/precheck&#x60; 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 &#x60;employer&#x60; 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 &#x60;employer&#x60; and &#x60;access_tokens&#x60; fields. &#x60;employer_good&#x60; and &#x60;employer_bad&#x60; will result in &#x60;HIGH&#x60; and &#x60;LOW&#x60; confidence values, respectively. &#x60;employer_multi&#x60; will result in a &#x60;HIGH&#x60; confidence with multiple payroll options. Likewise, &#x60;access_good&#x60; and &#x60;access_bad&#x60; will result in &#x60;HIGH&#x60; and &#x60;LOW&#x60; confidence values, respectively. Any other value for &#x60;employer&#x60; and &#x60;access_tokens&#x60; in Sandbox will result in &#x60;UNKNOWN&#x60; confidence.

Parameters:

Returns:



5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
 
# File 'lib/plaid/api/plaid_api.rb', line 5749

def credit_payroll_income_precheck_with_http_info(credit_payroll_income_precheck_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_precheck ...'
  end
  # verify the required parameter 'credit_payroll_income_precheck_request' is set
  if @api_client.config.client_side_validation && credit_payroll_income_precheck_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_payroll_income_precheck_request' when calling PlaidApi.credit_payroll_income_precheck"
  end
  # resource path
  local_var_path = '/credit/payroll_income/precheck'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_precheck_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditPayrollIncomePrecheckResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_payroll_income_precheck",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_payroll_income_refresh(credit_payroll_income_refresh_request, opts = {}) ⇒ CreditPayrollIncomeRefreshResponse

Refresh a digital payroll income verification ‘/credit/payroll_income/refresh` refreshes a given digital payroll income verification.

Parameters:

Returns:



5807
5808
5809
5810
 
# File 'lib/plaid/api/plaid_api.rb', line 5807

def credit_payroll_income_refresh(credit_payroll_income_refresh_request, opts = {})
  data, _status_code, _headers = credit_payroll_income_refresh_with_http_info(credit_payroll_income_refresh_request, opts)
  data
end

#credit_payroll_income_refresh_with_http_info(credit_payroll_income_refresh_request, opts = {}) ⇒ Array<(CreditPayrollIncomeRefreshResponse, Integer, Hash)>

Refresh a digital payroll income verification &#x60;/credit/payroll_income/refresh&#x60; refreshes a given digital payroll income verification.

Parameters:

Returns:



5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
 
# File 'lib/plaid/api/plaid_api.rb', line 5817

def credit_payroll_income_refresh_with_http_info(credit_payroll_income_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_refresh ...'
  end
  # verify the required parameter 'credit_payroll_income_refresh_request' is set
  if @api_client.config.client_side_validation && credit_payroll_income_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_payroll_income_refresh_request' when calling PlaidApi.credit_payroll_income_refresh"
  end
  # resource path
  local_var_path = '/credit/payroll_income/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditPayrollIncomeRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_payroll_income_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_payroll_income_risk_signals_get(credit_payroll_income_risk_signals_get_request, opts = {}) ⇒ CreditPayrollIncomeRiskSignalsGetResponse

Retrieve fraud insights for a user’s manually uploaded document(s). ‘/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `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.

Parameters:

Returns:



5875
5876
5877
5878
 
# File 'lib/plaid/api/plaid_api.rb', line 5875

def credit_payroll_income_risk_signals_get(credit_payroll_income_risk_signals_get_request, opts = {})
  data, _status_code, _headers = credit_payroll_income_risk_signals_get_with_http_info(credit_payroll_income_risk_signals_get_request, opts)
  data
end

#credit_payroll_income_risk_signals_get_with_http_info(credit_payroll_income_risk_signals_get_request, opts = {}) ⇒ Array<(CreditPayrollIncomeRiskSignalsGetResponse, Integer, Hash)>

Retrieve fraud insights for a user&#39;s manually uploaded document(s). &#x60;/credit/payroll_income/risk_signals/get&#x60; 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 &#x60;/link/token/create&#x60; with &#x60;parsing_config&#x60; set to include &#x60;risk_signals&#x60;, or call &#x60;/credit/payroll_income/parsing_config/update&#x60;. Once risk signal generation has been triggered, &#x60;/credit/payroll_income/risk_signals/get&#x60; can be called at any time after the &#x60;INCOME_VERIFICATION_RISK_SIGNALS&#x60; webhook has been fired. &#x60;/credit/payroll_income/risk_signals/get&#x60; 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.

Parameters:

Returns:



5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'lib/plaid/api/plaid_api.rb', line 5885

def credit_payroll_income_risk_signals_get_with_http_info(credit_payroll_income_risk_signals_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_risk_signals_get ...'
  end
  # verify the required parameter 'credit_payroll_income_risk_signals_get_request' is set
  if @api_client.config.client_side_validation && credit_payroll_income_risk_signals_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_payroll_income_risk_signals_get_request' when calling PlaidApi.credit_payroll_income_risk_signals_get"
  end
  # resource path
  local_var_path = '/credit/payroll_income/risk_signals/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_risk_signals_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditPayrollIncomeRiskSignalsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_payroll_income_risk_signals_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_risk_signals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_relay_create(credit_relay_create_request, opts = {}) ⇒ CreditRelayCreateResponse

Create a relay token to share an Asset Report with a partner client 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.

Parameters:

Returns:



5943
5944
5945
5946
 
# File 'lib/plaid/api/plaid_api.rb', line 5943

def credit_relay_create(credit_relay_create_request, opts = {})
  data, _status_code, _headers = credit_relay_create_with_http_info(credit_relay_create_request, opts)
  data
end

#credit_relay_create_with_http_info(credit_relay_create_request, opts = {}) ⇒ Array<(CreditRelayCreateResponse, Integer, Hash)>

Create a relay token to share an Asset Report with a partner client 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 &#x60;/asset_report/create&#x60;. To grant a third party access to an Asset Report, use the &#x60;/credit/relay/create&#x60; endpoint to create a &#x60;relay_token&#x60; and then pass that token to your third party. Each third party has its own &#x60;secondary_client_id&#x60;; for example, &#x60;ce5bd328dcd34123456&#x60;. You&#39;ll need to create a separate &#x60;relay_token&#x60; for each third party that needs access to the report on your behalf.

Parameters:

Returns:

  • (Array<(CreditRelayCreateResponse, Integer, Hash)>) —

    CreditRelayCreateResponse data, response status code and response headers



5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
 
# File 'lib/plaid/api/plaid_api.rb', line 5953

def credit_relay_create_with_http_info(credit_relay_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_create ...'
  end
  # verify the required parameter 'credit_relay_create_request' is set
  if @api_client.config.client_side_validation && credit_relay_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_relay_create_request' when calling PlaidApi.credit_relay_create"
  end
  # resource path
  local_var_path = '/credit/relay/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditRelayCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_relay_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_relay_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_relay_get(credit_relay_get_request, opts = {}) ⇒ AssetReportGetResponse

Retrieve the reports associated with a relay token that was shared with you ‘/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.

Parameters:

  • credit_relay_get_request (CreditRelayGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6011
6012
6013
6014
 
# File 'lib/plaid/api/plaid_api.rb', line 6011

def credit_relay_get(credit_relay_get_request, opts = {})
  data, _status_code, _headers = credit_relay_get_with_http_info(credit_relay_get_request, opts)
  data
end

#credit_relay_get_with_http_info(credit_relay_get_request, opts = {}) ⇒ Array<(AssetReportGetResponse, Integer, Hash)>

Retrieve the reports associated with a relay token that was shared with you &#x60;/credit/relay/get&#x60; allows third parties to receive a report that was shared with them, using a &#x60;relay_token&#x60; that was created by the report owner.

Parameters:

  • credit_relay_get_request (CreditRelayGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AssetReportGetResponse, Integer, Hash)>) —

    AssetReportGetResponse data, response status code and response headers



6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
 
# File 'lib/plaid/api/plaid_api.rb', line 6021

def credit_relay_get_with_http_info(credit_relay_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_get ...'
  end
  # verify the required parameter 'credit_relay_get_request' is set
  if @api_client.config.client_side_validation && credit_relay_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_relay_get_request' when calling PlaidApi.credit_relay_get"
  end
  # resource path
  local_var_path = '/credit/relay/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_relay_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_relay_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_relay_pdf_get(credit_relay_pdf_get_request, opts = {}) ⇒ File

Retrieve the pdf reports associated with a relay token that was shared with you (beta) ‘/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/credit/relay/pdf/get`, you must first create the Asset Report using `/credit/relay/create` and then wait for the [`PRODUCT_READY`](plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/credit/relay/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](plaid.com/documents/sample-asset-report.pdf).

Parameters:

Returns:

  • (File) 


6079
6080
6081
6082
 
# File 'lib/plaid/api/plaid_api.rb', line 6079

def credit_relay_pdf_get(credit_relay_pdf_get_request, opts = {})
  data, _status_code, _headers = credit_relay_pdf_get_with_http_info(credit_relay_pdf_get_request, opts)
  data
end

#credit_relay_pdf_get_with_http_info(credit_relay_pdf_get_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve the pdf reports associated with a relay token that was shared with you (beta) &#x60;/credit/relay/pdf/get&#x60; allows third parties to receive a pdf report that was shared with them, using a &#x60;relay_token&#x60; that was created by the report owner. The &#x60;/credit/relay/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/credit/relay/pdf/get&#x60;, you must first create the Asset Report using &#x60;/credit/relay/create&#x60; and then wait for the [&#x60;PRODUCT_READY&#x60;](plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/credit/relay/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](plaid.com/documents/sample-asset-report.pdf).

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
 
# File 'lib/plaid/api/plaid_api.rb', line 6089

def credit_relay_pdf_get_with_http_info(credit_relay_pdf_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_pdf_get ...'
  end
  # verify the required parameter 'credit_relay_pdf_get_request' is set
  if @api_client.config.client_side_validation && credit_relay_pdf_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_relay_pdf_get_request' when calling PlaidApi.credit_relay_pdf_get"
  end
  # resource path
  local_var_path = '/credit/relay/pdf/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_pdf_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_relay_pdf_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_relay_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_relay_refresh(credit_relay_refresh_request, opts = {}) ⇒ CreditRelayRefreshResponse

Refresh a report of a relay token 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.

Parameters:

Returns:



6147
6148
6149
6150
 
# File 'lib/plaid/api/plaid_api.rb', line 6147

def credit_relay_refresh(credit_relay_refresh_request, opts = {})
  data, _status_code, _headers = credit_relay_refresh_with_http_info(credit_relay_refresh_request, opts)
  data
end

#credit_relay_refresh_with_http_info(credit_relay_refresh_request, opts = {}) ⇒ Array<(CreditRelayRefreshResponse, Integer, Hash)>

Refresh a report of a relay token The &#x60;/credit/relay/refresh&#x60; endpoint allows third parties to refresh a report that was relayed to them, using a &#x60;relay_token&#x60; 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 &#x60;days_requested&#x60; value of the original report.

Parameters:

Returns:

  • (Array<(CreditRelayRefreshResponse, Integer, Hash)>) —

    CreditRelayRefreshResponse data, response status code and response headers



6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
 
# File 'lib/plaid/api/plaid_api.rb', line 6157

def credit_relay_refresh_with_http_info(credit_relay_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_refresh ...'
  end
  # verify the required parameter 'credit_relay_refresh_request' is set
  if @api_client.config.client_side_validation && credit_relay_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_relay_refresh_request' when calling PlaidApi.credit_relay_refresh"
  end
  # resource path
  local_var_path = '/credit/relay/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditRelayRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_relay_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_relay_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_relay_remove(credit_relay_remove_request, opts = {}) ⇒ CreditRelayRemoveResponse

Remove relay token 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`.

Parameters:

Returns:



6215
6216
6217
6218
 
# File 'lib/plaid/api/plaid_api.rb', line 6215

def credit_relay_remove(credit_relay_remove_request, opts = {})
  data, _status_code, _headers = credit_relay_remove_with_http_info(credit_relay_remove_request, opts)
  data
end

#credit_relay_remove_with_http_info(credit_relay_remove_request, opts = {}) ⇒ Array<(CreditRelayRemoveResponse, Integer, Hash)>

Remove relay token The &#x60;/credit/relay/remove&#x60; endpoint allows you to invalidate a &#x60;relay_token&#x60;. The third party holding the token will no longer be able to access or refresh the reports which the &#x60;relay_token&#x60; 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 &#x60;relay_token&#x60;.

Parameters:

Returns:

  • (Array<(CreditRelayRemoveResponse, Integer, Hash)>) —

    CreditRelayRemoveResponse data, response status code and response headers



6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
 
# File 'lib/plaid/api/plaid_api.rb', line 6225

def credit_relay_remove_with_http_info(credit_relay_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_remove ...'
  end
  # verify the required parameter 'credit_relay_remove_request' is set
  if @api_client.config.client_side_validation && credit_relay_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_relay_remove_request' when calling PlaidApi.credit_relay_remove"
  end
  # resource path
  local_var_path = '/credit/relay/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditRelayRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_relay_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_relay_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_report_audit_copy_remove(credit_audit_copy_token_remove_request, opts = {}) ⇒ CreditAuditCopyTokenRemoveResponse

Remove an Audit Copy token The ‘/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.

Parameters:

Returns:



6283
6284
6285
6286
 
# File 'lib/plaid/api/plaid_api.rb', line 6283

def credit_report_audit_copy_remove(credit_audit_copy_token_remove_request, opts = {})
  data, _status_code, _headers = credit_report_audit_copy_remove_with_http_info(credit_audit_copy_token_remove_request, opts)
  data
end

#credit_report_audit_copy_remove_with_http_info(credit_audit_copy_token_remove_request, opts = {}) ⇒ Array<(CreditAuditCopyTokenRemoveResponse, Integer, Hash)>

Remove an Audit Copy token The &#x60;/credit/audit_copy_token/remove&#x60; endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the &#x60;audit_copy_token&#x60; 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.

Parameters:

Returns:



6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
 
# File 'lib/plaid/api/plaid_api.rb', line 6293

def credit_report_audit_copy_remove_with_http_info(credit_audit_copy_token_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_report_audit_copy_remove ...'
  end
  # verify the required parameter 'credit_audit_copy_token_remove_request' is set
  if @api_client.config.client_side_validation && credit_audit_copy_token_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_remove_request' when calling PlaidApi.credit_report_audit_copy_remove"
  end
  # resource path
  local_var_path = '/credit/audit_copy_token/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_report_audit_copy_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_report_audit_copy_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_sessions_get(credit_sessions_get_request, opts = {}) ⇒ CreditSessionsGetResponse

Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).

Parameters:

Returns:



6351
6352
6353
6354
 
# File 'lib/plaid/api/plaid_api.rb', line 6351

def credit_sessions_get(credit_sessions_get_request, opts = {})
  data, _status_code, _headers = credit_sessions_get_with_http_info(credit_sessions_get_request, opts)
  data
end

#credit_sessions_get_with_http_info(credit_sessions_get_request, opts = {}) ⇒ Array<(CreditSessionsGetResponse, Integer, Hash)>

Retrieve Link sessions for your user This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).

Parameters:

Returns:

  • (Array<(CreditSessionsGetResponse, Integer, Hash)>) —

    CreditSessionsGetResponse data, response status code and response headers



6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
 
# File 'lib/plaid/api/plaid_api.rb', line 6361

def credit_sessions_get_with_http_info(credit_sessions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.credit_sessions_get ...'
  end
  # verify the required parameter 'credit_sessions_get_request' is set
  if @api_client.config.client_side_validation && credit_sessions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'credit_sessions_get_request' when calling PlaidApi.credit_sessions_get"
  end
  # resource path
  local_var_path = '/credit/sessions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_sessions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreditSessionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.credit_sessions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#credit_sessions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_user_get(dashboard_user_get_request, opts = {}) ⇒ DashboardUserGetResponse

Retrieve a dashboard user 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.

Parameters:

Returns:



6419
6420
6421
6422
 
# File 'lib/plaid/api/plaid_api.rb', line 6419

def dashboard_user_get(dashboard_user_get_request, opts = {})
  data, _status_code, _headers = dashboard_user_get_with_http_info(dashboard_user_get_request, opts)
  data
end

#dashboard_user_get_with_http_info(dashboard_user_get_request, opts = {}) ⇒ Array<(DashboardUserGetResponse, Integer, Hash)>

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

Parameters:

Returns:

  • (Array<(DashboardUserGetResponse, Integer, Hash)>) —

    DashboardUserGetResponse data, response status code and response headers



6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
 
# File 'lib/plaid/api/plaid_api.rb', line 6429

def dashboard_user_get_with_http_info(dashboard_user_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_get ...'
  end
  # verify the required parameter 'dashboard_user_get_request' is set
  if @api_client.config.client_side_validation && dashboard_user_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_user_get_request' when calling PlaidApi.dashboard_user_get"
  end
  # resource path
  local_var_path = '/dashboard_user/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_user_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'DashboardUserGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.dashboard_user_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#dashboard_user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_user_list(dashboard_user_list_request, opts = {}) ⇒ DashboardUserListResponse

List dashboard users 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.

Parameters:

Returns:



6487
6488
6489
6490
 
# File 'lib/plaid/api/plaid_api.rb', line 6487

def dashboard_user_list(dashboard_user_list_request, opts = {})
  data, _status_code, _headers = dashboard_user_list_with_http_info(dashboard_user_list_request, opts)
  data
end

#dashboard_user_list_with_http_info(dashboard_user_list_request, opts = {}) ⇒ Array<(DashboardUserListResponse, Integer, Hash)>

List dashboard users The &#x60;/dashboard_user/list&#x60; 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.

Parameters:

Returns:

  • (Array<(DashboardUserListResponse, Integer, Hash)>) —

    DashboardUserListResponse data, response status code and response headers



6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
 
# File 'lib/plaid/api/plaid_api.rb', line 6497

def dashboard_user_list_with_http_info(dashboard_user_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_list ...'
  end
  # verify the required parameter 'dashboard_user_list_request' is set
  if @api_client.config.client_side_validation && dashboard_user_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_user_list_request' when calling PlaidApi.dashboard_user_list"
  end
  # resource path
  local_var_path = '/dashboard_user/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_user_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'DashboardUserListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.dashboard_user_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#dashboard_user_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#employers_search(employers_search_request, opts = {}) ⇒ EmployersSearchResponse

Search employer database ‘/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user’s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.

Parameters:

Returns:



6555
6556
6557
6558
 
# File 'lib/plaid/api/plaid_api.rb', line 6555

def employers_search(employers_search_request, opts = {})
  data, _status_code, _headers = employers_search_with_http_info(employers_search_request, opts)
  data
end

#employers_search_with_http_info(employers_search_request, opts = {}) ⇒ Array<(EmployersSearchResponse, Integer, Hash)>

Search employer database &#x60;/employers/search&#x60; 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&#39;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.

Parameters:

Returns:

  • (Array<(EmployersSearchResponse, Integer, Hash)>) —

    EmployersSearchResponse data, response status code and response headers



6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
 
# File 'lib/plaid/api/plaid_api.rb', line 6565

def employers_search_with_http_info(employers_search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.employers_search ...'
  end
  # verify the required parameter 'employers_search_request' is set
  if @api_client.config.client_side_validation && employers_search_request.nil?
    fail ArgumentError, "Missing the required parameter 'employers_search_request' when calling PlaidApi.employers_search"
  end
  # resource path
  local_var_path = '/employers/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(employers_search_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmployersSearchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.employers_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#employers_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#employment_verification_get(employment_verification_get_request, opts = {}) ⇒ EmploymentVerificationGetResponse

(Deprecated) Retrieve a summary of an individual’s employment information ‘/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead.

Parameters:

Returns:



6623
6624
6625
6626
 
# File 'lib/plaid/api/plaid_api.rb', line 6623

def employment_verification_get(employment_verification_get_request, opts = {})
  data, _status_code, _headers = employment_verification_get_with_http_info(employment_verification_get_request, opts)
  data
end

#employment_verification_get_with_http_info(employment_verification_get_request, opts = {}) ⇒ Array<(EmploymentVerificationGetResponse, Integer, Hash)>

(Deprecated) Retrieve a summary of an individual&#39;s employment information &#x60;/employment/verification/get&#x60; 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 &#x60;/credit/employment/get&#x60; instead.

Parameters:

Returns:



6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
 
# File 'lib/plaid/api/plaid_api.rb', line 6633

def employment_verification_get_with_http_info(employment_verification_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.employment_verification_get ...'
  end
  # verify the required parameter 'employment_verification_get_request' is set
  if @api_client.config.client_side_validation && employment_verification_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'employment_verification_get_request' when calling PlaidApi.employment_verification_get"
  end
  # resource path
  local_var_path = '/employment/verification/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(employment_verification_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmploymentVerificationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.employment_verification_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#employment_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fdx_notifications(fdx_notification, opts = {}) ⇒ nil

Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications

Parameters:

  • fdx_notification (FDXNotification)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


6691
6692
6693
6694
 
# File 'lib/plaid/api/plaid_api.rb', line 6691

def fdx_notifications(fdx_notification, opts = {})
  fdx_notifications_with_http_info(fdx_notification, opts)
  nil
end

#fdx_notifications_with_http_info(fdx_notification, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Webhook receiver for fdx notifications A generic webhook receiver endpoint for FDX Event Notifications

Parameters:

  • fdx_notification (FDXNotification)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
 
# File 'lib/plaid/api/plaid_api.rb', line 6701

def fdx_notifications_with_http_info(fdx_notification, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_notifications ...'
  end
  # verify the required parameter 'fdx_notification' is set
  if @api_client.config.client_side_validation && fdx_notification.nil?
    fail ArgumentError, "Missing the required parameter 'fdx_notification' when calling PlaidApi.fdx_notifications"
  end
  # resource path
  local_var_path = '/fdx/notifications'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(fdx_notification)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.fdx_notifications",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#fdx_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recipient(recipient_id, opts = {}) ⇒ GetRecipientResponse

Get Recipient Get a specific recipient

Parameters:

  • recipient_id (String) —

    Recipient Identifier. Uniquely identifies the recipient

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :oauth_state_id (String) —

    The value that is passed into the OAuth URI &#39;state&#39; query parameter.

Returns:



6760
6761
6762
6763
 
# File 'lib/plaid/api/plaid_api.rb', line 6760

def get_recipient(recipient_id, opts = {})
  data, _status_code, _headers = get_recipient_with_http_info(recipient_id, opts)
  data
end

#get_recipient_with_http_info(recipient_id, opts = {}) ⇒ Array<(GetRecipientResponse, Integer, Hash)>

Get Recipient Get a specific recipient

Parameters:

  • recipient_id (String) —

    Recipient Identifier. Uniquely identifies the recipient

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :oauth_state_id (String) —

    The value that is passed into the OAuth URI &#39;state&#39; query parameter.

Returns:

  • (Array<(GetRecipientResponse, Integer, Hash)>) —

    GetRecipientResponse data, response status code and response headers



6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
 
# File 'lib/plaid/api/plaid_api.rb', line 6771

def get_recipient_with_http_info(recipient_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.get_recipient ...'
  end
  # verify the required parameter 'recipient_id' is set
  if @api_client.config.client_side_validation && recipient_id.nil?
    fail ArgumentError, "Missing the required parameter 'recipient_id' when calling PlaidApi.get_recipient"
  end
  # resource path
  local_var_path = '/fdx/recipient/{recipientId}'.sub('{' + 'recipientId' + '}', CGI.escape(recipient_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'OAUTH-STATE-ID'] = opts[:'oauth_state_id'] if !opts[:'oauth_state_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetRecipientResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.get_recipient",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#get_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recipients(opts = {}) ⇒ GetRecipientsResponse

Get Recipients Returns a list of Recipients

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6824
6825
6826
6827
 
# File 'lib/plaid/api/plaid_api.rb', line 6824

def get_recipients(opts = {})
  data, _status_code, _headers = get_recipients_with_http_info(opts)
  data
end

#get_recipients_with_http_info(opts = {}) ⇒ Array<(GetRecipientsResponse, Integer, Hash)>

Get Recipients Returns a list of Recipients

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetRecipientsResponse, Integer, Hash)>) —

    GetRecipientsResponse data, response status code and response headers



6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
 
# File 'lib/plaid/api/plaid_api.rb', line 6833

def get_recipients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.get_recipients ...'
  end
  # resource path
  local_var_path = '/fdx/recipients'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetRecipientsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.get_recipients",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_documents_uploads_get(identity_documents_uploads_get_request, opts = {}) ⇒ IdentityDocumentsUploadsGetResponse

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

Parameters:

Returns:



6882
6883
6884
6885
 
# File 'lib/plaid/api/plaid_api.rb', line 6882

def identity_documents_uploads_get(identity_documents_uploads_get_request, opts = {})
  data, _status_code, _headers = identity_documents_uploads_get_with_http_info(identity_documents_uploads_get_request, opts)
  data
end

#identity_documents_uploads_get_with_http_info(identity_documents_uploads_get_request, opts = {}) ⇒ Array<(IdentityDocumentsUploadsGetResponse, Integer, Hash)>

Returns uploaded document identity Use &#x60;/identity/documents/uploads/get&#x60; to retrieve identity details when using [Identity Document Upload](plaid.com/docs/identity/identity-document-upload/).

Parameters:

Returns:



6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
 
# File 'lib/plaid/api/plaid_api.rb', line 6892

def identity_documents_uploads_get_with_http_info(identity_documents_uploads_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_documents_uploads_get ...'
  end
  # verify the required parameter 'identity_documents_uploads_get_request' is set
  if @api_client.config.client_side_validation && identity_documents_uploads_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_documents_uploads_get_request' when calling PlaidApi.identity_documents_uploads_get"
  end
  # resource path
  local_var_path = '/identity/documents/uploads/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_documents_uploads_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityDocumentsUploadsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_documents_uploads_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_documents_uploads_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_get(identity_get_request, opts = {}) ⇒ IdentityGetResponse

Retrieve identity data The ‘/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. 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).

Parameters:

  • identity_get_request (IdentityGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6950
6951
6952
6953
 
# File 'lib/plaid/api/plaid_api.rb', line 6950

def identity_get(identity_get_request, opts = {})
  data, _status_code, _headers = identity_get_with_http_info(identity_get_request, opts)
  data
end

#identity_get_with_http_info(identity_get_request, opts = {}) ⇒ Array<(IdentityGetResponse, Integer, Hash)>

Retrieve identity data The &#x60;/identity/get&#x60; 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 &#x60;owners&#x60; object is not returned, and instead identity information is returned in the top level &#x60;identity&#x60; object. For more details, see [Plaid API versioning](plaid.com/docs/api/versioning/#version-2019-05-29).

Parameters:

  • identity_get_request (IdentityGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IdentityGetResponse, Integer, Hash)>) —

    IdentityGetResponse data, response status code and response headers



6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
 
# File 'lib/plaid/api/plaid_api.rb', line 6960

def identity_get_with_http_info(identity_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_get ...'
  end
  # verify the required parameter 'identity_get_request' is set
  if @api_client.config.client_side_validation && identity_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_get_request' when calling PlaidApi.identity_get"
  end
  # resource path
  local_var_path = '/identity/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_match(identity_match_request, opts = {}) ⇒ IdentityMatchResponse

Retrieve identity match score The ‘/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder’s financial institution. Fields within the ‘balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` or `/signal/evaluate` for real-time data.

Parameters:

  • identity_match_request (IdentityMatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7018
7019
7020
7021
 
# File 'lib/plaid/api/plaid_api.rb', line 7018

def identity_match(identity_match_request, opts = {})
  data, _status_code, _headers = identity_match_with_http_info(identity_match_request, opts)
  data
end

#identity_match_with_http_info(identity_match_request, opts = {}) ⇒ Array<(IdentityMatchResponse, Integer, Hash)>

Retrieve identity match score The &#x60;/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/identity/match&#x60;. Instead, use the free &#x60;/accounts/get&#x60; endpoint to request balance cached data, or &#x60;/accounts/balance/get&#x60; or &#x60;/signal/evaluate&#x60; for real-time data.

Parameters:

  • identity_match_request (IdentityMatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IdentityMatchResponse, Integer, Hash)>) —

    IdentityMatchResponse data, response status code and response headers



7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
 
# File 'lib/plaid/api/plaid_api.rb', line 7028

def identity_match_with_http_info(identity_match_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_match ...'
  end
  # verify the required parameter 'identity_match_request' is set
  if @api_client.config.client_side_validation && identity_match_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_match_request' when calling PlaidApi.identity_match"
  end
  # resource path
  local_var_path = '/identity/match'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_match_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityMatchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_match",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_refresh(identity_refresh_request, opts = {}) ⇒ IdentityRefreshResponse

Refresh identity data ‘/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur 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_update). 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.

Parameters:

Returns:



7086
7087
7088
7089
 
# File 'lib/plaid/api/plaid_api.rb', line 7086

def identity_refresh(identity_refresh_request, opts = {})
  data, _status_code, _headers = identity_refresh_with_http_info(identity_refresh_request, opts)
  data
end

#identity_refresh_with_http_info(identity_refresh_request, opts = {}) ⇒ Array<(IdentityRefreshResponse, Integer, Hash)>

Refresh identity data &#x60;/identity/refresh&#x60; 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 &#x60;/identity/refresh&#x60;, Plaid will fire a webhook [&#x60;DEFAULT_UPDATE&#x60;](plaid.com/docs/api/products/identity/#default_update). 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. &#x60;/identity/refresh&#x60; 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.

Parameters:

Returns:

  • (Array<(IdentityRefreshResponse, Integer, Hash)>) —

    IdentityRefreshResponse data, response status code and response headers



7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
 
# File 'lib/plaid/api/plaid_api.rb', line 7096

def identity_refresh_with_http_info(identity_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_refresh ...'
  end
  # verify the required parameter 'identity_refresh_request' is set
  if @api_client.config.client_side_validation && identity_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_refresh_request' when calling PlaidApi.identity_refresh"
  end
  # resource path
  local_var_path = '/identity/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_verification_autofill_create(identity_verification_autofill_create_request, opts = {}) ⇒ IdentityVerificationAutofillCreateResponse

Create autofill for an Identity Verification Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.

Parameters:

Returns:



7154
7155
7156
7157
 
# File 'lib/plaid/api/plaid_api.rb', line 7154

def identity_verification_autofill_create(identity_verification_autofill_create_request, opts = {})
  data, _status_code, _headers = identity_verification_autofill_create_with_http_info(identity_verification_autofill_create_request, opts)
  data
end

#identity_verification_autofill_create_with_http_info(identity_verification_autofill_create_request, opts = {}) ⇒ Array<(IdentityVerificationAutofillCreateResponse, Integer, Hash)>

Create autofill for an Identity Verification Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.

Parameters:

Returns:



7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
 
# File 'lib/plaid/api/plaid_api.rb', line 7164

def identity_verification_autofill_create_with_http_info(identity_verification_autofill_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_autofill_create ...'
  end
  # verify the required parameter 'identity_verification_autofill_create_request' is set
  if @api_client.config.client_side_validation && identity_verification_autofill_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_verification_autofill_create_request' when calling PlaidApi.identity_verification_autofill_create"
  end
  # resource path
  local_var_path = '/identity_verification/autofill/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_autofill_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationAutofillCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_verification_autofill_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_verification_autofill_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_verification_create(identity_verification_create_request, opts = {}) ⇒ IdentityVerificationCreateResponse

Create a new Identity Verification 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.

Parameters:

Returns:



7222
7223
7224
7225
 
# File 'lib/plaid/api/plaid_api.rb', line 7222

def identity_verification_create(identity_verification_create_request, opts = {})
  data, _status_code, _headers = identity_verification_create_with_http_info(identity_verification_create_request, opts)
  data
end

#identity_verification_create_with_http_info(identity_verification_create_request, opts = {}) ⇒ Array<(IdentityVerificationCreateResponse, Integer, Hash)>

Create a new Identity Verification Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60; field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If &#x60;user_id&#x60; is provided, there must be an associated user otherwise an error will be returned. If you don&#39;t know whether an active Identity Verification exists for a given &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, you can specify &#x60;&quot;is_idempotent&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with a &#x60;200 OK&#x60; HTTP status code. If &#x60;user_id&#x60; 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 &#x60;user_id&#x60; is provided, user information can not be included in the request body. Please use the &#x60;/user/update&#x60; endpoint to update user data instead.

Parameters:

Returns:



7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
 
# File 'lib/plaid/api/plaid_api.rb', line 7232

def identity_verification_create_with_http_info(identity_verification_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_create ...'
  end
  # verify the required parameter 'identity_verification_create_request' is set
  if @api_client.config.client_side_validation && identity_verification_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_verification_create_request' when calling PlaidApi.identity_verification_create"
  end
  # resource path
  local_var_path = '/identity_verification/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_verification_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_verification_get(identity_verification_get_request, opts = {}) ⇒ IdentityVerificationGetResponse

Retrieve Identity Verification Retrieve a previously created Identity Verification.

Parameters:

Returns:



7290
7291
7292
7293
 
# File 'lib/plaid/api/plaid_api.rb', line 7290

def identity_verification_get(identity_verification_get_request, opts = {})
  data, _status_code, _headers = identity_verification_get_with_http_info(identity_verification_get_request, opts)
  data
end

#identity_verification_get_with_http_info(identity_verification_get_request, opts = {}) ⇒ Array<(IdentityVerificationGetResponse, Integer, Hash)>

Retrieve Identity Verification Retrieve a previously created Identity Verification.

Parameters:

Returns:



7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
 
# File 'lib/plaid/api/plaid_api.rb', line 7300

def identity_verification_get_with_http_info(identity_verification_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_get ...'
  end
  # verify the required parameter 'identity_verification_get_request' is set
  if @api_client.config.client_side_validation && identity_verification_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_verification_get_request' when calling PlaidApi.identity_verification_get"
  end
  # resource path
  local_var_path = '/identity_verification/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_verification_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_verification_list(identity_verification_list_request, opts = {}) ⇒ IdentityVerificationListResponse

List Identity Verifications Filter and list Identity Verifications created by your account

Parameters:

Returns:



7358
7359
7360
7361
 
# File 'lib/plaid/api/plaid_api.rb', line 7358

def identity_verification_list(identity_verification_list_request, opts = {})
  data, _status_code, _headers = identity_verification_list_with_http_info(identity_verification_list_request, opts)
  data
end

#identity_verification_list_with_http_info(identity_verification_list_request, opts = {}) ⇒ Array<(IdentityVerificationListResponse, Integer, Hash)>

List Identity Verifications Filter and list Identity Verifications created by your account

Parameters:

Returns:



7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
 
# File 'lib/plaid/api/plaid_api.rb', line 7368

def identity_verification_list_with_http_info(identity_verification_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_list ...'
  end
  # verify the required parameter 'identity_verification_list_request' is set
  if @api_client.config.client_side_validation && identity_verification_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_verification_list_request' when calling PlaidApi.identity_verification_list"
  end
  # resource path
  local_var_path = '/identity_verification/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_verification_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_verification_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#identity_verification_retry(identity_verification_retry_request, opts = {}) ⇒ IdentityVerificationRetryResponse

Retry an Identity Verification Allow a customer to retry their Identity Verification

Parameters:

Returns:



7426
7427
7428
7429
 
# File 'lib/plaid/api/plaid_api.rb', line 7426

def identity_verification_retry(identity_verification_retry_request, opts = {})
  data, _status_code, _headers = identity_verification_retry_with_http_info(identity_verification_retry_request, opts)
  data
end

#identity_verification_retry_with_http_info(identity_verification_retry_request, opts = {}) ⇒ Array<(IdentityVerificationRetryResponse, Integer, Hash)>

Retry an Identity Verification Allow a customer to retry their Identity Verification

Parameters:

Returns:



7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
 
# File 'lib/plaid/api/plaid_api.rb', line 7436

def identity_verification_retry_with_http_info(identity_verification_retry_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_retry ...'
  end
  # verify the required parameter 'identity_verification_retry_request' is set
  if @api_client.config.client_side_validation && identity_verification_retry_request.nil?
    fail ArgumentError, "Missing the required parameter 'identity_verification_retry_request' when calling PlaidApi.identity_verification_retry"
  end
  # resource path
  local_var_path = '/identity_verification/retry'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_retry_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationRetryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.identity_verification_retry",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#identity_verification_retry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#income_verification_create(income_verification_create_request, opts = {}) ⇒ IncomeVerificationCreateResponse

(Deprecated) Create an income verification instance ‘/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.

Parameters:

Returns:



7494
7495
7496
7497
 
# File 'lib/plaid/api/plaid_api.rb', line 7494

def income_verification_create(income_verification_create_request, opts = {})
  data, _status_code, _headers = income_verification_create_with_http_info(income_verification_create_request, opts)
  data
end

#income_verification_create_with_http_info(income_verification_create_request, opts = {}) ⇒ Array<(IncomeVerificationCreateResponse, Integer, Hash)>

(Deprecated) Create an income verification instance &#x60;/income/verification/create&#x60; begins the income verification process by returning an &#x60;income_verification_id&#x60;. You can then provide the &#x60;income_verification_id&#x60; to &#x60;/link/token/create&#x60; under the &#x60;income_verification&#x60; parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an &#x60;INCOME&#x60; webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.

Parameters:

Returns:



7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
 
# File 'lib/plaid/api/plaid_api.rb', line 7504

def income_verification_create_with_http_info(income_verification_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_create ...'
  end
  # verify the required parameter 'income_verification_create_request' is set
  if @api_client.config.client_side_validation && income_verification_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'income_verification_create_request' when calling PlaidApi.income_verification_create"
  end
  # resource path
  local_var_path = '/income/verification/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IncomeVerificationCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.income_verification_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#income_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#income_verification_documents_download(income_verification_documents_download_request, opts = {}) ⇒ File

(Deprecated) Download the original documents used for income verification ‘/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.

Parameters:

Returns:

  • (File) 


7562
7563
7564
7565
 
# File 'lib/plaid/api/plaid_api.rb', line 7562

def income_verification_documents_download(income_verification_documents_download_request, opts = {})
  data, _status_code, _headers = income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts)
  data
end

#income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

(Deprecated) Download the original documents used for income verification &#x60;/income/verification/documents/download&#x60; 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 &#x60;/income/verification/documents/download&#x60; is a ZIP file in binary data. If a &#x60;document_id&#x60; is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
 
# File 'lib/plaid/api/plaid_api.rb', line 7572

def income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
  end
  # verify the required parameter 'income_verification_documents_download_request' is set
  if @api_client.config.client_side_validation && income_verification_documents_download_request.nil?
    fail ArgumentError, "Missing the required parameter 'income_verification_documents_download_request' when calling PlaidApi.income_verification_documents_download"
  end
  # resource path
  local_var_path = '/income/verification/documents/download'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/zip', 'application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_documents_download_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.income_verification_documents_download",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#income_verification_documents_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#income_verification_paystubs_get(income_verification_paystubs_get_request, opts = {}) ⇒ IncomeVerificationPaystubsGetResponse

(Deprecated) Retrieve information from the paystubs used for income verification ‘/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user’s income. It can be called once the status of the verification has been set to ‘VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.

Parameters:

Returns:



7630
7631
7632
7633
 
# File 'lib/plaid/api/plaid_api.rb', line 7630

def income_verification_paystubs_get(income_verification_paystubs_get_request, opts = {})
  data, _status_code, _headers = income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts)
  data
end

#income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts = {}) ⇒ Array<(IncomeVerificationPaystubsGetResponse, Integer, Hash)>

(Deprecated) Retrieve information from the paystubs used for income verification &#x60;/income/verification/paystubs/get&#x60; returns the information collected from the paystubs that were used to verify an end user&#39;s income. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; 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 &#x60;/credit/payroll_income/get&#x60; instead.

Parameters:

Returns:



7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
 
# File 'lib/plaid/api/plaid_api.rb', line 7640

def income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystubs_get ...'
  end
  # verify the required parameter 'income_verification_paystubs_get_request' is set
  if @api_client.config.client_side_validation && income_verification_paystubs_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'income_verification_paystubs_get_request' when calling PlaidApi.income_verification_paystubs_get"
  end
  # resource path
  local_var_path = '/income/verification/paystubs/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystubs_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.income_verification_paystubs_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#income_verification_paystubs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#income_verification_precheck(income_verification_precheck_request, opts = {}) ⇒ IncomeVerificationPrecheckResponse

(Deprecated) Check digital income verification eligibility and optimize conversion ‘/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead.

Parameters:

Returns:



7698
7699
7700
7701
 
# File 'lib/plaid/api/plaid_api.rb', line 7698

def income_verification_precheck(income_verification_precheck_request, opts = {})
  data, _status_code, _headers = income_verification_precheck_with_http_info(income_verification_precheck_request, opts)
  data
end

#income_verification_precheck_with_http_info(income_verification_precheck_request, opts = {}) ⇒ Array<(IncomeVerificationPrecheckResponse, Integer, Hash)>

(Deprecated) Check digital income verification eligibility and optimize conversion &#x60;/income/verification/precheck&#x60; 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 &#x60;precheck_id&#x60; that can be provided to &#x60;/link/token/create&#x60;. If the user is eligible for digital verification, providing the &#x60;precheck_id&#x60; 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 &#x60;precheck_id&#x60; can still be provided to &#x60;/link/token/create&#x60; 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 &#x60;employer&#x60; or &#x60;transactions_access_tokens&#x60; data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use &#x60;/credit/payroll_income/precheck&#x60; instead.

Parameters:

Returns:



7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
 
# File 'lib/plaid/api/plaid_api.rb', line 7708

def income_verification_precheck_with_http_info(income_verification_precheck_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_precheck ...'
  end
  # verify the required parameter 'income_verification_precheck_request' is set
  if @api_client.config.client_side_validation && income_verification_precheck_request.nil?
    fail ArgumentError, "Missing the required parameter 'income_verification_precheck_request' when calling PlaidApi.income_verification_precheck"
  end
  # resource path
  local_var_path = '/income/verification/precheck'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_precheck_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IncomeVerificationPrecheckResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.income_verification_precheck",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#income_verification_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#income_verification_taxforms_get(income_verification_taxforms_get_request, opts = {}) ⇒ IncomeVerificationTaxformsGetResponse

(Deprecated) Retrieve information from the tax documents used for income verification ‘/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user”s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.

Parameters:

Returns:



7766
7767
7768
7769
 
# File 'lib/plaid/api/plaid_api.rb', line 7766

def income_verification_taxforms_get(income_verification_taxforms_get_request, opts = {})
  data, _status_code, _headers = income_verification_taxforms_get_with_http_info(income_verification_taxforms_get_request, opts)
  data
end

#income_verification_taxforms_get_with_http_info(income_verification_taxforms_get_request, opts = {}) ⇒ Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>

(Deprecated) Retrieve information from the tax documents used for income verification &#x60;/income/verification/taxforms/get&#x60; returns the information collected from forms that were used to verify an end user&#39;&#39;s income. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; 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 &#x60;/credit/payroll_income/get&#x60; instead.

Parameters:

Returns:



7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
 
# File 'lib/plaid/api/plaid_api.rb', line 7776

def income_verification_taxforms_get_with_http_info(income_verification_taxforms_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_taxforms_get ...'
  end
  # verify the required parameter 'income_verification_taxforms_get_request' is set
  if @api_client.config.client_side_validation && income_verification_taxforms_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'income_verification_taxforms_get_request' when calling PlaidApi.income_verification_taxforms_get"
  end
  # resource path
  local_var_path = '/income/verification/taxforms/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_taxforms_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IncomeVerificationTaxformsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.income_verification_taxforms_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#income_verification_taxforms_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#institutions_get(institutions_get_request, opts = {}) ⇒ InstitutionsGetResponse

Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.

Parameters:

Returns:



7834
7835
7836
7837
 
# File 'lib/plaid/api/plaid_api.rb', line 7834

def institutions_get(institutions_get_request, opts = {})
  data, _status_code, _headers = institutions_get_with_http_info(institutions_get_request, opts)
  data
end

#institutions_get_by_id(institutions_get_by_id_request, opts = {}) ⇒ InstitutionsGetByIdResponse

Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the ‘public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead.

Parameters:

Returns:



7902
7903
7904
7905
 
# File 'lib/plaid/api/plaid_api.rb', line 7902

def institutions_get_by_id(institutions_get_by_id_request, opts = {})
  data, _status_code, _headers = institutions_get_by_id_with_http_info(institutions_get_by_id_request, opts)
  data
end

#institutions_get_by_id_with_http_info(institutions_get_by_id_request, opts = {}) ⇒ Array<(InstitutionsGetByIdResponse, Integer, Hash)>

Get details of an institution Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; to authenticate to this endpoint. The &#x60;public_key&#x60; has been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.

Parameters:

Returns:

  • (Array<(InstitutionsGetByIdResponse, Integer, Hash)>) —

    InstitutionsGetByIdResponse data, response status code and response headers



7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
 
# File 'lib/plaid/api/plaid_api.rb', line 7912

def institutions_get_by_id_with_http_info(institutions_get_by_id_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_get_by_id ...'
  end
  # verify the required parameter 'institutions_get_by_id_request' is set
  if @api_client.config.client_side_validation && institutions_get_by_id_request.nil?
    fail ArgumentError, "Missing the required parameter 'institutions_get_by_id_request' when calling PlaidApi.institutions_get_by_id"
  end
  # resource path
  local_var_path = '/institutions/get_by_id'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_get_by_id_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InstitutionsGetByIdResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.institutions_get_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#institutions_get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#institutions_get_with_http_info(institutions_get_request, opts = {}) ⇒ Array<(InstitutionsGetResponse, Integer, Hash)>

Get details of all supported institutions Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.

Parameters:

Returns:

  • (Array<(InstitutionsGetResponse, Integer, Hash)>) —

    InstitutionsGetResponse data, response status code and response headers



7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
 
# File 'lib/plaid/api/plaid_api.rb', line 7844

def institutions_get_with_http_info(institutions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_get ...'
  end
  # verify the required parameter 'institutions_get_request' is set
  if @api_client.config.client_side_validation && institutions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'institutions_get_request' when calling PlaidApi.institutions_get"
  end
  # resource path
  local_var_path = '/institutions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InstitutionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.institutions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#institutions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#institutions_search(institutions_search_request, opts = {}) ⇒ InstitutionsSearchResponse

Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the ‘public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead.

Parameters:

Returns:



7970
7971
7972
7973
 
# File 'lib/plaid/api/plaid_api.rb', line 7970

def institutions_search(institutions_search_request, opts = {})
  data, _status_code, _headers = institutions_search_with_http_info(institutions_search_request, opts)
  data
end

#institutions_search_with_http_info(institutions_search_request, opts = {}) ⇒ Array<(InstitutionsSearchResponse, Integer, Hash)>

Search institutions Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; parameters to authenticate to this endpoint. The &#x60;public_key&#x60; parameter has since been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.

Parameters:

Returns:

  • (Array<(InstitutionsSearchResponse, Integer, Hash)>) —

    InstitutionsSearchResponse data, response status code and response headers



7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
 
# File 'lib/plaid/api/plaid_api.rb', line 7980

def institutions_search_with_http_info(institutions_search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.institutions_search ...'
  end
  # verify the required parameter 'institutions_search_request' is set
  if @api_client.config.client_side_validation && institutions_search_request.nil?
    fail ArgumentError, "Missing the required parameter 'institutions_search_request' when calling PlaidApi.institutions_search"
  end
  # resource path
  local_var_path = '/institutions/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(institutions_search_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InstitutionsSearchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.institutions_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#institutions_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#investments_auth_get(investments_auth_get_request, opts = {}) ⇒ InvestmentsAuthGetResponse

Get data needed to authorize an investments transfer The ‘/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings

Parameters:

Returns:



8038
8039
8040
8041
 
# File 'lib/plaid/api/plaid_api.rb', line 8038

def investments_auth_get(investments_auth_get_request, opts = {})
  data, _status_code, _headers = investments_auth_get_with_http_info(investments_auth_get_request, opts)
  data
end

#investments_auth_get_with_http_info(investments_auth_get_request, opts = {}) ⇒ Array<(InvestmentsAuthGetResponse, Integer, Hash)>

Get data needed to authorize an investments transfer The &#x60;/investments/auth/get&#x60; endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings

Parameters:

Returns:

  • (Array<(InvestmentsAuthGetResponse, Integer, Hash)>) —

    InvestmentsAuthGetResponse data, response status code and response headers



8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
 
# File 'lib/plaid/api/plaid_api.rb', line 8048

def investments_auth_get_with_http_info(investments_auth_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.investments_auth_get ...'
  end
  # verify the required parameter 'investments_auth_get_request' is set
  if @api_client.config.client_side_validation && investments_auth_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'investments_auth_get_request' when calling PlaidApi.investments_auth_get"
  end
  # resource path
  local_var_path = '/investments/auth/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_auth_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InvestmentsAuthGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.investments_auth_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#investments_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#investments_holdings_get(investments_holdings_get_request, opts = {}) ⇒ InvestmentsHoldingsGetResponse

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

Parameters:

Returns:



8106
8107
8108
8109
 
# File 'lib/plaid/api/plaid_api.rb', line 8106

def investments_holdings_get(investments_holdings_get_request, opts = {})
  data, _status_code, _headers = investments_holdings_get_with_http_info(investments_holdings_get_request, opts)
  data
end

#investments_holdings_get_with_http_info(investments_holdings_get_request, opts = {}) ⇒ Array<(InvestmentsHoldingsGetResponse, Integer, Hash)>

Get Investment holdings The &#x60;/investments/holdings/get&#x60; endpoint allows developers to receive user-authorized stock position data for &#x60;investment&#x60;-type accounts.

Parameters:

Returns:



8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
 
# File 'lib/plaid/api/plaid_api.rb', line 8116

def investments_holdings_get_with_http_info(investments_holdings_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.investments_holdings_get ...'
  end
  # verify the required parameter 'investments_holdings_get_request' is set
  if @api_client.config.client_side_validation && investments_holdings_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'investments_holdings_get_request' when calling PlaidApi.investments_holdings_get"
  end
  # resource path
  local_var_path = '/investments/holdings/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_holdings_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InvestmentsHoldingsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.investments_holdings_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#investments_refresh(investments_refresh_request, opts = {}) ⇒ InvestmentsRefreshResponse

Refresh investment data ‘/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest 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/#investments_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.

Parameters:

Returns:



8174
8175
8176
8177
 
# File 'lib/plaid/api/plaid_api.rb', line 8174

def investments_refresh(investments_refresh_request, opts = {})
  data, _status_code, _headers = investments_refresh_with_http_info(investments_refresh_request, opts)
  data
end

#investments_refresh_with_http_info(investments_refresh_request, opts = {}) ⇒ Array<(InvestmentsRefreshResponse, Integer, Hash)>

Refresh investment data &#x60;/investments/refresh&#x60; 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 &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [&#x60;INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE&#x60;](plaid.com/docs/api/products/investments/#investments_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 &#x60;/sandbox/item/fire_webhook&#x60;. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. Note that the &#x60;/investments/refresh&#x60; 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 &#x60;PRODUCT_NOT_SUPPORTED&#x60; 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. &#x60;/investments/refresh&#x60; 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.

Parameters:

Returns:

  • (Array<(InvestmentsRefreshResponse, Integer, Hash)>) —

    InvestmentsRefreshResponse data, response status code and response headers



8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
 
# File 'lib/plaid/api/plaid_api.rb', line 8184

def investments_refresh_with_http_info(investments_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.investments_refresh ...'
  end
  # verify the required parameter 'investments_refresh_request' is set
  if @api_client.config.client_side_validation && investments_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'investments_refresh_request' when calling PlaidApi.investments_refresh"
  end
  # resource path
  local_var_path = '/investments/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InvestmentsRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.investments_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#investments_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#investments_transactions_get(investments_transactions_get_request, opts = {}) ⇒ InvestmentsTransactionsGetResponse

Get investment transactions The ‘/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the `async_update` option). Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when `async_update` is set to true) may not be immediately available to `/investments/transactions/get`. To be alerted when the data is ready to be fetched, listen for the `HISTORICAL_UPDATE` webhook. If no investments history is ready when `/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.

Parameters:

Returns:



8242
8243
8244
8245
 
# File 'lib/plaid/api/plaid_api.rb', line 8242

def investments_transactions_get(investments_transactions_get_request, opts = {})
  data, _status_code, _headers = investments_transactions_get_with_http_info(investments_transactions_get_request, opts)
  data
end

#investments_transactions_get_with_http_info(investments_transactions_get_request, opts = {}) ⇒ Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>

Get investment transactions The &#x60;/investments/transactions/get&#x60; 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 &#x60;total_investment_transactions&#x60; 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 &#x60;async_update&#x60; option). Instead, if transactions data is not ready when &#x60;/investments/transactions/get&#x60; is first called, Plaid will wait for the data. For this reason, calling &#x60;/investments/transactions/get&#x60; immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when &#x60;async_update&#x60; is set to true) may not be immediately available to &#x60;/investments/transactions/get&#x60;. To be alerted when the data is ready to be fetched, listen for the &#x60;HISTORICAL_UPDATE&#x60; webhook. If no investments history is ready when &#x60;/investments/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.

Parameters:

Returns:



8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
 
# File 'lib/plaid/api/plaid_api.rb', line 8252

def investments_transactions_get_with_http_info(investments_transactions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.investments_transactions_get ...'
  end
  # verify the required parameter 'investments_transactions_get_request' is set
  if @api_client.config.client_side_validation && investments_transactions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'investments_transactions_get_request' when calling PlaidApi.investments_transactions_get"
  end
  # resource path
  local_var_path = '/investments/transactions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_transactions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InvestmentsTransactionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.investments_transactions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#investments_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issues_get(issues_get_request, opts = {}) ⇒ IssuesGetResponse

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

Parameters:

  • issues_get_request (IssuesGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8310
8311
8312
8313
 
# File 'lib/plaid/api/plaid_api.rb', line 8310

def issues_get(issues_get_request, opts = {})
  data, _status_code, _headers = issues_get_with_http_info(issues_get_request, opts)
  data
end

#issues_get_with_http_info(issues_get_request, opts = {}) ⇒ Array<(IssuesGetResponse, Integer, Hash)>

Get an Issue Retrieve detailed information about a specific &#x60;Issue&#x60;. This endpoint returns a single &#x60;Issue&#x60; object.

Parameters:

  • issues_get_request (IssuesGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IssuesGetResponse, Integer, Hash)>) —

    IssuesGetResponse data, response status code and response headers



8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
 
# File 'lib/plaid/api/plaid_api.rb', line 8320

def issues_get_with_http_info(issues_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.issues_get ...'
  end
  # verify the required parameter 'issues_get_request' is set
  if @api_client.config.client_side_validation && issues_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'issues_get_request' when calling PlaidApi.issues_get"
  end
  # resource path
  local_var_path = '/issues/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IssuesGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.issues_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issues_search(issues_search_request, opts = {}) ⇒ IssuesSearchResponse

Search for an Issue 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.

Parameters:

  • issues_search_request (IssuesSearchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8378
8379
8380
8381
 
# File 'lib/plaid/api/plaid_api.rb', line 8378

def issues_search(issues_search_request, opts = {})
  data, _status_code, _headers = issues_search_with_http_info(issues_search_request, opts)
  data
end

#issues_search_with_http_info(issues_search_request, opts = {}) ⇒ Array<(IssuesSearchResponse, Integer, Hash)>

Search for an Issue Search for an issue associated with one of the following identifiers: &#x60;item_id&#x60;, &#x60;link_session_id&#x60; or Link session &#x60;request_id&#x60;. This endpoint returns a list of &#x60;Issue&#x60; 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.

Parameters:

  • issues_search_request (IssuesSearchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IssuesSearchResponse, Integer, Hash)>) —

    IssuesSearchResponse data, response status code and response headers



8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
 
# File 'lib/plaid/api/plaid_api.rb', line 8388

def issues_search_with_http_info(issues_search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.issues_search ...'
  end
  # verify the required parameter 'issues_search_request' is set
  if @api_client.config.client_side_validation && issues_search_request.nil?
    fail ArgumentError, "Missing the required parameter 'issues_search_request' when calling PlaidApi.issues_search"
  end
  # resource path
  local_var_path = '/issues/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_search_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IssuesSearchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.issues_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#issues_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issues_subscribe(issues_subscribe_request, opts = {}) ⇒ IssuesSubscribeResponse

Subscribe to an Issue 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.

Parameters:

Returns:



8446
8447
8448
8449
 
# File 'lib/plaid/api/plaid_api.rb', line 8446

def issues_subscribe(issues_subscribe_request, opts = {})
  data, _status_code, _headers = issues_subscribe_with_http_info(issues_subscribe_request, opts)
  data
end

#issues_subscribe_with_http_info(issues_subscribe_request, opts = {}) ⇒ Array<(IssuesSubscribeResponse, Integer, Hash)>

Subscribe to an Issue Allows a user to subscribe to updates on a specific &#x60;Issue&#x60; using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.

Parameters:

Returns:

  • (Array<(IssuesSubscribeResponse, Integer, Hash)>) —

    IssuesSubscribeResponse data, response status code and response headers



8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
 
# File 'lib/plaid/api/plaid_api.rb', line 8456

def issues_subscribe_with_http_info(issues_subscribe_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.issues_subscribe ...'
  end
  # verify the required parameter 'issues_subscribe_request' is set
  if @api_client.config.client_side_validation && issues_subscribe_request.nil?
    fail ArgumentError, "Missing the required parameter 'issues_subscribe_request' when calling PlaidApi.issues_subscribe"
  end
  # resource path
  local_var_path = '/issues/subscribe'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_subscribe_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IssuesSubscribeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.issues_subscribe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#issues_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_access_token_invalidate(item_access_token_invalidate_request, opts = {}) ⇒ ItemAccessTokenInvalidateResponse

Invalidate access_token By default, the ‘access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.

Parameters:

Returns:



8514
8515
8516
8517
 
# File 'lib/plaid/api/plaid_api.rb', line 8514

def item_access_token_invalidate(item_access_token_invalidate_request, opts = {})
  data, _status_code, _headers = item_access_token_invalidate_with_http_info(item_access_token_invalidate_request, opts)
  data
end

#item_access_token_invalidate_with_http_info(item_access_token_invalidate_request, opts = {}) ⇒ Array<(ItemAccessTokenInvalidateResponse, Integer, Hash)>

Invalidate access_token By default, the &#x60;access_token&#x60; associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the &#x60;/item/access_token/invalidate&#x60; endpoint to rotate the &#x60;access_token&#x60; associated with an Item. The endpoint returns a new &#x60;access_token&#x60; and immediately invalidates the previous &#x60;access_token&#x60;.

Parameters:

Returns:



8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
 
# File 'lib/plaid/api/plaid_api.rb', line 8524

def item_access_token_invalidate_with_http_info(item_access_token_invalidate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_access_token_invalidate ...'
  end
  # verify the required parameter 'item_access_token_invalidate_request' is set
  if @api_client.config.client_side_validation && item_access_token_invalidate_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_access_token_invalidate_request' when calling PlaidApi.item_access_token_invalidate"
  end
  # resource path
  local_var_path = '/item/access_token/invalidate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_access_token_invalidate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemAccessTokenInvalidateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_access_token_invalidate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_access_token_invalidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_activity_list(item_activity_list_request, opts = {}) ⇒ ItemActivityListResponse

List a historical log of user consent events List a historical log of user consent events

Parameters:

Returns:



8582
8583
8584
8585
 
# File 'lib/plaid/api/plaid_api.rb', line 8582

def item_activity_list(item_activity_list_request, opts = {})
  data, _status_code, _headers = item_activity_list_with_http_info(item_activity_list_request, opts)
  data
end

#item_activity_list_with_http_info(item_activity_list_request, opts = {}) ⇒ Array<(ItemActivityListResponse, Integer, Hash)>

List a historical log of user consent events List a historical log of user consent events

Parameters:

Returns:

  • (Array<(ItemActivityListResponse, Integer, Hash)>) —

    ItemActivityListResponse data, response status code and response headers



8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
 
# File 'lib/plaid/api/plaid_api.rb', line 8592

def item_activity_list_with_http_info(item_activity_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_activity_list ...'
  end
  # verify the required parameter 'item_activity_list_request' is set
  if @api_client.config.client_side_validation && item_activity_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_activity_list_request' when calling PlaidApi.item_activity_list"
  end
  # resource path
  local_var_path = '/item/activity/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_activity_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemActivityListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_activity_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_activity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_application_list(item_application_list_request, opts = {}) ⇒ ItemApplicationListResponse

List a user’s connected applications List a user’s connected applications

Parameters:

Returns:



8650
8651
8652
8653
 
# File 'lib/plaid/api/plaid_api.rb', line 8650

def item_application_list(item_application_list_request, opts = {})
  data, _status_code, _headers = item_application_list_with_http_info(item_application_list_request, opts)
  data
end

#item_application_list_with_http_info(item_application_list_request, opts = {}) ⇒ Array<(ItemApplicationListResponse, Integer, Hash)>

List a user’s connected applications List a user’s connected applications

Parameters:

Returns:

  • (Array<(ItemApplicationListResponse, Integer, Hash)>) —

    ItemApplicationListResponse data, response status code and response headers



8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
 
# File 'lib/plaid/api/plaid_api.rb', line 8660

def item_application_list_with_http_info(item_application_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_application_list ...'
  end
  # verify the required parameter 'item_application_list_request' is set
  if @api_client.config.client_side_validation && item_application_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_application_list_request' when calling PlaidApi.item_application_list"
  end
  # resource path
  local_var_path = '/item/application/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemApplicationListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_application_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_application_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_application_scopes_update(item_application_scopes_update_request, opts = {}) ⇒ ItemApplicationScopesUpdateResponse

Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application.

Parameters:

Returns:



8718
8719
8720
8721
 
# File 'lib/plaid/api/plaid_api.rb', line 8718

def item_application_scopes_update(item_application_scopes_update_request, opts = {})
  data, _status_code, _headers = item_application_scopes_update_with_http_info(item_application_scopes_update_request, opts)
  data
end

#item_application_scopes_update_with_http_info(item_application_scopes_update_request, opts = {}) ⇒ Array<(ItemApplicationScopesUpdateResponse, Integer, Hash)>

Update the scopes of access for a particular application Enable consumers to update product access on selected accounts for an application.

Parameters:

Returns:



8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
 
# File 'lib/plaid/api/plaid_api.rb', line 8728

def item_application_scopes_update_with_http_info(item_application_scopes_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_application_scopes_update ...'
  end
  # verify the required parameter 'item_application_scopes_update_request' is set
  if @api_client.config.client_side_validation && item_application_scopes_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_application_scopes_update_request' when calling PlaidApi.item_application_scopes_update"
  end
  # resource path
  local_var_path = '/item/application/scopes/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_scopes_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemApplicationScopesUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_application_scopes_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_application_scopes_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_application_unlink(item_application_unlink_request, opts = {}) ⇒ ItemApplicationUnlinkResponse

Unlink a user’s connected application Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.

Parameters:

Returns:



8786
8787
8788
8789
 
# File 'lib/plaid/api/plaid_api.rb', line 8786

def item_application_unlink(item_application_unlink_request, opts = {})
  data, _status_code, _headers = item_application_unlink_with_http_info(item_application_unlink_request, opts)
  data
end

#item_application_unlink_with_http_info(item_application_unlink_request, opts = {}) ⇒ Array<(ItemApplicationUnlinkResponse, Integer, Hash)>

Unlink a user’s connected application Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.

Parameters:

Returns:



8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
 
# File 'lib/plaid/api/plaid_api.rb', line 8796

def item_application_unlink_with_http_info(item_application_unlink_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_application_unlink ...'
  end
  # verify the required parameter 'item_application_unlink_request' is set
  if @api_client.config.client_side_validation && item_application_unlink_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_application_unlink_request' when calling PlaidApi.item_application_unlink"
  end
  # resource path
  local_var_path = '/item/application/unlink'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_unlink_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemApplicationUnlinkResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_application_unlink",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_application_unlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_create_public_token(item_public_token_create_request, opts = {}) ⇒ ItemPublicTokenCreateResponse

Create public token Note: As of July 2020, the ‘/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](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.

Parameters:

Returns:



8854
8855
8856
8857
 
# File 'lib/plaid/api/plaid_api.rb', line 8854

def item_create_public_token(item_public_token_create_request, opts = {})
  data, _status_code, _headers = item_create_public_token_with_http_info(item_public_token_create_request, opts)
  data
end

#item_create_public_token_with_http_info(item_public_token_create_request, opts = {}) ⇒ Array<(ItemPublicTokenCreateResponse, Integer, Hash)>

Create public token Note: As of July 2020, the &#x60;/item/public_token/create&#x60; endpoint is deprecated. Instead, use &#x60;/link/token/create&#x60; with an &#x60;access_token&#x60; 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 &#x60;/item/public_token/create&#x60; endpoint and then initialize Link with that &#x60;public_token&#x60;. A &#x60;public_token&#x60; is one-time use and expires after 30 minutes. You use a &#x60;public_token&#x60; to initialize Link in [update mode](plaid.com/docs/link/update-mode) for a particular Item. You can generate a &#x60;public_token&#x60; for an Item even if you did not use Link to create the Item originally. The &#x60;/item/public_token/create&#x60; endpoint is not used to create your initial &#x60;public_token&#x60;. If you have not already received an &#x60;access_token&#x60; for a specific Item, use Link to obtain your &#x60;public_token&#x60; instead. See the [Quickstart](plaid.com/docs/quickstart) for more information.

Parameters:

Returns:



8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
 
# File 'lib/plaid/api/plaid_api.rb', line 8864

def item_create_public_token_with_http_info(item_public_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_create_public_token ...'
  end
  # verify the required parameter 'item_public_token_create_request' is set
  if @api_client.config.client_side_validation && item_public_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_public_token_create_request' when calling PlaidApi.item_create_public_token"
  end
  # resource path
  local_var_path = '/item/public_token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemPublicTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_create_public_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_create_public_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_get(item_get_request, opts = {}) ⇒ ItemGetResponse

Retrieve an Item Returns information about the status of an Item.

Parameters:

  • item_get_request (ItemGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8922
8923
8924
8925
 
# File 'lib/plaid/api/plaid_api.rb', line 8922

def item_get(item_get_request, opts = {})
  data, _status_code, _headers = item_get_with_http_info(item_get_request, opts)
  data
end

#item_get_with_http_info(item_get_request, opts = {}) ⇒ Array<(ItemGetResponse, Integer, Hash)>

Retrieve an Item Returns information about the status of an Item.

Parameters:

  • item_get_request (ItemGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ItemGetResponse, Integer, Hash)>) —

    ItemGetResponse data, response status code and response headers



8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
 
# File 'lib/plaid/api/plaid_api.rb', line 8932

def item_get_with_http_info(item_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_get ...'
  end
  # verify the required parameter 'item_get_request' is set
  if @api_client.config.client_side_validation && item_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_get_request' when calling PlaidApi.item_get"
  end
  # resource path
  local_var_path = '/item/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_handle_fraud_report(item_handle_fraud_report_request, opts = {}) ⇒ ItemHandleFraudReportResponse

Report fraud for an Item 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.

Parameters:

Returns:



8990
8991
8992
8993
 
# File 'lib/plaid/api/plaid_api.rb', line 8990

def item_handle_fraud_report(item_handle_fraud_report_request, opts = {})
  data, _status_code, _headers = item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts)
  data
end

#item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts = {}) ⇒ Array<(ItemHandleFraudReportResponse, Integer, Hash)>

Report fraud for an Item Use this endpoint to create a fraud report and terminate the associated Item. The &#x60;access_token&#x60; associated with the Item will be deactivated and billing for the Item&#39;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.

Parameters:

Returns:



9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
 
# File 'lib/plaid/api/plaid_api.rb', line 9000

def item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_handle_fraud_report ...'
  end
  # verify the required parameter 'item_handle_fraud_report_request' is set
  if @api_client.config.client_side_validation && item_handle_fraud_report_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_handle_fraud_report_request' when calling PlaidApi.item_handle_fraud_report"
  end
  # resource path
  local_var_path = '/item/handle_fraud_report'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_handle_fraud_report_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemHandleFraudReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_handle_fraud_report",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_handle_fraud_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_import(item_import_request, opts = {}) ⇒ ItemImportResponse

Import Item ‘/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated.

Parameters:

  • item_import_request (ItemImportRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9058
9059
9060
9061
 
# File 'lib/plaid/api/plaid_api.rb', line 9058

def item_import(item_import_request, opts = {})
  data, _status_code, _headers = item_import_with_http_info(item_import_request, opts)
  data
end

#item_import_with_http_info(item_import_request, opts = {}) ⇒ Array<(ItemImportResponse, Integer, Hash)>

Import Item &#x60;/item/import&#x60; creates an Item via your Plaid Exchange Integration and returns an &#x60;access_token&#x60;. As part of an &#x60;/item/import&#x60; request, you will include a User ID (&#x60;user_auth.user_id&#x60;) and Authentication Token (&#x60;user_auth.auth_token&#x60;) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via &#x60;/item/import&#x60;, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated.

Parameters:

  • item_import_request (ItemImportRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ItemImportResponse, Integer, Hash)>) —

    ItemImportResponse data, response status code and response headers



9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
 
# File 'lib/plaid/api/plaid_api.rb', line 9068

def item_import_with_http_info(item_import_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_import ...'
  end
  # verify the required parameter 'item_import_request' is set
  if @api_client.config.client_side_validation && item_import_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_import_request' when calling PlaidApi.item_import"
  end
  # resource path
  local_var_path = '/item/import'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_import_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemImportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_import",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_products_terminate(item_products_terminate_request, opts = {}) ⇒ ItemProductsTerminateResponse

Terminate products for an Item 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.

Parameters:

Returns:



9126
9127
9128
9129
 
# File 'lib/plaid/api/plaid_api.rb', line 9126

def item_products_terminate(item_products_terminate_request, opts = {})
  data, _status_code, _headers = item_products_terminate_with_http_info(item_products_terminate_request, opts)
  data
end

#item_products_terminate_with_http_info(item_products_terminate_request, opts = {}) ⇒ Array<(ItemProductsTerminateResponse, Integer, Hash)>

Terminate products for an Item The &#x60;/item/products/terminate&#x60; endpoint allows you to terminate an Item. Once terminated, the &#x60;access_token&#x60; associated with the Item is no longer valid, billing for the Item&#39;s products is ended, and relevant webhooks are fired. &#x60;/item/products/terminate&#x60; is the recommended way to offboard users or disconnect accounts linked via Plaid.

Parameters:

Returns:



9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
 
# File 'lib/plaid/api/plaid_api.rb', line 9136

def item_products_terminate_with_http_info(item_products_terminate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_products_terminate ...'
  end
  # verify the required parameter 'item_products_terminate_request' is set
  if @api_client.config.client_side_validation && item_products_terminate_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_products_terminate_request' when calling PlaidApi.item_products_terminate"
  end
  # resource path
  local_var_path = '/item/products/terminate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_products_terminate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemProductsTerminateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_products_terminate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_products_terminate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_public_token_exchange(item_public_token_exchange_request, opts = {}) ⇒ ItemPublicTokenExchangeResponse

Exchange public token for an access token Exchange a Link ‘public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.

Parameters:

Returns:



9194
9195
9196
9197
 
# File 'lib/plaid/api/plaid_api.rb', line 9194

def item_public_token_exchange(item_public_token_exchange_request, opts = {})
  data, _status_code, _headers = item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts)
  data
end

#item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts = {}) ⇒ Array<(ItemPublicTokenExchangeResponse, Integer, Hash)>

Exchange public token for an access token Exchange a Link &#x60;public_token&#x60; for an API &#x60;access_token&#x60;. Link hands off the &#x60;public_token&#x60; client-side via the &#x60;onSuccess&#x60; callback once a user has successfully created an Item. The &#x60;public_token&#x60; is ephemeral and expires after 30 minutes. An &#x60;access_token&#x60; does not expire, but can be revoked by calling &#x60;/item/remove&#x60;. The response also includes an &#x60;item_id&#x60; that should be stored with the &#x60;access_token&#x60;. The &#x60;item_id&#x60; is used to identify an Item in a webhook. The &#x60;item_id&#x60; can also be retrieved by making an &#x60;/item/get&#x60; request.

Parameters:

Returns:



9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
 
# File 'lib/plaid/api/plaid_api.rb', line 9204

def item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_public_token_exchange ...'
  end
  # verify the required parameter 'item_public_token_exchange_request' is set
  if @api_client.config.client_side_validation && item_public_token_exchange_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_public_token_exchange_request' when calling PlaidApi.item_public_token_exchange"
  end
  # resource path
  local_var_path = '/item/public_token/exchange'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_exchange_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemPublicTokenExchangeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_public_token_exchange",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_public_token_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_remove(item_remove_request, opts = {}) ⇒ ItemRemoveResponse

Remove an Item The ‘/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. 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.

Parameters:

  • item_remove_request (ItemRemoveRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9262
9263
9264
9265
 
# File 'lib/plaid/api/plaid_api.rb', line 9262

def item_remove(item_remove_request, opts = {})
  data, _status_code, _headers = item_remove_with_http_info(item_remove_request, opts)
  data
end

#item_remove_with_http_info(item_remove_request, opts = {}) ⇒ Array<(ItemRemoveResponse, Integer, Hash)>

Remove an Item The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, 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 &#x60;/item/remove&#x60; 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 &#x60;/item/remove&#x60; 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 &#x60;/item/remove&#x60; 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 &#x60;/asset_report/remove&#x60; endpoint. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.

Parameters:

  • item_remove_request (ItemRemoveRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ItemRemoveResponse, Integer, Hash)>) —

    ItemRemoveResponse data, response status code and response headers



9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
 
# File 'lib/plaid/api/plaid_api.rb', line 9272

def item_remove_with_http_info(item_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_remove ...'
  end
  # verify the required parameter 'item_remove_request' is set
  if @api_client.config.client_side_validation && item_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_remove_request' when calling PlaidApi.item_remove"
  end
  # resource path
  local_var_path = '/item/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#item_webhook_update(item_webhook_update_request, opts = {}) ⇒ ItemWebhookUpdateResponse

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

Parameters:

Returns:



9330
9331
9332
9333
 
# File 'lib/plaid/api/plaid_api.rb', line 9330

def item_webhook_update(item_webhook_update_request, opts = {})
  data, _status_code, _headers = item_webhook_update_with_http_info(item_webhook_update_request, opts)
  data
end

#item_webhook_update_with_http_info(item_webhook_update_request, opts = {}) ⇒ Array<(ItemWebhookUpdateResponse, Integer, Hash)>

Update Webhook URL The POST &#x60;/item/webhook/update&#x60; allows you to update the webhook URL associated with an Item. This request triggers a [&#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60;](plaid.com/docs/api/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL.

Parameters:

Returns:

  • (Array<(ItemWebhookUpdateResponse, Integer, Hash)>) —

    ItemWebhookUpdateResponse data, response status code and response headers



9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
 
# File 'lib/plaid/api/plaid_api.rb', line 9340

def item_webhook_update_with_http_info(item_webhook_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.item_webhook_update ...'
  end
  # verify the required parameter 'item_webhook_update_request' is set
  if @api_client.config.client_side_validation && item_webhook_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'item_webhook_update_request' when calling PlaidApi.item_webhook_update"
  end
  # resource path
  local_var_path = '/item/webhook/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_webhook_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ItemWebhookUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.item_webhook_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#item_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#liabilities_get(liabilities_get_request, opts = {}) ⇒ LiabilitiesGetResponse

Retrieve Liabilities data The ‘/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](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`.

Parameters:

  • liabilities_get_request (LiabilitiesGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9398
9399
9400
9401
 
# File 'lib/plaid/api/plaid_api.rb', line 9398

def liabilities_get(liabilities_get_request, opts = {})
  data, _status_code, _headers = liabilities_get_with_http_info(liabilities_get_request, opts)
  data
end

#liabilities_get_with_http_info(liabilities_get_request, opts = {}) ⇒ Array<(LiabilitiesGetResponse, Integer, Hash)>

Retrieve Liabilities data The &#x60;/liabilities/get&#x60; 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 &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; 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 &#x60;/liabilities/get&#x60;.

Parameters:

  • liabilities_get_request (LiabilitiesGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LiabilitiesGetResponse, Integer, Hash)>) —

    LiabilitiesGetResponse data, response status code and response headers



9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
 
# File 'lib/plaid/api/plaid_api.rb', line 9408

def liabilities_get_with_http_info(liabilities_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.liabilities_get ...'
  end
  # verify the required parameter 'liabilities_get_request' is set
  if @api_client.config.client_side_validation && liabilities_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'liabilities_get_request' when calling PlaidApi.liabilities_get"
  end
  # resource path
  local_var_path = '/liabilities/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(liabilities_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LiabilitiesGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.liabilities_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#link_delivery_create(link_delivery_create_request, opts = {}) ⇒ LinkDeliveryCreateResponse

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

Parameters:

Returns:



9466
9467
9468
9469
 
# File 'lib/plaid/api/plaid_api.rb', line 9466

def link_delivery_create(link_delivery_create_request, opts = {})
  data, _status_code, _headers = link_delivery_create_with_http_info(link_delivery_create_request, opts)
  data
end

#link_delivery_create_with_http_info(link_delivery_create_request, opts = {}) ⇒ Array<(LinkDeliveryCreateResponse, Integer, Hash)>

Create Hosted Link session Use the &#x60;/link_delivery/create&#x60; endpoint to create a Hosted Link session.

Parameters:

Returns:

  • (Array<(LinkDeliveryCreateResponse, Integer, Hash)>) —

    LinkDeliveryCreateResponse data, response status code and response headers



9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
 
# File 'lib/plaid/api/plaid_api.rb', line 9476

def link_delivery_create_with_http_info(link_delivery_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_create ...'
  end
  # verify the required parameter 'link_delivery_create_request' is set
  if @api_client.config.client_side_validation && link_delivery_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'link_delivery_create_request' when calling PlaidApi.link_delivery_create"
  end
  # resource path
  local_var_path = '/link_delivery/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LinkDeliveryCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.link_delivery_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#link_delivery_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#link_delivery_get(link_delivery_get_request, opts = {}) ⇒ LinkDeliveryGetResponse

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

Parameters:

  • link_delivery_get_request (LinkDeliveryGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9534
9535
9536
9537
 
# File 'lib/plaid/api/plaid_api.rb', line 9534

def link_delivery_get(link_delivery_get_request, opts = {})
  data, _status_code, _headers = link_delivery_get_with_http_info(link_delivery_get_request, opts)
  data
end

#link_delivery_get_with_http_info(link_delivery_get_request, opts = {}) ⇒ Array<(LinkDeliveryGetResponse, Integer, Hash)>

Get Hosted Link session Use the &#x60;/link_delivery/get&#x60; endpoint to get the status of a Hosted Link session.

Parameters:

  • link_delivery_get_request (LinkDeliveryGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LinkDeliveryGetResponse, Integer, Hash)>) —

    LinkDeliveryGetResponse data, response status code and response headers



9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
 
# File 'lib/plaid/api/plaid_api.rb', line 9544

def link_delivery_get_with_http_info(link_delivery_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_get ...'
  end
  # verify the required parameter 'link_delivery_get_request' is set
  if @api_client.config.client_side_validation && link_delivery_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'link_delivery_get_request' when calling PlaidApi.link_delivery_get"
  end
  # resource path
  local_var_path = '/link_delivery/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LinkDeliveryGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.link_delivery_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#link_delivery_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#link_oauth_correlation_id_exchange(link_o_auth_correlation_id_exchange_request, opts = {}) ⇒ LinkOAuthCorrelationIdExchangeResponse

Exchange the Link Correlation Id for a Link Token Exchange an OAuth ‘link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for `payment_initiation` products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the `link_token`.

Parameters:

Returns:



9602
9603
9604
9605
 
# File 'lib/plaid/api/plaid_api.rb', line 9602

def link_oauth_correlation_id_exchange(link_o_auth_correlation_id_exchange_request, opts = {})
  data, _status_code, _headers = link_oauth_correlation_id_exchange_with_http_info(link_o_auth_correlation_id_exchange_request, opts)
  data
end

#link_oauth_correlation_id_exchange_with_http_info(link_o_auth_correlation_id_exchange_request, opts = {}) ⇒ Array<(LinkOAuthCorrelationIdExchangeResponse, Integer, Hash)>

Exchange the Link Correlation Id for a Link Token Exchange an OAuth &#x60;link_correlation_id&#x60; for the corresponding &#x60;link_token&#x60;. The &#x60;link_correlation_id&#x60; is only available for &#x60;payment_initiation&#x60; products and is provided to the client via the OAuth &#x60;redirect_uri&#x60; as a query parameter. The &#x60;link_correlation_id&#x60; is ephemeral and expires in a brief period, after which it can no longer be exchanged for the &#x60;link_token&#x60;.

Parameters:

Returns:



9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
 
# File 'lib/plaid/api/plaid_api.rb', line 9612

def link_oauth_correlation_id_exchange_with_http_info(link_o_auth_correlation_id_exchange_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.link_oauth_correlation_id_exchange ...'
  end
  # verify the required parameter 'link_o_auth_correlation_id_exchange_request' is set
  if @api_client.config.client_side_validation && link_o_auth_correlation_id_exchange_request.nil?
    fail ArgumentError, "Missing the required parameter 'link_o_auth_correlation_id_exchange_request' when calling PlaidApi.link_oauth_correlation_id_exchange"
  end
  # resource path
  local_var_path = '/link/oauth/correlation_id/exchange'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(link_o_auth_correlation_id_exchange_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LinkOAuthCorrelationIdExchangeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.link_oauth_correlation_id_exchange",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#link_oauth_correlation_id_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#link_token_create(link_token_create_request, opts = {}) ⇒ LinkTokenCreateResponse

Create Link Token The ‘/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`. 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.

Parameters:

  • link_token_create_request (LinkTokenCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9670
9671
9672
9673
 
# File 'lib/plaid/api/plaid_api.rb', line 9670

def link_token_create(link_token_create_request, opts = {})
  data, _status_code, _headers = link_token_create_with_http_info(link_token_create_request, opts)
  data
end

#link_token_create_with_http_info(link_token_create_request, opts = {}) ⇒ Array<(LinkTokenCreateResponse, Integer, Hash)>

Create Link Token The &#x60;/link/token/create&#x60; endpoint creates a &#x60;link_token&#x60;, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a &#x60;public_token&#x60;. For most Plaid products, the &#x60;public_token&#x60; is saved and exchanged for an &#x60;access_token&#x60; via &#x60;/item/public_token/exchange&#x60; as part of the main Link flow. For more details, see the [Link flow overview](plaid.com/docs/link/#link-flow-overview). A &#x60;link_token&#x60; generated by &#x60;/link/token/create&#x60; 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.

Parameters:

  • link_token_create_request (LinkTokenCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LinkTokenCreateResponse, Integer, Hash)>) —

    LinkTokenCreateResponse data, response status code and response headers



9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
 
# File 'lib/plaid/api/plaid_api.rb', line 9680

def link_token_create_with_http_info(link_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_create ...'
  end
  # verify the required parameter 'link_token_create_request' is set
  if @api_client.config.client_side_validation && link_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'link_token_create_request' when calling PlaidApi.link_token_create"
  end
  # resource path
  local_var_path = '/link/token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LinkTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.link_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#link_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#link_token_get(link_token_get_request, opts = {}) ⇒ LinkTokenGetResponse

Get Link Token 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.

Parameters:

  • link_token_get_request (LinkTokenGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9738
9739
9740
9741
 
# File 'lib/plaid/api/plaid_api.rb', line 9738

def link_token_get(link_token_get_request, opts = {})
  data, _status_code, _headers = link_token_get_with_http_info(link_token_get_request, opts)
  data
end

#link_token_get_with_http_info(link_token_get_request, opts = {}) ⇒ Array<(LinkTokenGetResponse, Integer, Hash)>

Get Link Token The &#x60;/link/token/get&#x60; 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&#39;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 &#x60;/link/token/get&#x60; 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 &#x60;SESSION_FINISHED&#x60; and &#x60;EVENTS&#x60; webhook.

Parameters:

  • link_token_get_request (LinkTokenGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LinkTokenGetResponse, Integer, Hash)>) —

    LinkTokenGetResponse data, response status code and response headers



9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
 
# File 'lib/plaid/api/plaid_api.rb', line 9748

def link_token_get_with_http_info(link_token_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_get ...'
  end
  # verify the required parameter 'link_token_get_request' is set
  if @api_client.config.client_side_validation && link_token_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'link_token_get_request' when calling PlaidApi.link_token_get"
  end
  # resource path
  local_var_path = '/link/token/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LinkTokenGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.link_token_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#link_token_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#network_insights_report_get(network_insights_report_get_request, opts = {}) ⇒ NetworkInsightsReportGetResponse

Retrieve network insights for the provided ‘access_tokens` This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.

Parameters:

Returns:



9806
9807
9808
9809
 
# File 'lib/plaid/api/plaid_api.rb', line 9806

def network_insights_report_get(network_insights_report_get_request, opts = {})
  data, _status_code, _headers = network_insights_report_get_with_http_info(network_insights_report_get_request, opts)
  data
end

#network_insights_report_get_with_http_info(network_insights_report_get_request, opts = {}) ⇒ Array<(NetworkInsightsReportGetResponse, Integer, Hash)>

Retrieve network insights for the provided &#x60;access_tokens&#x60; This endpoint allows you to retrieve the Network Insights from a list of &#x60;access_tokens&#x60;.

Parameters:

Returns:



9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
 
# File 'lib/plaid/api/plaid_api.rb', line 9816

def network_insights_report_get_with_http_info(network_insights_report_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.network_insights_report_get ...'
  end
  # verify the required parameter 'network_insights_report_get_request' is set
  if @api_client.config.client_side_validation && network_insights_report_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'network_insights_report_get_request' when calling PlaidApi.network_insights_report_get"
  end
  # resource path
  local_var_path = '/network_insights/report/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(network_insights_report_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'NetworkInsightsReportGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.network_insights_report_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#network_insights_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#network_status_get(network_status_get_request, opts = {}) ⇒ NetworkStatusGetResponse

Check a user’s Plaid Network status 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).

Parameters:

Returns:



9874
9875
9876
9877
 
# File 'lib/plaid/api/plaid_api.rb', line 9874

def network_status_get(network_status_get_request, opts = {})
  data, _status_code, _headers = network_status_get_with_http_info(network_status_get_request, opts)
  data
end

#network_status_get_with_http_info(network_status_get_request, opts = {}) ⇒ Array<(NetworkStatusGetResponse, Integer, Hash)>

Check a user&#39;s Plaid Network status The &#x60;/network/status/get&#x60; 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. &#x60;/network/status/get&#x60; 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).

Parameters:

Returns:

  • (Array<(NetworkStatusGetResponse, Integer, Hash)>) —

    NetworkStatusGetResponse data, response status code and response headers



9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
 
# File 'lib/plaid/api/plaid_api.rb', line 9884

def network_status_get_with_http_info(network_status_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.network_status_get ...'
  end
  # verify the required parameter 'network_status_get_request' is set
  if @api_client.config.client_side_validation && network_status_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'network_status_get_request' when calling PlaidApi.network_status_get"
  end
  # resource path
  local_var_path = '/network/status/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(network_status_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'NetworkStatusGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.network_status_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#oauth_introspect(o_auth_introspect_request, opts = {}) ⇒ OAuthIntrospectResponse

Get metadata about an OAuth token ‘/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.

Parameters:

  • o_auth_introspect_request (OAuthIntrospectRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9942
9943
9944
9945
 
# File 'lib/plaid/api/plaid_api.rb', line 9942

def oauth_introspect(o_auth_introspect_request, opts = {})
  data, _status_code, _headers = oauth_introspect_with_http_info(o_auth_introspect_request, opts)
  data
end

#oauth_introspect_with_http_info(o_auth_introspect_request, opts = {}) ⇒ Array<(OAuthIntrospectResponse, Integer, Hash)>

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

Parameters:

  • o_auth_introspect_request (OAuthIntrospectRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OAuthIntrospectResponse, Integer, Hash)>) —

    OAuthIntrospectResponse data, response status code and response headers



9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
 
# File 'lib/plaid/api/plaid_api.rb', line 9952

def oauth_introspect_with_http_info(o_auth_introspect_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_introspect ...'
  end
  # verify the required parameter 'o_auth_introspect_request' is set
  if @api_client.config.client_side_validation && o_auth_introspect_request.nil?
    fail ArgumentError, "Missing the required parameter 'o_auth_introspect_request' when calling PlaidApi.oauth_introspect"
  end
  # resource path
  local_var_path = '/oauth/introspect'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_introspect_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthIntrospectResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.oauth_introspect",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#oauth_introspect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#oauth_revoke(o_auth_revoke_request, opts = {}) ⇒ OAuthRevokeResponse

Revoke an OAuth token ‘/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.

Parameters:

  • o_auth_revoke_request (OAuthRevokeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10010
10011
10012
10013
 
# File 'lib/plaid/api/plaid_api.rb', line 10010

def oauth_revoke(o_auth_revoke_request, opts = {})
  data, _status_code, _headers = oauth_revoke_with_http_info(o_auth_revoke_request, opts)
  data
end

#oauth_revoke_with_http_info(o_auth_revoke_request, opts = {}) ⇒ Array<(OAuthRevokeResponse, Integer, Hash)>

Revoke an OAuth token &#x60;/oauth/revoke&#x60; 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 &#x60;Content-Type: application/x-www-form-urlencoded&#x60; as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.

Parameters:

  • o_auth_revoke_request (OAuthRevokeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OAuthRevokeResponse, Integer, Hash)>) —

    OAuthRevokeResponse data, response status code and response headers



10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
 
# File 'lib/plaid/api/plaid_api.rb', line 10020

def oauth_revoke_with_http_info(o_auth_revoke_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_revoke ...'
  end
  # verify the required parameter 'o_auth_revoke_request' is set
  if @api_client.config.client_side_validation && o_auth_revoke_request.nil?
    fail ArgumentError, "Missing the required parameter 'o_auth_revoke_request' when calling PlaidApi.oauth_revoke"
  end
  # resource path
  local_var_path = '/oauth/revoke'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_revoke_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthRevokeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.oauth_revoke",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#oauth_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#oauth_token(o_auth_token_request, opts = {}) ⇒ OAuthTokenResponse

Create or refresh an OAuth access token ‘/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.

Parameters:

  • o_auth_token_request (OAuthTokenRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10078
10079
10080
10081
 
# File 'lib/plaid/api/plaid_api.rb', line 10078

def oauth_token(o_auth_token_request, opts = {})
  data, _status_code, _headers = oauth_token_with_http_info(o_auth_token_request, opts)
  data
end

#oauth_token_with_http_info(o_auth_token_request, opts = {}) ⇒ Array<(OAuthTokenResponse, Integer, Hash)>

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

Parameters:

  • o_auth_token_request (OAuthTokenRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OAuthTokenResponse, Integer, Hash)>) —

    OAuthTokenResponse data, response status code and response headers



10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
 
# File 'lib/plaid/api/plaid_api.rb', line 10088

def oauth_token_with_http_info(o_auth_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_token ...'
  end
  # verify the required parameter 'o_auth_token_request' is set
  if @api_client.config.client_side_validation && o_auth_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'o_auth_token_request' when calling PlaidApi.oauth_token"
  end
  # resource path
  local_var_path = '/oauth/token'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_token_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthTokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.oauth_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#oauth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#partner_customer_create(partner_customer_create_request, opts = {}) ⇒ PartnerCustomerCreateResponse

Creates a new end customer for a Plaid reseller. 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.

Parameters:

Returns:



10146
10147
10148
10149
 
# File 'lib/plaid/api/plaid_api.rb', line 10146

def partner_customer_create(partner_customer_create_request, opts = {})
  data, _status_code, _headers = partner_customer_create_with_http_info(partner_customer_create_request, opts)
  data
end

#partner_customer_create_with_http_info(partner_customer_create_request, opts = {}) ⇒ Array<(PartnerCustomerCreateResponse, Integer, Hash)>

Creates a new end customer for a Plaid reseller. The &#x60;/partner/customer/create&#x60; 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.

Parameters:

Returns:



10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
 
# File 'lib/plaid/api/plaid_api.rb', line 10156

def partner_customer_create_with_http_info(partner_customer_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_create ...'
  end
  # verify the required parameter 'partner_customer_create_request' is set
  if @api_client.config.client_side_validation && partner_customer_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'partner_customer_create_request' when calling PlaidApi.partner_customer_create"
  end
  # resource path
  local_var_path = '/partner/customer/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PartnerCustomerCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.partner_customer_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#partner_customer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#partner_customer_enable(partner_customer_enable_request, opts = {}) ⇒ PartnerCustomerEnableResponse

Enables a Plaid reseller’s end customer in the Production environment. The ‘/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.

Parameters:

Returns:



10214
10215
10216
10217
 
# File 'lib/plaid/api/plaid_api.rb', line 10214

def partner_customer_enable(partner_customer_enable_request, opts = {})
  data, _status_code, _headers = partner_customer_enable_with_http_info(partner_customer_enable_request, opts)
  data
end

#partner_customer_enable_with_http_info(partner_customer_enable_request, opts = {}) ⇒ Array<(PartnerCustomerEnableResponse, Integer, Hash)>

Enables a Plaid reseller&#39;s end customer in the Production environment. The &#x60;/partner/customer/enable&#x60; endpoint is used by reseller partners to enable an end customer in the full Production environment.

Parameters:

Returns:



10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
 
# File 'lib/plaid/api/plaid_api.rb', line 10224

def partner_customer_enable_with_http_info(partner_customer_enable_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_enable ...'
  end
  # verify the required parameter 'partner_customer_enable_request' is set
  if @api_client.config.client_side_validation && partner_customer_enable_request.nil?
    fail ArgumentError, "Missing the required parameter 'partner_customer_enable_request' when calling PlaidApi.partner_customer_enable"
  end
  # resource path
  local_var_path = '/partner/customer/enable'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_enable_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PartnerCustomerEnableResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.partner_customer_enable",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#partner_customer_enable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#partner_customer_get(partner_customer_get_request, opts = {}) ⇒ PartnerCustomerGetResponse

Returns a Plaid reseller’s end customer. The ‘/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer.

Parameters:

Returns:



10282
10283
10284
10285
 
# File 'lib/plaid/api/plaid_api.rb', line 10282

def partner_customer_get(partner_customer_get_request, opts = {})
  data, _status_code, _headers = partner_customer_get_with_http_info(partner_customer_get_request, opts)
  data
end

#partner_customer_get_with_http_info(partner_customer_get_request, opts = {}) ⇒ Array<(PartnerCustomerGetResponse, Integer, Hash)>

Returns a Plaid reseller&#39;s end customer. The &#x60;/partner/customer/get&#x60; endpoint is used by reseller partners to retrieve data about a single end customer.

Parameters:

Returns:

  • (Array<(PartnerCustomerGetResponse, Integer, Hash)>) —

    PartnerCustomerGetResponse data, response status code and response headers



10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
 
# File 'lib/plaid/api/plaid_api.rb', line 10292

def partner_customer_get_with_http_info(partner_customer_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_get ...'
  end
  # verify the required parameter 'partner_customer_get_request' is set
  if @api_client.config.client_side_validation && partner_customer_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'partner_customer_get_request' when calling PlaidApi.partner_customer_get"
  end
  # resource path
  local_var_path = '/partner/customer/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PartnerCustomerGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.partner_customer_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#partner_customer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#partner_customer_oauth_institutions_get(partner_customer_o_auth_institutions_get_request, opts = {}) ⇒ PartnerCustomerOAuthInstitutionsGetResponse

Returns OAuth-institution registration information for a given end customer. The ‘/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the [reseller documentation](plaid.com/docs/account/resellers/#enabling-end-customers).

Parameters:

Returns:



10350
10351
10352
10353
 
# File 'lib/plaid/api/plaid_api.rb', line 10350

def partner_customer_oauth_institutions_get(partner_customer_o_auth_institutions_get_request, opts = {})
  data, _status_code, _headers = partner_customer_oauth_institutions_get_with_http_info(partner_customer_o_auth_institutions_get_request, opts)
  data
end

#partner_customer_oauth_institutions_get_with_http_info(partner_customer_o_auth_institutions_get_request, opts = {}) ⇒ Array<(PartnerCustomerOAuthInstitutionsGetResponse, Integer, Hash)>

Returns OAuth-institution registration information for a given end customer. The &#x60;/partner/customer/oauth_institutions/get&#x60; 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-customers).

Parameters:

Returns:



10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
 
# File 'lib/plaid/api/plaid_api.rb', line 10360

def partner_customer_oauth_institutions_get_with_http_info(partner_customer_o_auth_institutions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_oauth_institutions_get ...'
  end
  # verify the required parameter 'partner_customer_o_auth_institutions_get_request' is set
  if @api_client.config.client_side_validation && partner_customer_o_auth_institutions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'partner_customer_o_auth_institutions_get_request' when calling PlaidApi.partner_customer_oauth_institutions_get"
  end
  # resource path
  local_var_path = '/partner/customer/oauth_institutions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_o_auth_institutions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PartnerCustomerOAuthInstitutionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.partner_customer_oauth_institutions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#partner_customer_oauth_institutions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#partner_customer_remove(partner_customer_remove_request, opts = {}) ⇒ PartnerCustomerRemoveResponse

Removes a Plaid reseller’s end customer. The ‘/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in full Production.

Parameters:

Returns:



10418
10419
10420
10421
 
# File 'lib/plaid/api/plaid_api.rb', line 10418

def partner_customer_remove(partner_customer_remove_request, opts = {})
  data, _status_code, _headers = partner_customer_remove_with_http_info(partner_customer_remove_request, opts)
  data
end

#partner_customer_remove_with_http_info(partner_customer_remove_request, opts = {}) ⇒ Array<(PartnerCustomerRemoveResponse, Integer, Hash)>

Removes a Plaid reseller&#39;s end customer. The &#x60;/partner/customer/remove&#x60; 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.

Parameters:

Returns:



10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
 
# File 'lib/plaid/api/plaid_api.rb', line 10428

def partner_customer_remove_with_http_info(partner_customer_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_remove ...'
  end
  # verify the required parameter 'partner_customer_remove_request' is set
  if @api_client.config.client_side_validation && partner_customer_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'partner_customer_remove_request' when calling PlaidApi.partner_customer_remove"
  end
  # resource path
  local_var_path = '/partner/customer/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PartnerCustomerRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.partner_customer_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#partner_customer_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_consent_create(payment_initiation_consent_create_request, opts = {}) ⇒ PaymentInitiationConsentCreateResponse

Create payment consent The ‘/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with `UNAUTHORISED` status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments.

Parameters:

Returns:



10486
10487
10488
10489
 
# File 'lib/plaid/api/plaid_api.rb', line 10486

def payment_initiation_consent_create(payment_initiation_consent_create_request, opts = {})
  data, _status_code, _headers = payment_initiation_consent_create_with_http_info(payment_initiation_consent_create_request, opts)
  data
end

#payment_initiation_consent_create_with_http_info(payment_initiation_consent_create_request, opts = {}) ⇒ Array<(PaymentInitiationConsentCreateResponse, Integer, Hash)>

Create payment consent The &#x60;/payment_initiation/consent/create&#x60; 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 &#x60;UNAUTHORISED&#x60; 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.

Parameters:

Returns:



10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
 
# File 'lib/plaid/api/plaid_api.rb', line 10496

def payment_initiation_consent_create_with_http_info(payment_initiation_consent_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_create ...'
  end
  # verify the required parameter 'payment_initiation_consent_create_request' is set
  if @api_client.config.client_side_validation && payment_initiation_consent_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_create_request' when calling PlaidApi.payment_initiation_consent_create"
  end
  # resource path
  local_var_path = '/payment_initiation/consent/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationConsentCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_consent_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_consent_get(payment_initiation_consent_get_request, opts = {}) ⇒ PaymentInitiationConsentGetResponse

Get payment consent The ‘/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.

Parameters:

Returns:



10554
10555
10556
10557
 
# File 'lib/plaid/api/plaid_api.rb', line 10554

def payment_initiation_consent_get(payment_initiation_consent_get_request, opts = {})
  data, _status_code, _headers = payment_initiation_consent_get_with_http_info(payment_initiation_consent_get_request, opts)
  data
end

#payment_initiation_consent_get_with_http_info(payment_initiation_consent_get_request, opts = {}) ⇒ Array<(PaymentInitiationConsentGetResponse, Integer, Hash)>

Get payment consent The &#x60;/payment_initiation/consent/get&#x60; endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.

Parameters:

Returns:



10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
 
# File 'lib/plaid/api/plaid_api.rb', line 10564

def payment_initiation_consent_get_with_http_info(payment_initiation_consent_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_get ...'
  end
  # verify the required parameter 'payment_initiation_consent_get_request' is set
  if @api_client.config.client_side_validation && payment_initiation_consent_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_get_request' when calling PlaidApi.payment_initiation_consent_get"
  end
  # resource path
  local_var_path = '/payment_initiation/consent/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationConsentGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_consent_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_consent_payment_execute(payment_initiation_consent_payment_execute_request, opts = {}) ⇒ PaymentInitiationConsentPaymentExecuteResponse

Execute a single payment using consent The ‘/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent.

Parameters:

Returns:



10622
10623
10624
10625
 
# File 'lib/plaid/api/plaid_api.rb', line 10622

def payment_initiation_consent_payment_execute(payment_initiation_consent_payment_execute_request, opts = {})
  data, _status_code, _headers = payment_initiation_consent_payment_execute_with_http_info(payment_initiation_consent_payment_execute_request, opts)
  data
end

#payment_initiation_consent_payment_execute_with_http_info(payment_initiation_consent_payment_execute_request, opts = {}) ⇒ Array<(PaymentInitiationConsentPaymentExecuteResponse, Integer, Hash)>

Execute a single payment using consent The &#x60;/payment_initiation/consent/payment/execute&#x60; endpoint can be used to execute payments using payment consent.

Parameters:

Returns:



10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
 
# File 'lib/plaid/api/plaid_api.rb', line 10632

def payment_initiation_consent_payment_execute_with_http_info(payment_initiation_consent_payment_execute_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_payment_execute ...'
  end
  # verify the required parameter 'payment_initiation_consent_payment_execute_request' is set
  if @api_client.config.client_side_validation && payment_initiation_consent_payment_execute_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_payment_execute_request' when calling PlaidApi.payment_initiation_consent_payment_execute"
  end
  # resource path
  local_var_path = '/payment_initiation/consent/payment/execute'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_payment_execute_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationConsentPaymentExecuteResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_consent_payment_execute",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_payment_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_consent_revoke(payment_initiation_consent_revoke_request, opts = {}) ⇒ PaymentInitiationConsentRevokeResponse

Revoke payment consent The ‘/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.

Parameters:

Returns:



10690
10691
10692
10693
 
# File 'lib/plaid/api/plaid_api.rb', line 10690

def payment_initiation_consent_revoke(payment_initiation_consent_revoke_request, opts = {})
  data, _status_code, _headers = payment_initiation_consent_revoke_with_http_info(payment_initiation_consent_revoke_request, opts)
  data
end

#payment_initiation_consent_revoke_with_http_info(payment_initiation_consent_revoke_request, opts = {}) ⇒ Array<(PaymentInitiationConsentRevokeResponse, Integer, Hash)>

Revoke payment consent The &#x60;/payment_initiation/consent/revoke&#x60; endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.

Parameters:

Returns:



10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
 
# File 'lib/plaid/api/plaid_api.rb', line 10700

def payment_initiation_consent_revoke_with_http_info(payment_initiation_consent_revoke_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_revoke ...'
  end
  # verify the required parameter 'payment_initiation_consent_revoke_request' is set
  if @api_client.config.client_side_validation && payment_initiation_consent_revoke_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_revoke_request' when calling PlaidApi.payment_initiation_consent_revoke"
  end
  # resource path
  local_var_path = '/payment_initiation/consent/revoke'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_revoke_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationConsentRevokeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_consent_revoke",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_payment_create(payment_initiation_payment_create_request, opts = {}) ⇒ PaymentInitiationPaymentCreateResponse

Create a payment After creating a payment recipient, you can use the ‘/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](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.

Parameters:

Returns:



10758
10759
10760
10761
 
# File 'lib/plaid/api/plaid_api.rb', line 10758

def payment_initiation_payment_create(payment_initiation_payment_create_request, opts = {})
  data, _status_code, _headers = payment_initiation_payment_create_with_http_info(payment_initiation_payment_create_request, opts)
  data
end

#payment_initiation_payment_create_with_http_info(payment_initiation_payment_create_request, opts = {}) ⇒ Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>

Create a payment After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; 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.

Parameters:

Returns:



10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
 
# File 'lib/plaid/api/plaid_api.rb', line 10768

def payment_initiation_payment_create_with_http_info(payment_initiation_payment_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_create ...'
  end
  # verify the required parameter 'payment_initiation_payment_create_request' is set
  if @api_client.config.client_side_validation && payment_initiation_payment_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_create_request' when calling PlaidApi.payment_initiation_payment_create"
  end
  # resource path
  local_var_path = '/payment_initiation/payment/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_payment_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_payment_get(payment_initiation_payment_get_request, opts = {}) ⇒ PaymentInitiationPaymentGetResponse

Get payment details The ‘/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. 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.

Parameters:

Returns:



10826
10827
10828
10829
 
# File 'lib/plaid/api/plaid_api.rb', line 10826

def payment_initiation_payment_get(payment_initiation_payment_get_request, opts = {})
  data, _status_code, _headers = payment_initiation_payment_get_with_http_info(payment_initiation_payment_get_request, opts)
  data
end

#payment_initiation_payment_get_with_http_info(payment_initiation_payment_get_request, opts = {}) ⇒ Array<(PaymentInitiationPaymentGetResponse, Integer, Hash)>

Get payment details The &#x60;/payment_initiation/payment/get&#x60; 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 &#x60;/payment_initiation/payment/get&#x60; 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 &#x60;/payment_initiation/payment/get&#x60; to check a payment&#39;s status is unreliable and may trigger API rate limits. Only the &#x60;payment_status_update&#x60; webhook should be used to receive real-time status updates in Production. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; 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.

Parameters:

Returns:



10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
 
# File 'lib/plaid/api/plaid_api.rb', line 10836

def payment_initiation_payment_get_with_http_info(payment_initiation_payment_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_get ...'
  end
  # verify the required parameter 'payment_initiation_payment_get_request' is set
  if @api_client.config.client_side_validation && payment_initiation_payment_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_get_request' when calling PlaidApi.payment_initiation_payment_get"
  end
  # resource path
  local_var_path = '/payment_initiation/payment/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_payment_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_payment_list(payment_initiation_payment_list_request, opts = {}) ⇒ PaymentInitiationPaymentListResponse

List payments The ‘/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters.

Parameters:

Returns:



10894
10895
10896
10897
 
# File 'lib/plaid/api/plaid_api.rb', line 10894

def payment_initiation_payment_list(payment_initiation_payment_list_request, opts = {})
  data, _status_code, _headers = payment_initiation_payment_list_with_http_info(payment_initiation_payment_list_request, opts)
  data
end

#payment_initiation_payment_list_with_http_info(payment_initiation_payment_list_request, opts = {}) ⇒ Array<(PaymentInitiationPaymentListResponse, Integer, Hash)>

List payments The &#x60;/payment_initiation/payment/list&#x60; 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 &#x60;count&#x60; and &#x60;cursor&#x60; parameters.

Parameters:

Returns:



10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
 
# File 'lib/plaid/api/plaid_api.rb', line 10904

def payment_initiation_payment_list_with_http_info(payment_initiation_payment_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_list ...'
  end
  # verify the required parameter 'payment_initiation_payment_list_request' is set
  if @api_client.config.client_side_validation && payment_initiation_payment_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_list_request' when calling PlaidApi.payment_initiation_payment_list"
  end
  # resource path
  local_var_path = '/payment_initiation/payment/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_payment_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_payment_reverse(payment_initiation_payment_reverse_request, opts = {}) ⇒ PaymentInitiationPaymentReverseResponse

Reverse an existing payment Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. Providing counterparty information such as date of birth and address increases the likelihood of refund being successful without human intervention.

Parameters:

Returns:



10962
10963
10964
10965
 
# File 'lib/plaid/api/plaid_api.rb', line 10962

def payment_initiation_payment_reverse(payment_initiation_payment_reverse_request, opts = {})
  data, _status_code, _headers = payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts)
  data
end

#payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts = {}) ⇒ Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>

Reverse an existing payment Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. Providing counterparty information such as date of birth and address increases the likelihood of refund being successful without human intervention.

Parameters:

Returns:



10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
 
# File 'lib/plaid/api/plaid_api.rb', line 10972

def payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_reverse ...'
  end
  # verify the required parameter 'payment_initiation_payment_reverse_request' is set
  if @api_client.config.client_side_validation && payment_initiation_payment_reverse_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_reverse_request' when calling PlaidApi.payment_initiation_payment_reverse"
  end
  # resource path
  local_var_path = '/payment_initiation/payment/reverse'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_reverse_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentReverseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_payment_reverse",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_reverse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_recipient_create(payment_initiation_recipient_create_request, opts = {}) ⇒ PaymentInitiationRecipientCreateResponse

Create payment recipient Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](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`.

Parameters:

Returns:



11030
11031
11032
11033
 
# File 'lib/plaid/api/plaid_api.rb', line 11030

def payment_initiation_recipient_create(payment_initiation_recipient_create_request, opts = {})
  data, _status_code, _headers = payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts)
  data
end

#payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts = {}) ⇒ Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>

Create payment recipient Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.

Parameters:

Returns:



11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
 
# File 'lib/plaid/api/plaid_api.rb', line 11040

def payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_create ...'
  end
  # verify the required parameter 'payment_initiation_recipient_create_request' is set
  if @api_client.config.client_side_validation && payment_initiation_recipient_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_create_request' when calling PlaidApi.payment_initiation_recipient_create"
  end
  # resource path
  local_var_path = '/payment_initiation/recipient/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_recipient_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_recipient_get(payment_initiation_recipient_get_request, opts = {}) ⇒ PaymentInitiationRecipientGetResponse

Get payment recipient Get details about a payment recipient you have previously created.

Parameters:

Returns:



11098
11099
11100
11101
 
# File 'lib/plaid/api/plaid_api.rb', line 11098

def payment_initiation_recipient_get(payment_initiation_recipient_get_request, opts = {})
  data, _status_code, _headers = payment_initiation_recipient_get_with_http_info(payment_initiation_recipient_get_request, opts)
  data
end

#payment_initiation_recipient_get_with_http_info(payment_initiation_recipient_get_request, opts = {}) ⇒ Array<(PaymentInitiationRecipientGetResponse, Integer, Hash)>

Get payment recipient Get details about a payment recipient you have previously created.

Parameters:

Returns:



11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
 
# File 'lib/plaid/api/plaid_api.rb', line 11108

def payment_initiation_recipient_get_with_http_info(payment_initiation_recipient_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_get ...'
  end
  # verify the required parameter 'payment_initiation_recipient_get_request' is set
  if @api_client.config.client_side_validation && payment_initiation_recipient_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_get_request' when calling PlaidApi.payment_initiation_recipient_get"
  end
  # resource path
  local_var_path = '/payment_initiation/recipient/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_recipient_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_initiation_recipient_list(payment_initiation_recipient_list_request, opts = {}) ⇒ PaymentInitiationRecipientListResponse

List payment recipients The ‘/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.

Parameters:

Returns:



11166
11167
11168
11169
 
# File 'lib/plaid/api/plaid_api.rb', line 11166

def payment_initiation_recipient_list(payment_initiation_recipient_list_request, opts = {})
  data, _status_code, _headers = payment_initiation_recipient_list_with_http_info(payment_initiation_recipient_list_request, opts)
  data
end

#payment_initiation_recipient_list_with_http_info(payment_initiation_recipient_list_request, opts = {}) ⇒ Array<(PaymentInitiationRecipientListResponse, Integer, Hash)>

List payment recipients The &#x60;/payment_initiation/recipient/list&#x60; endpoint list the payment recipients that you have previously created.

Parameters:

Returns:



11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
 
# File 'lib/plaid/api/plaid_api.rb', line 11176

def payment_initiation_recipient_list_with_http_info(payment_initiation_recipient_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_list ...'
  end
  # verify the required parameter 'payment_initiation_recipient_list_request' is set
  if @api_client.config.client_side_validation && payment_initiation_recipient_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_list_request' when calling PlaidApi.payment_initiation_recipient_list"
  end
  # resource path
  local_var_path = '/payment_initiation/recipient/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_initiation_recipient_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_profile_create(payment_profile_create_request, opts = {}) ⇒ PaymentProfileCreateResponse

Create payment profile Use ‘/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field. You can then use the `payment_profile_token` when creating transfers using `/transfer/authorization/create` and `/transfer/create`.

Parameters:

Returns:



11234
11235
11236
11237
 
# File 'lib/plaid/api/plaid_api.rb', line 11234

def payment_profile_create(payment_profile_create_request, opts = {})
  data, _status_code, _headers = payment_profile_create_with_http_info(payment_profile_create_request, opts)
  data
end

#payment_profile_create_with_http_info(payment_profile_create_request, opts = {}) ⇒ Array<(PaymentProfileCreateResponse, Integer, Hash)>

Create payment profile Use &#x60;/payment_profile/create&#x60; endpoint to create a new payment profile. To initiate the account linking experience, call &#x60;/link/token/create&#x60; and provide the &#x60;payment_profile_token&#x60; in the &#x60;transfer.payment_profile_token&#x60; field. You can then use the &#x60;payment_profile_token&#x60; when creating transfers using &#x60;/transfer/authorization/create&#x60; and &#x60;/transfer/create&#x60;.

Parameters:

Returns:



11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
 
# File 'lib/plaid/api/plaid_api.rb', line 11244

def payment_profile_create_with_http_info(payment_profile_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_profile_create ...'
  end
  # verify the required parameter 'payment_profile_create_request' is set
  if @api_client.config.client_side_validation && payment_profile_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_profile_create_request' when calling PlaidApi.payment_profile_create"
  end
  # resource path
  local_var_path = '/payment_profile/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_profile_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentProfileCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_profile_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_profile_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_profile_get(payment_profile_get_request, opts = {}) ⇒ PaymentProfileGetResponse

Get payment profile Use ‘/payment_profile/get` endpoint to get the status of a given Payment Profile.

Parameters:

Returns:



11302
11303
11304
11305
 
# File 'lib/plaid/api/plaid_api.rb', line 11302

def payment_profile_get(payment_profile_get_request, opts = {})
  data, _status_code, _headers = payment_profile_get_with_http_info(payment_profile_get_request, opts)
  data
end

#payment_profile_get_with_http_info(payment_profile_get_request, opts = {}) ⇒ Array<(PaymentProfileGetResponse, Integer, Hash)>

Get payment profile Use &#x60;/payment_profile/get&#x60; endpoint to get the status of a given Payment Profile.

Parameters:

Returns:

  • (Array<(PaymentProfileGetResponse, Integer, Hash)>) —

    PaymentProfileGetResponse data, response status code and response headers



11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
 
# File 'lib/plaid/api/plaid_api.rb', line 11312

def payment_profile_get_with_http_info(payment_profile_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_profile_get ...'
  end
  # verify the required parameter 'payment_profile_get_request' is set
  if @api_client.config.client_side_validation && payment_profile_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_profile_get_request' when calling PlaidApi.payment_profile_get"
  end
  # resource path
  local_var_path = '/payment_profile/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_profile_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentProfileGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_profile_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_profile_remove(payment_profile_remove_request, opts = {}) ⇒ PaymentProfileRemoveResponse

Remove payment profile Use the ‘/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.

Parameters:

Returns:



11370
11371
11372
11373
 
# File 'lib/plaid/api/plaid_api.rb', line 11370

def payment_profile_remove(payment_profile_remove_request, opts = {})
  data, _status_code, _headers = payment_profile_remove_with_http_info(payment_profile_remove_request, opts)
  data
end

#payment_profile_remove_with_http_info(payment_profile_remove_request, opts = {}) ⇒ Array<(PaymentProfileRemoveResponse, Integer, Hash)>

Remove payment profile Use the &#x60;/payment_profile/remove&#x60; endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.

Parameters:

Returns:



11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
 
# File 'lib/plaid/api/plaid_api.rb', line 11380

def payment_profile_remove_with_http_info(payment_profile_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.payment_profile_remove ...'
  end
  # verify the required parameter 'payment_profile_remove_request' is set
  if @api_client.config.client_side_validation && payment_profile_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_profile_remove_request' when calling PlaidApi.payment_profile_remove"
  end
  # resource path
  local_var_path = '/payment_profile/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_profile_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentProfileRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.payment_profile_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#payment_profile_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_account_get(processor_account_get_request, opts = {}) ⇒ ProcessorAccountGetResponse

Retrieve the account associated with a processor token This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use ‘/processor/balance/get` instead. Note that some information is nullable.

Parameters:

Returns:



11438
11439
11440
11441
 
# File 'lib/plaid/api/plaid_api.rb', line 11438

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#processor_account_get_with_http_info(processor_account_get_request, opts = {}) ⇒ Array<(ProcessorAccountGetResponse, Integer, Hash)>

Retrieve the account associated with a processor token This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use &#x60;/processor/balance/get&#x60; instead. Note that some information is nullable.

Parameters:

Returns:

  • (Array<(ProcessorAccountGetResponse, Integer, Hash)>) —

    ProcessorAccountGetResponse data, response status code and response headers



11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
 
# File 'lib/plaid/api/plaid_api.rb', line 11448

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_account_get ...'
  end
  # verify the required parameter 'processor_account_get_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'processor_account_get_request' when calling PlaidApi.processor_account_get"
  end
  # resource path
  local_var_path = '/processor/account/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorAccountGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_account_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_apex_processor_token_create(processor_apex_processor_token_create_request, opts = {}) ⇒ ProcessorTokenCreateResponse

Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.

Parameters:

Returns:



11506
11507
11508
11509
 
# File 'lib/plaid/api/plaid_api.rb', line 11506

def processor_apex_processor_token_create(processor_apex_processor_token_create_request, opts = {})
  data, _status_code, _headers = processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts)
  data
end

#processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts = {}) ⇒ Array<(ProcessorTokenCreateResponse, Integer, Hash)>

Create Apex bank account token Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.

Parameters:

Returns:



11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
 
# File 'lib/plaid/api/plaid_api.rb', line 11516

def processor_apex_processor_token_create_with_http_info(processor_apex_processor_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_apex_processor_token_create ...'
  end
  # verify the required parameter 'processor_apex_processor_token_create_request' is set
  if @api_client.config.client_side_validation && processor_apex_processor_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_apex_processor_token_create_request' when calling PlaidApi.processor_apex_processor_token_create"
  end
  # resource path
  local_var_path = '/processor/apex/processor_token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_apex_processor_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_apex_processor_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_apex_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_auth_get(processor_auth_get_request, opts = {}) ⇒ ProcessorAuthGetResponse

Retrieve Auth data The ‘/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking, 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).

Parameters:

Returns:



11574
11575
11576
11577
 
# File 'lib/plaid/api/plaid_api.rb', line 11574

def processor_auth_get(processor_auth_get_request, opts = {})
  data, _status_code, _headers = processor_auth_get_with_http_info(processor_auth_get_request, opts)
  data
end

#processor_auth_get_with_http_info(processor_auth_get_request, opts = {}) ⇒ Array<(ProcessorAuthGetResponse, Integer, Hash)>

Retrieve Auth data The &#x60;/processor/auth/get&#x60; 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&#39;&#39;s associated with a given &#x60;processor_token&#x60;. 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 &#x60;numbers&#x60; object returned by this endpoint. For details, see [Plaid API versioning](plaid.com/docs/api/versioning/#version-2020-09-14).

Parameters:

Returns:

  • (Array<(ProcessorAuthGetResponse, Integer, Hash)>) —

    ProcessorAuthGetResponse data, response status code and response headers



11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
 
# File 'lib/plaid/api/plaid_api.rb', line 11584

def processor_auth_get_with_http_info(processor_auth_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_auth_get ...'
  end
  # verify the required parameter 'processor_auth_get_request' is set
  if @api_client.config.client_side_validation && processor_auth_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_auth_get_request' when calling PlaidApi.processor_auth_get"
  end
  # resource path
  local_var_path = '/processor/auth/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_auth_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorAuthGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_auth_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_balance_get(processor_balance_get_request, opts = {}) ⇒ ProcessorBalanceGetResponse

Retrieve Balance data The ‘/processor/balance/get` endpoint returns the real-time balance for each of an Item’s accounts. While other endpoints may return a balance object, only ‘/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.

Parameters:

  • processor_balance_get_request (ProcessorBalanceGetRequest) —

    The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with a given &#x60;processor_token&#x60;. 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 &#x60;null&#x60;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11642
11643
11644
11645
 
# File 'lib/plaid/api/plaid_api.rb', line 11642

def processor_balance_get(processor_balance_get_request, opts = {})
  data, _status_code, _headers = processor_balance_get_with_http_info(processor_balance_get_request, opts)
  data
end

#processor_balance_get_with_http_info(processor_balance_get_request, opts = {}) ⇒ Array<(ProcessorBalanceGetResponse, Integer, Hash)>

Retrieve Balance data The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for each of an Item&#39;s accounts. While other endpoints may return a balance object, only &#x60;/processor/balance/get&#x60; forces the available and current balance fields to be refreshed rather than cached.

Parameters:

  • processor_balance_get_request (ProcessorBalanceGetRequest) —

    The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with a given &#x60;processor_token&#x60;. 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 &#x60;null&#x60;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ProcessorBalanceGetResponse, Integer, Hash)>) —

    ProcessorBalanceGetResponse data, response status code and response headers



11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
 
# File 'lib/plaid/api/plaid_api.rb', line 11652

def processor_balance_get_with_http_info(processor_balance_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_balance_get ...'
  end
  # verify the required parameter 'processor_balance_get_request' is set
  if @api_client.config.client_side_validation && processor_balance_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_balance_get_request' when calling PlaidApi.processor_balance_get"
  end
  # resource path
  local_var_path = '/processor/balance/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_balance_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorBalanceGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_balance_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_bank_transfer_create(processor_bank_transfer_create_request, opts = {}) ⇒ ProcessorBankTransferCreateResponse

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

Parameters:

Returns:



11710
11711
11712
11713
 
# File 'lib/plaid/api/plaid_api.rb', line 11710

def processor_bank_transfer_create(processor_bank_transfer_create_request, opts = {})
  data, _status_code, _headers = processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts)
  data
end

#processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts = {}) ⇒ Array<(ProcessorBankTransferCreateResponse, Integer, Hash)>

Create a bank transfer as a processor Use the &#x60;/processor/bank_transfer/create&#x60; endpoint to initiate a new bank transfer as a processor

Parameters:

Returns:



11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
 
# File 'lib/plaid/api/plaid_api.rb', line 11720

def processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_bank_transfer_create ...'
  end
  # verify the required parameter 'processor_bank_transfer_create_request' is set
  if @api_client.config.client_side_validation && processor_bank_transfer_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_bank_transfer_create_request' when calling PlaidApi.processor_bank_transfer_create"
  end
  # resource path
  local_var_path = '/processor/bank_transfer/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_bank_transfer_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorBankTransferCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_bank_transfer_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_bank_transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_identity_get(processor_identity_get_request, opts = {}) ⇒ ProcessorIdentityGetResponse

Retrieve Identity data The ‘/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

Parameters:

Returns:



11778
11779
11780
11781
 
# File 'lib/plaid/api/plaid_api.rb', line 11778

def processor_identity_get(processor_identity_get_request, opts = {})
  data, _status_code, _headers = processor_identity_get_with_http_info(processor_identity_get_request, opts)
  data
end

#processor_identity_get_with_http_info(processor_identity_get_request, opts = {}) ⇒ Array<(ProcessorIdentityGetResponse, Integer, Hash)>

Retrieve Identity data The &#x60;/processor/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

Parameters:

Returns:



11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
 
# File 'lib/plaid/api/plaid_api.rb', line 11788

def processor_identity_get_with_http_info(processor_identity_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_get ...'
  end
  # verify the required parameter 'processor_identity_get_request' is set
  if @api_client.config.client_side_validation && processor_identity_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_identity_get_request' when calling PlaidApi.processor_identity_get"
  end
  # resource path
  local_var_path = '/processor/identity/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorIdentityGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_identity_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_identity_match(processor_identity_match_request, opts = {}) ⇒ ProcessorIdentityMatchResponse

Retrieve identity match score The ‘/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder’s financial institution. Fields within the ‘balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.

Parameters:

Returns:



11846
11847
11848
11849
 
# File 'lib/plaid/api/plaid_api.rb', line 11846

def processor_identity_match(processor_identity_match_request, opts = {})
  data, _status_code, _headers = processor_identity_match_with_http_info(processor_identity_match_request, opts)
  data
end

#processor_identity_match_with_http_info(processor_identity_match_request, opts = {}) ⇒ Array<(ProcessorIdentityMatchResponse, Integer, Hash)>

Retrieve identity match score The &#x60;/processor/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/identity/match&#x60;. Instead, use the free &#x60;/accounts/get&#x60; endpoint to request balance cached data, or &#x60;/accounts/balance/get&#x60; for real-time data.

Parameters:

Returns:



11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
 
# File 'lib/plaid/api/plaid_api.rb', line 11856

def processor_identity_match_with_http_info(processor_identity_match_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_match ...'
  end
  # verify the required parameter 'processor_identity_match_request' is set
  if @api_client.config.client_side_validation && processor_identity_match_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_identity_match_request' when calling PlaidApi.processor_identity_match"
  end
  # resource path
  local_var_path = '/processor/identity/match'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_match_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorIdentityMatchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_identity_match",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_identity_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_investments_auth_get(processor_investments_auth_get_request, opts = {}) ⇒ ProcessorInvestmentsAuthGetResponse

Get investment account authentication data 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-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



11914
11915
11916
11917
 
# File 'lib/plaid/api/plaid_api.rb', line 11914

def processor_investments_auth_get(processor_investments_auth_get_request, opts = {})
  data, _status_code, _headers = processor_investments_auth_get_with_http_info(processor_investments_auth_get_request, opts)
  data
end

#processor_investments_auth_get_with_http_info(processor_investments_auth_get_request, opts = {}) ⇒ Array<(ProcessorInvestmentsAuthGetResponse, Integer, Hash)>

Get investment account authentication data The &#x60;/processor/investments/auth/get&#x60; 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 [&#x60;/processor/token/webhook/update&#x60;](plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
 
# File 'lib/plaid/api/plaid_api.rb', line 11924

def processor_investments_auth_get_with_http_info(processor_investments_auth_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_investments_auth_get ...'
  end
  # verify the required parameter 'processor_investments_auth_get_request' is set
  if @api_client.config.client_side_validation && processor_investments_auth_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_investments_auth_get_request' when calling PlaidApi.processor_investments_auth_get"
  end
  # resource path
  local_var_path = '/processor/investments/auth/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_investments_auth_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorInvestmentsAuthGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_investments_auth_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_investments_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_investments_holdings_get(processor_investments_holdings_get_request, opts = {}) ⇒ ProcessorInvestmentsHoldingsGetResponse

Retrieve Investment Holdings This endpoint returns the stock position data of the account associated with a given processor token.

Parameters:

Returns:



11982
11983
11984
11985
 
# File 'lib/plaid/api/plaid_api.rb', line 11982

def processor_investments_holdings_get(processor_investments_holdings_get_request, opts = {})
  data, _status_code, _headers = processor_investments_holdings_get_with_http_info(processor_investments_holdings_get_request, opts)
  data
end

#processor_investments_holdings_get_with_http_info(processor_investments_holdings_get_request, opts = {}) ⇒ Array<(ProcessorInvestmentsHoldingsGetResponse, Integer, Hash)>

Retrieve Investment Holdings This endpoint returns the stock position data of the account associated with a given processor token.

Parameters:

Returns:



11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
 
# File 'lib/plaid/api/plaid_api.rb', line 11992

def processor_investments_holdings_get_with_http_info(processor_investments_holdings_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_investments_holdings_get ...'
  end
  # verify the required parameter 'processor_investments_holdings_get_request' is set
  if @api_client.config.client_side_validation && processor_investments_holdings_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_investments_holdings_get_request' when calling PlaidApi.processor_investments_holdings_get"
  end
  # resource path
  local_var_path = '/processor/investments/holdings/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_investments_holdings_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorInvestmentsHoldingsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_investments_holdings_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_investments_transactions_get(processor_investments_transactions_get_request, opts = {}) ⇒ ProcessorInvestmentsTransactionsGetResponse

Get investment transactions data 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-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



12050
12051
12052
12053
 
# File 'lib/plaid/api/plaid_api.rb', line 12050

def processor_investments_transactions_get(processor_investments_transactions_get_request, opts = {})
  data, _status_code, _headers = processor_investments_transactions_get_with_http_info(processor_investments_transactions_get_request, opts)
  data
end

#processor_investments_transactions_get_with_http_info(processor_investments_transactions_get_request, opts = {}) ⇒ Array<(ProcessorInvestmentsTransactionsGetResponse, Integer, Hash)>

Get investment transactions data The &#x60;/processor/investments/transactions/get&#x60; 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 &#x60;total_investment_transactions&#x60; 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 &#x60;async_update&#x60; option). Instead, if transactions data is not ready when &#x60;/processor/investments/transactions/get&#x60; is first called, Plaid will wait for the data. For this reason, calling &#x60;/processor/investments/transactions/get&#x60; immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when &#x60;async_update&#x60; is set to true) may not be immediately available to &#x60;/processor/investments/transactions/get&#x60;. To be alerted when the data is ready to be fetched, listen for the &#x60;HISTORICAL_UPDATE&#x60; webhook. If no investments history is ready when &#x60;/processor/investments/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Investments Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
 
# File 'lib/plaid/api/plaid_api.rb', line 12060

def processor_investments_transactions_get_with_http_info(processor_investments_transactions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_investments_transactions_get ...'
  end
  # verify the required parameter 'processor_investments_transactions_get_request' is set
  if @api_client.config.client_side_validation && processor_investments_transactions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_investments_transactions_get_request' when calling PlaidApi.processor_investments_transactions_get"
  end
  # resource path
  local_var_path = '/processor/investments/transactions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_investments_transactions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorInvestmentsTransactionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_investments_transactions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_investments_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_liabilities_get(processor_liabilities_get_request, opts = {}) ⇒ ProcessorLiabilitiesGetResponse

Retrieve Liabilities data 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.

Parameters:

Returns:



12118
12119
12120
12121
 
# File 'lib/plaid/api/plaid_api.rb', line 12118

def processor_liabilities_get(processor_liabilities_get_request, opts = {})
  data, _status_code, _headers = processor_liabilities_get_with_http_info(processor_liabilities_get_request, opts)
  data
end

#processor_liabilities_get_with_http_info(processor_liabilities_get_request, opts = {}) ⇒ Array<(ProcessorLiabilitiesGetResponse, Integer, Hash)>

Retrieve Liabilities data The &#x60;/processor/liabilities/get&#x60; 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 &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. 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 &#x60;/processor/liabilities/get&#x60;. Note: This request may take some time to complete if &#x60;liabilities&#x60; 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.

Parameters:

Returns:



12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
 
# File 'lib/plaid/api/plaid_api.rb', line 12128

def processor_liabilities_get_with_http_info(processor_liabilities_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_liabilities_get ...'
  end
  # verify the required parameter 'processor_liabilities_get_request' is set
  if @api_client.config.client_side_validation && processor_liabilities_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_liabilities_get_request' when calling PlaidApi.processor_liabilities_get"
  end
  # resource path
  local_var_path = '/processor/liabilities/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_liabilities_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorLiabilitiesGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_liabilities_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_signal_decision_report(processor_signal_decision_report_request, opts = {}) ⇒ ProcessorSignalDecisionReportResponse

Report whether you initiated an ACH transaction 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.

Parameters:

Returns:



12186
12187
12188
12189
 
# File 'lib/plaid/api/plaid_api.rb', line 12186

def processor_signal_decision_report(processor_signal_decision_report_request, opts = {})
  data, _status_code, _headers = processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts)
  data
end

#processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts = {}) ⇒ Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>

Report whether you initiated an ACH transaction After you call &#x60;/processor/signal/evaluate&#x60;, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was &#x60;REVIEW&#x60;, or if you take a different action than the one determined by the Signal Rules, you will need to call &#x60;/processor/signal/decision/report&#x60;. 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 &#x60;/processor/signal/decision/report&#x60; (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call &#x60;/processor/signal/decision/report&#x60; again for the transaction to correct Plaid&#39;s records. If you are using Plaid Transfer as your payment processor, you also do not need to call &#x60;/processor/signal/decision/report&#x60;, 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.

Parameters:

Returns:



12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
 
# File 'lib/plaid/api/plaid_api.rb', line 12196

def processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_decision_report ...'
  end
  # verify the required parameter 'processor_signal_decision_report_request' is set
  if @api_client.config.client_side_validation && processor_signal_decision_report_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_signal_decision_report_request' when calling PlaidApi.processor_signal_decision_report"
  end
  # resource path
  local_var_path = '/processor/signal/decision/report'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_decision_report_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorSignalDecisionReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_signal_decision_report",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_signal_evaluate(processor_signal_evaluate_request, opts = {}) ⇒ ProcessorSignalEvaluateResponse

Evaluate a planned ACH transaction 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.

Parameters:

Returns:



12254
12255
12256
12257
 
# File 'lib/plaid/api/plaid_api.rb', line 12254

def processor_signal_evaluate(processor_signal_evaluate_request, opts = {})
  data, _status_code, _headers = processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts)
  data
end

#processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts = {}) ⇒ Array<(ProcessorSignalEvaluateResponse, Integer, Hash)>

Evaluate a planned ACH transaction Use &#x60;/processor/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. &#x60;/processor/signal/evaluate&#x60; uses Rulesets that are configured on the end customer&#39;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 &#x60;ruleset_key&#x60; 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.

Parameters:

Returns:



12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
 
# File 'lib/plaid/api/plaid_api.rb', line 12264

def processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_evaluate ...'
  end
  # verify the required parameter 'processor_signal_evaluate_request' is set
  if @api_client.config.client_side_validation && processor_signal_evaluate_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_signal_evaluate_request' when calling PlaidApi.processor_signal_evaluate"
  end
  # resource path
  local_var_path = '/processor/signal/evaluate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_evaluate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorSignalEvaluateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_signal_evaluate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_signal_prepare(processor_signal_prepare_request, opts = {}) ⇒ ProcessorSignalPrepareResponse

Opt-in a processor token to Signal When a processor token is not initialized with ‘signal`, call `/processor/signal/prepare` to opt-in that processor token to the 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.

Parameters:

Returns:



12322
12323
12324
12325
 
# File 'lib/plaid/api/plaid_api.rb', line 12322

def processor_signal_prepare(processor_signal_prepare_request, opts = {})
  data, _status_code, _headers = processor_signal_prepare_with_http_info(processor_signal_prepare_request, opts)
  data
end

#processor_signal_prepare_with_http_info(processor_signal_prepare_request, opts = {}) ⇒ Array<(ProcessorSignalPrepareResponse, Integer, Hash)>

Opt-in a processor token to Signal When a processor token is not initialized with &#x60;signal&#x60;, call &#x60;/processor/signal/prepare&#x60; 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 &#x60;signal&#x60;, it will return a 200 response and will not modify the processor token.

Parameters:

Returns:



12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
 
# File 'lib/plaid/api/plaid_api.rb', line 12332

def processor_signal_prepare_with_http_info(processor_signal_prepare_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_prepare ...'
  end
  # verify the required parameter 'processor_signal_prepare_request' is set
  if @api_client.config.client_side_validation && processor_signal_prepare_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_signal_prepare_request' when calling PlaidApi.processor_signal_prepare"
  end
  # resource path
  local_var_path = '/processor/signal/prepare'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_prepare_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorSignalPrepareResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_signal_prepare",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_signal_prepare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_signal_return_report(processor_signal_return_report_request, opts = {}) ⇒ ProcessorSignalReturnReportResponse

Report a return for an ACH transaction Call the ‘/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. 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.

Parameters:

Returns:



12390
12391
12392
12393
 
# File 'lib/plaid/api/plaid_api.rb', line 12390

def processor_signal_return_report(processor_signal_return_report_request, opts = {})
  data, _status_code, _headers = processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts)
  data
end

#processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts = {}) ⇒ Array<(ProcessorSignalReturnReportResponse, Integer, Hash)>

Report a return for an ACH transaction Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; 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.

Parameters:

Returns:



12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
 
# File 'lib/plaid/api/plaid_api.rb', line 12400

def processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_return_report ...'
  end
  # verify the required parameter 'processor_signal_return_report_request' is set
  if @api_client.config.client_side_validation && processor_signal_return_report_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_signal_return_report_request' when calling PlaidApi.processor_signal_return_report"
  end
  # resource path
  local_var_path = '/processor/signal/return/report'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_return_report_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorSignalReturnReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_signal_return_report",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_stripe_bank_account_token_create(processor_stripe_bank_account_token_create_request, opts = {}) ⇒ ProcessorStripeBankAccountTokenCreateResponse

Create Stripe bank account token

Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://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`.

Parameters:

Returns:



12458
12459
12460
12461
 
# File 'lib/plaid/api/plaid_api.rb', line 12458

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts = {}) ⇒ Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>

Create Stripe bank account token

Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://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&#39;s bank account information changes or they revoke Plaid&#39;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 &#x60;access_token&#x60;.  To revoke a bank account token, the entire underlying access token must be revoked using &#x60;/item/remove&#x60;.

Parameters:

Returns:



12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
 
# File 'lib/plaid/api/plaid_api.rb', line 12468

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_stripe_bank_account_token_create ...'
  end
  # verify the required parameter 'processor_stripe_bank_account_token_create_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'processor_stripe_bank_account_token_create_request' when calling PlaidApi.processor_stripe_bank_account_token_create"
  end
  # resource path
  local_var_path = '/processor/stripe/bank_account_token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorStripeBankAccountTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_stripe_bank_account_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_stripe_bank_account_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_token_create(processor_token_create_request, opts = {}) ⇒ ProcessorTokenCreateResponse

Create processor token Used to create a token suitable for sending to one of Plaid’s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see ‘/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. 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`.

Parameters:

Returns:



12526
12527
12528
12529
 
# File 'lib/plaid/api/plaid_api.rb', line 12526

def processor_token_create(processor_token_create_request, opts = {})
  data, _status_code, _headers = processor_token_create_with_http_info(processor_token_create_request, opts)
  data
end

#processor_token_create_with_http_info(processor_token_create_request, opts = {}) ⇒ Array<(ProcessorTokenCreateResponse, Integer, Hash)>

Create processor token Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; 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 &#x60;/processor/token/permissions/set&#x60;. To revoke the processor&#39;s access, the entire Item must be deleted by calling &#x60;/item/remove&#x60;.

Parameters:

Returns:



12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
 
# File 'lib/plaid/api/plaid_api.rb', line 12536

def processor_token_create_with_http_info(processor_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_create ...'
  end
  # verify the required parameter 'processor_token_create_request' is set
  if @api_client.config.client_side_validation && processor_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_token_create_request' when calling PlaidApi.processor_token_create"
  end
  # resource path
  local_var_path = '/processor/token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_token_permissions_get(processor_token_permissions_get_request, opts = {}) ⇒ ProcessorTokenPermissionsGetResponse

Get a processor token’s product permissions Used to get a processor token’s product permissions. The ‘products` field will be an empty list if the processor can access all available products.

Parameters:

Returns:



12594
12595
12596
12597
 
# File 'lib/plaid/api/plaid_api.rb', line 12594

def processor_token_permissions_get(processor_token_permissions_get_request, opts = {})
  data, _status_code, _headers = processor_token_permissions_get_with_http_info(processor_token_permissions_get_request, opts)
  data
end

#processor_token_permissions_get_with_http_info(processor_token_permissions_get_request, opts = {}) ⇒ Array<(ProcessorTokenPermissionsGetResponse, Integer, Hash)>

Get a processor token&#39;s product permissions Used to get a processor token&#39;s product permissions. The &#x60;products&#x60; field will be an empty list if the processor can access all available products.

Parameters:

Returns:



12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
 
# File 'lib/plaid/api/plaid_api.rb', line 12604

def processor_token_permissions_get_with_http_info(processor_token_permissions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_permissions_get ...'
  end
  # verify the required parameter 'processor_token_permissions_get_request' is set
  if @api_client.config.client_side_validation && processor_token_permissions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_token_permissions_get_request' when calling PlaidApi.processor_token_permissions_get"
  end
  # resource path
  local_var_path = '/processor/token/permissions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_permissions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTokenPermissionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_token_permissions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_token_permissions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_token_permissions_set(processor_token_permissions_set_request, opts = {}) ⇒ ProcessorTokenPermissionsSetResponse

Control a processor’s access to products Used to control a processor’s access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor’s needs change.

Parameters:

Returns:



12662
12663
12664
12665
 
# File 'lib/plaid/api/plaid_api.rb', line 12662

def processor_token_permissions_set(processor_token_permissions_set_request, opts = {})
  data, _status_code, _headers = processor_token_permissions_set_with_http_info(processor_token_permissions_set_request, opts)
  data
end

#processor_token_permissions_set_with_http_info(processor_token_permissions_set_request, opts = {}) ⇒ Array<(ProcessorTokenPermissionsSetResponse, Integer, Hash)>

Control a processor&#39;s access to products Used to control a processor&#39;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&#39;s needs change.

Parameters:

Returns:



12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
 
# File 'lib/plaid/api/plaid_api.rb', line 12672

def processor_token_permissions_set_with_http_info(processor_token_permissions_set_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_permissions_set ...'
  end
  # verify the required parameter 'processor_token_permissions_set_request' is set
  if @api_client.config.client_side_validation && processor_token_permissions_set_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_token_permissions_set_request' when calling PlaidApi.processor_token_permissions_set"
  end
  # resource path
  local_var_path = '/processor/token/permissions/set'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_permissions_set_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTokenPermissionsSetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_token_permissions_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_token_permissions_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_token_webhook_update(processor_token_webhook_update_request, opts = {}) ⇒ ProcessorTokenWebhookUpdateResponse

Update a processor token’s webhook URL This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a ‘WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL.

Parameters:

Returns:



12730
12731
12732
12733
 
# File 'lib/plaid/api/plaid_api.rb', line 12730

def processor_token_webhook_update(processor_token_webhook_update_request, opts = {})
  data, _status_code, _headers = processor_token_webhook_update_with_http_info(processor_token_webhook_update_request, opts)
  data
end

#processor_token_webhook_update_with_http_info(processor_token_webhook_update_request, opts = {}) ⇒ Array<(ProcessorTokenWebhookUpdateResponse, Integer, Hash)>

Update a processor token&#39;s webhook URL This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a &#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60; webhook to the newly specified webhook URL.

Parameters:

Returns:



12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
 
# File 'lib/plaid/api/plaid_api.rb', line 12740

def processor_token_webhook_update_with_http_info(processor_token_webhook_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_webhook_update ...'
  end
  # verify the required parameter 'processor_token_webhook_update_request' is set
  if @api_client.config.client_side_validation && processor_token_webhook_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_token_webhook_update_request' when calling PlaidApi.processor_token_webhook_update"
  end
  # resource path
  local_var_path = '/processor/token/webhook/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_webhook_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTokenWebhookUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_token_webhook_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_token_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_transactions_get(processor_transactions_get_request, opts = {}) ⇒ ProcessorTransactionsGetResponse

Get transaction data The ‘/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/processor/transactions/get`. For more details, see [Pending and posted transactions](plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/processor/transactions/get` will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn’t. If no transaction history is ready when ‘/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



12798
12799
12800
12801
 
# File 'lib/plaid/api/plaid_api.rb', line 12798

def processor_transactions_get(processor_transactions_get_request, opts = {})
  data, _status_code, _headers = processor_transactions_get_with_http_info(processor_transactions_get_request, opts)
  data
end

#processor_transactions_get_with_http_info(processor_transactions_get_request, opts = {}) ⇒ Array<(ProcessorTransactionsGetResponse, Integer, Hash)>

Get transaction data The &#x60;/processor/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; 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 &#x60;/processor/transactions/get&#x60;. For more details, see [Pending and posted transactions](plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/processor/transactions/get&#x60; 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 &#x60;/processor/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/processor/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/processor/transactions/get&#x60;, if it wasn&#39;t. If no transaction history is ready when &#x60;/processor/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
 
# File 'lib/plaid/api/plaid_api.rb', line 12808

def processor_transactions_get_with_http_info(processor_transactions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_get ...'
  end
  # verify the required parameter 'processor_transactions_get_request' is set
  if @api_client.config.client_side_validation && processor_transactions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_transactions_get_request' when calling PlaidApi.processor_transactions_get"
  end
  # resource path
  local_var_path = '/processor/transactions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTransactionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_transactions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_transactions_recurring_get(processor_transactions_recurring_get_request, opts = {}) ⇒ ProcessorTransactionsRecurringGetResponse

Fetch recurring transaction streams The ‘/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](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/transactions/#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/transactions/#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/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](plaid.com/docs/api/products/transactions/#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-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



12866
12867
12868
12869
 
# File 'lib/plaid/api/plaid_api.rb', line 12866

def processor_transactions_recurring_get(processor_transactions_recurring_get_request, opts = {})
  data, _status_code, _headers = processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts)
  data
end

#processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts = {}) ⇒ Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>

Fetch recurring transaction streams The &#x60;/processor/transactions/recurring/get&#x60; 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 &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/processor/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/processor/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/processor/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/processor/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#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 [&#x60;/processor/token/webhook/update&#x60;](plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
 
# File 'lib/plaid/api/plaid_api.rb', line 12876

def processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_recurring_get ...'
  end
  # verify the required parameter 'processor_transactions_recurring_get_request' is set
  if @api_client.config.client_side_validation && processor_transactions_recurring_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_transactions_recurring_get_request' when calling PlaidApi.processor_transactions_recurring_get"
  end
  # resource path
  local_var_path = '/processor/transactions/recurring/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_recurring_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTransactionsRecurringGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_transactions_recurring_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_transactions_refresh(processor_transactions_refresh_request, opts = {}) ⇒ ProcessorTransactionsRefreshResponse

Refresh transaction data ‘/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur 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/transactions/#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/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/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.

Parameters:

Returns:



12934
12935
12936
12937
 
# File 'lib/plaid/api/plaid_api.rb', line 12934

def processor_transactions_refresh(processor_transactions_refresh_request, opts = {})
  data, _status_code, _headers = processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts)
  data
end

#processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts = {}) ⇒ Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>

Refresh transaction data &#x60;/processor/transactions/refresh&#x60; 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 &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; 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. &#x60;/processor/transactions/refresh&#x60; 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.

Parameters:

Returns:



12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
 
# File 'lib/plaid/api/plaid_api.rb', line 12944

def processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_refresh ...'
  end
  # verify the required parameter 'processor_transactions_refresh_request' is set
  if @api_client.config.client_side_validation && processor_transactions_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_transactions_refresh_request' when calling PlaidApi.processor_transactions_refresh"
  end
  # resource path
  local_var_path = '/processor/transactions/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTransactionsRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_transactions_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#processor_transactions_sync(processor_transactions_sync_request, opts = {}) ⇒ ProcessorTransactionsSyncResponse

Get incremental transaction updates on a processor token

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](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://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`](https://plaid.com/docs/errors/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](https://plaid.com/docs/account/activity/#troubleshooting-with-item-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`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.  To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



13002
13003
13004
13005
 
# File 'lib/plaid/api/plaid_api.rb', line 13002

def processor_transactions_sync(processor_transactions_sync_request, opts = {})
  data, _status_code, _headers = processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts)
  data
end

#processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {}) ⇒ Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>

Get incremental transaction updates on a processor token

The &#x60;/processor/transactions/sync&#x60; 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 &#x60;/processor/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/processor/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/).  This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead.  When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/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 &#x60;/link/token/create&#x60; call or if &#x60;/processor/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/processor/transactions/sync&#x60; 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](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint.  To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.  To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.

Parameters:

Returns:



13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
 
# File 'lib/plaid/api/plaid_api.rb', line 13012

def processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_sync ...'
  end
  # verify the required parameter 'processor_transactions_sync_request' is set
  if @api_client.config.client_side_validation && processor_transactions_sync_request.nil?
    fail ArgumentError, "Missing the required parameter 'processor_transactions_sync_request' when calling PlaidApi.processor_transactions_sync"
  end
  # resource path
  local_var_path = '/processor/transactions/sync'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_sync_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProcessorTransactionsSyncResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.processor_transactions_sync",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#profile_network_status_get(profile_network_status_get_request, opts = {}) ⇒ ProfileNetworkStatusGetResponse

Check a user’s Plaid Network status The ‘/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.

Parameters:

Returns:



13070
13071
13072
13073
 
# File 'lib/plaid/api/plaid_api.rb', line 13070

def profile_network_status_get(profile_network_status_get_request, opts = {})
  data, _status_code, _headers = profile_network_status_get_with_http_info(profile_network_status_get_request, opts)
  data
end

#profile_network_status_get_with_http_info(profile_network_status_get_request, opts = {}) ⇒ Array<(ProfileNetworkStatusGetResponse, Integer, Hash)>

Check a user&#39;s Plaid Network status The &#x60;/profile/network_status/get&#x60; endpoint can be used to check whether Plaid has a matching profile for the user.

Parameters:

Returns:



13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
 
# File 'lib/plaid/api/plaid_api.rb', line 13080

def profile_network_status_get_with_http_info(profile_network_status_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.profile_network_status_get ...'
  end
  # verify the required parameter 'profile_network_status_get_request' is set
  if @api_client.config.client_side_validation && profile_network_status_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'profile_network_status_get_request' when calling PlaidApi.profile_network_status_get"
  end
  # resource path
  local_var_path = '/profile/network_status/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_network_status_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProfileNetworkStatusGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.profile_network_status_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#profile_network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#protect_compute(protect_compute_request, opts = {}) ⇒ ProtectComputeResponse

Compute Protect Trust Index Score 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`.

Parameters:

  • protect_compute_request (ProtectComputeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



13138
13139
13140
13141
 
# File 'lib/plaid/api/plaid_api.rb', line 13138

def protect_compute(protect_compute_request, opts = {})
  data, _status_code, _headers = protect_compute_with_http_info(protect_compute_request, opts)
  data
end

#protect_compute_with_http_info(protect_compute_request, opts = {}) ⇒ Array<(ProtectComputeResponse, Integer, Hash)>

Compute Protect Trust Index Score 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 &#x60;error_type&#x60; &#x3D; &#x60;INVALID_REQUEST&#x60; and &#x60;error_code&#x60; &#x3D; &#x60;FAILED_PRECONDITION&#x60;.

Parameters:

  • protect_compute_request (ProtectComputeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ProtectComputeResponse, Integer, Hash)>) —

    ProtectComputeResponse data, response status code and response headers



13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
 
# File 'lib/plaid/api/plaid_api.rb', line 13148

def protect_compute_with_http_info(protect_compute_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.protect_compute ...'
  end
  # verify the required parameter 'protect_compute_request' is set
  if @api_client.config.client_side_validation && protect_compute_request.nil?
    fail ArgumentError, "Missing the required parameter 'protect_compute_request' when calling PlaidApi.protect_compute"
  end
  # resource path
  local_var_path = '/protect/compute'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_compute_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProtectComputeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.protect_compute",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#protect_compute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#protect_event_get(protect_event_get_request, opts = {}) ⇒ ProtectEventGetResponse

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

Parameters:

  • protect_event_get_request (ProtectEventGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



13206
13207
13208
13209
 
# File 'lib/plaid/api/plaid_api.rb', line 13206

def protect_event_get(protect_event_get_request, opts = {})
  data, _status_code, _headers = protect_event_get_with_http_info(protect_event_get_request, opts)
  data
end

#protect_event_get_with_http_info(protect_event_get_request, opts = {}) ⇒ Array<(ProtectEventGetResponse, Integer, Hash)>

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

Parameters:

  • protect_event_get_request (ProtectEventGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ProtectEventGetResponse, Integer, Hash)>) —

    ProtectEventGetResponse data, response status code and response headers



13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
 
# File 'lib/plaid/api/plaid_api.rb', line 13216

def protect_event_get_with_http_info(protect_event_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.protect_event_get ...'
  end
  # verify the required parameter 'protect_event_get_request' is set
  if @api_client.config.client_side_validation && protect_event_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'protect_event_get_request' when calling PlaidApi.protect_event_get"
  end
  # resource path
  local_var_path = '/protect/event/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_event_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProtectEventGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.protect_event_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#protect_event_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#protect_event_send(protect_event_send_request, opts = {}) ⇒ ProtectEventSendResponse

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

Parameters:

Returns:



13274
13275
13276
13277
 
# File 'lib/plaid/api/plaid_api.rb', line 13274

def protect_event_send(protect_event_send_request, opts = {})
  data, _status_code, _headers = protect_event_send_with_http_info(protect_event_send_request, opts)
  data
end

#protect_event_send_with_http_info(protect_event_send_request, opts = {}) ⇒ Array<(ProtectEventSendResponse, Integer, Hash)>

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

Parameters:

Returns:

  • (Array<(ProtectEventSendResponse, Integer, Hash)>) —

    ProtectEventSendResponse data, response status code and response headers



13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
 
# File 'lib/plaid/api/plaid_api.rb', line 13284

def protect_event_send_with_http_info(protect_event_send_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.protect_event_send ...'
  end
  # verify the required parameter 'protect_event_send_request' is set
  if @api_client.config.client_side_validation && protect_event_send_request.nil?
    fail ArgumentError, "Missing the required parameter 'protect_event_send_request' when calling PlaidApi.protect_event_send"
  end
  # resource path
  local_var_path = '/protect/event/send'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_event_send_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProtectEventSendResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.protect_event_send",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#protect_event_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#protect_report_create(protect_report_create_request, opts = {}) ⇒ ProtectReportCreateResponse

Create a Protect report 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.

Parameters:

Returns:



13342
13343
13344
13345
 
# File 'lib/plaid/api/plaid_api.rb', line 13342

def protect_report_create(protect_report_create_request, opts = {})
  data, _status_code, _headers = protect_report_create_with_http_info(protect_report_create_request, opts)
  data
end

#protect_report_create_with_http_info(protect_report_create_request, opts = {}) ⇒ Array<(ProtectReportCreateResponse, Integer, Hash)>

Create a Protect report 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.

Parameters:

Returns:

  • (Array<(ProtectReportCreateResponse, Integer, Hash)>) —

    ProtectReportCreateResponse data, response status code and response headers



13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
 
# File 'lib/plaid/api/plaid_api.rb', line 13352

def protect_report_create_with_http_info(protect_report_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.protect_report_create ...'
  end
  # verify the required parameter 'protect_report_create_request' is set
  if @api_client.config.client_side_validation && protect_report_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'protect_report_create_request' when calling PlaidApi.protect_report_create"
  end
  # resource path
  local_var_path = '/protect/report/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_report_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProtectReportCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.protect_report_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#protect_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#protect_user_insights_get(protect_user_insights_get_request, opts = {}) ⇒ ProtectUserInsightsGetResponse

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

Parameters:

Returns:



13410
13411
13412
13413
 
# File 'lib/plaid/api/plaid_api.rb', line 13410

def protect_user_insights_get(protect_user_insights_get_request, opts = {})
  data, _status_code, _headers = protect_user_insights_get_with_http_info(protect_user_insights_get_request, opts)
  data
end

#protect_user_insights_get_with_http_info(protect_user_insights_get_request, opts = {}) ⇒ Array<(ProtectUserInsightsGetResponse, Integer, Hash)>

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

Parameters:

Returns:



13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
 
# File 'lib/plaid/api/plaid_api.rb', line 13420

def protect_user_insights_get_with_http_info(protect_user_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.protect_user_insights_get ...'
  end
  # verify the required parameter 'protect_user_insights_get_request' is set
  if @api_client.config.client_side_validation && protect_user_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'protect_user_insights_get_request' when calling PlaidApi.protect_user_insights_get"
  end
  # resource path
  local_var_path = '/protect/user/insights/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_user_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ProtectUserInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.protect_user_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#protect_user_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_bank_income_fire_webhook(sandbox_bank_income_fire_webhook_request, opts = {}) ⇒ SandboxBankIncomeFireWebhookResponse

Manually fire a bank income webhook in sandbox Use the ‘/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.

Parameters:

Returns:



13478
13479
13480
13481
 
# File 'lib/plaid/api/plaid_api.rb', line 13478

def sandbox_bank_income_fire_webhook(sandbox_bank_income_fire_webhook_request, opts = {})
  data, _status_code, _headers = sandbox_bank_income_fire_webhook_with_http_info(sandbox_bank_income_fire_webhook_request, opts)
  data
end

#sandbox_bank_income_fire_webhook_with_http_info(sandbox_bank_income_fire_webhook_request, opts = {}) ⇒ Array<(SandboxBankIncomeFireWebhookResponse, Integer, Hash)>

Manually fire a bank income webhook in sandbox Use the &#x60;/sandbox/bank_income/fire_webhook&#x60; endpoint to manually trigger a Bank Income webhook in the Sandbox environment.

Parameters:

Returns:



13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
 
# File 'lib/plaid/api/plaid_api.rb', line 13488

def sandbox_bank_income_fire_webhook_with_http_info(sandbox_bank_income_fire_webhook_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_income_fire_webhook ...'
  end
  # verify the required parameter 'sandbox_bank_income_fire_webhook_request' is set
  if @api_client.config.client_side_validation && sandbox_bank_income_fire_webhook_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_bank_income_fire_webhook_request' when calling PlaidApi.sandbox_bank_income_fire_webhook"
  end
  # resource path
  local_var_path = '/sandbox/bank_income/fire_webhook'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_income_fire_webhook_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxBankIncomeFireWebhookResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_bank_income_fire_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_income_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {}) ⇒ SandboxBankTransferFireWebhookResponse

Manually fire a Bank Transfer webhook Use the ‘/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.

Parameters:

Returns:



13546
13547
13548
13549
 
# File 'lib/plaid/api/plaid_api.rb', line 13546

def sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {})
  data, _status_code, _headers = sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts)
  data
end

#sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {}) ⇒ Array<(SandboxBankTransferFireWebhookResponse, Integer, Hash)>

Manually fire a Bank Transfer webhook Use the &#x60;/sandbox/bank_transfer/fire_webhook&#x60; endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.

Parameters:

Returns:



13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
 
# File 'lib/plaid/api/plaid_api.rb', line 13556

def sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_fire_webhook ...'
  end
  # verify the required parameter 'sandbox_bank_transfer_fire_webhook_request' is set
  if @api_client.config.client_side_validation && sandbox_bank_transfer_fire_webhook_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_fire_webhook_request' when calling PlaidApi.sandbox_bank_transfer_fire_webhook"
  end
  # resource path
  local_var_path = '/sandbox/bank_transfer/fire_webhook'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_fire_webhook_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxBankTransferFireWebhookResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_bank_transfer_fire_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_bank_transfer_simulate(sandbox_bank_transfer_simulate_request, opts = {}) ⇒ SandboxBankTransferSimulateResponse

Simulate a bank transfer event in Sandbox Use the ‘/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

Parameters:

Returns:



13614
13615
13616
13617
 
# File 'lib/plaid/api/plaid_api.rb', line 13614

def sandbox_bank_transfer_simulate(sandbox_bank_transfer_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts)
  data
end

#sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts = {}) ⇒ Array<(SandboxBankTransferSimulateResponse, Integer, Hash)>

Simulate a bank transfer event in Sandbox Use the &#x60;/sandbox/bank_transfer/simulate&#x60; 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 &#x60;/bank_transfer/event/sync&#x60; or &#x60;/bank_transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

Parameters:

Returns:



13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
 
# File 'lib/plaid/api/plaid_api.rb', line 13624

def sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_simulate ...'
  end
  # verify the required parameter 'sandbox_bank_transfer_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_bank_transfer_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_simulate_request' when calling PlaidApi.sandbox_bank_transfer_simulate"
  end
  # resource path
  local_var_path = '/sandbox/bank_transfer/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxBankTransferSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_bank_transfer_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_cra_cashflow_updates_update(sandbox_cra_cashflow_updates_update_request, opts = {}) ⇒ SandboxCraCashflowUpdatesUpdateResponse

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

Parameters:

Returns:



13682
13683
13684
13685
 
# File 'lib/plaid/api/plaid_api.rb', line 13682

def sandbox_cra_cashflow_updates_update(sandbox_cra_cashflow_updates_update_request, opts = {})
  data, _status_code, _headers = sandbox_cra_cashflow_updates_update_with_http_info(sandbox_cra_cashflow_updates_update_request, opts)
  data
end

#sandbox_cra_cashflow_updates_update_with_http_info(sandbox_cra_cashflow_updates_update_request, opts = {}) ⇒ Array<(SandboxCraCashflowUpdatesUpdateResponse, Integer, Hash)>

Trigger an update for Cash Flow Updates Use the &#x60;/sandbox/cra/cashflow_updates/update&#x60; endpoint to manually trigger an update for Cash Flow Updates (Monitoring) in the Sandbox environment.

Parameters:

Returns:



13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
 
# File 'lib/plaid/api/plaid_api.rb', line 13692

def sandbox_cra_cashflow_updates_update_with_http_info(sandbox_cra_cashflow_updates_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_cra_cashflow_updates_update ...'
  end
  # verify the required parameter 'sandbox_cra_cashflow_updates_update_request' is set
  if @api_client.config.client_side_validation && sandbox_cra_cashflow_updates_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_cra_cashflow_updates_update_request' when calling PlaidApi.sandbox_cra_cashflow_updates_update"
  end
  # resource path
  local_var_path = '/sandbox/cra/cashflow_updates/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_cra_cashflow_updates_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxCraCashflowUpdatesUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_cra_cashflow_updates_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_cra_cashflow_updates_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_income_fire_webhook(sandbox_income_fire_webhook_request, opts = {}) ⇒ SandboxIncomeFireWebhookResponse

Manually fire an Income webhook Use the ‘/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.

Parameters:

Returns:



13750
13751
13752
13753
 
# File 'lib/plaid/api/plaid_api.rb', line 13750

def sandbox_income_fire_webhook(sandbox_income_fire_webhook_request, opts = {})
  data, _status_code, _headers = sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts)
  data
end

#sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts = {}) ⇒ Array<(SandboxIncomeFireWebhookResponse, Integer, Hash)>

Manually fire an Income webhook Use the &#x60;/sandbox/income/fire_webhook&#x60; endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.

Parameters:

Returns:



13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/plaid/api/plaid_api.rb', line 13760

def sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_income_fire_webhook ...'
  end
  # verify the required parameter 'sandbox_income_fire_webhook_request' is set
  if @api_client.config.client_side_validation && sandbox_income_fire_webhook_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_income_fire_webhook_request' when calling PlaidApi.sandbox_income_fire_webhook"
  end
  # resource path
  local_var_path = '/sandbox/income/fire_webhook'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_income_fire_webhook_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxIncomeFireWebhookResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_income_fire_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_income_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_item_fire_webhook(sandbox_item_fire_webhook_request, opts = {}) ⇒ SandboxItemFireWebhookResponse

Fire a test webhook The ‘/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: 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`).

Parameters:

Returns:



13818
13819
13820
13821
 
# File 'lib/plaid/api/plaid_api.rb', line 13818

def sandbox_item_fire_webhook(sandbox_item_fire_webhook_request, opts = {})
  data, _status_code, _headers = sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts)
  data
end

#sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts = {}) ⇒ Array<(SandboxItemFireWebhookResponse, Integer, Hash)>

Fire a test webhook The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid Sandbox &#x60;DEFAULT_UPDATE&#x60; webhook types include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;PENDING_DISCONNECT&#x60;: 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. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;USER_PERMISSION_REVOKED&#x60;: 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. &#x60;USER_ACCOUNT_REVOKED&#x60;: Fired when an end user has revoked access to their account on the Data Provider&#39;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 &#x60;TRANSFER&#x60;).

Parameters:

Returns:



13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
 
# File 'lib/plaid/api/plaid_api.rb', line 13828

def sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_fire_webhook ...'
  end
  # verify the required parameter 'sandbox_item_fire_webhook_request' is set
  if @api_client.config.client_side_validation && sandbox_item_fire_webhook_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_item_fire_webhook_request' when calling PlaidApi.sandbox_item_fire_webhook"
  end
  # resource path
  local_var_path = '/sandbox/item/fire_webhook'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_fire_webhook_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxItemFireWebhookResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_item_fire_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_item_reset_login(sandbox_item_reset_login_request, opts = {}) ⇒ SandboxItemResetLoginResponse

Force a Sandbox Item into an error state ‘/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link’s [update mode](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.

Parameters:

Returns:



13886
13887
13888
13889
 
# File 'lib/plaid/api/plaid_api.rb', line 13886

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts = {}) ⇒ Array<(SandboxItemResetLoginResponse, Integer, Hash)>

Force a Sandbox Item into an error state &#x60;/sandbox/item/reset_login/&#x60; forces an Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/item/reset_login&#x60;, You can then use Plaid Link update mode to restore the Item to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; 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 &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.

Parameters:

Returns:



13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
 
# File 'lib/plaid/api/plaid_api.rb', line 13896

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_reset_login ...'
  end
  # verify the required parameter 'sandbox_item_reset_login_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_item_reset_login_request' when calling PlaidApi.sandbox_item_reset_login"
  end
  # resource path
  local_var_path = '/sandbox/item/reset_login'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxItemResetLoginResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_item_reset_login",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_item_set_verification_status(sandbox_item_set_verification_status_request, opts = {}) ⇒ SandboxItemSetVerificationStatusResponse

Set verification status for Sandbox account The ‘/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](plaid.com/docs/auth/coverage/testing#).

Parameters:

Returns:



13954
13955
13956
13957
 
# File 'lib/plaid/api/plaid_api.rb', line 13954

def sandbox_item_set_verification_status(sandbox_item_set_verification_status_request, opts = {})
  data, _status_code, _headers = sandbox_item_set_verification_status_with_http_info(sandbox_item_set_verification_status_request, opts)
  data
end

#sandbox_item_set_verification_status_with_http_info(sandbox_item_set_verification_status_request, opts = {}) ⇒ Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>

Set verification status for Sandbox account The &#x60;/sandbox/item/set_verification_status&#x60; 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#).

Parameters:

Returns:



13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
 
# File 'lib/plaid/api/plaid_api.rb', line 13964

def sandbox_item_set_verification_status_with_http_info(sandbox_item_set_verification_status_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_set_verification_status ...'
  end
  # verify the required parameter 'sandbox_item_set_verification_status_request' is set
  if @api_client.config.client_side_validation && sandbox_item_set_verification_status_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_item_set_verification_status_request' when calling PlaidApi.sandbox_item_set_verification_status"
  end
  # resource path
  local_var_path = '/sandbox/item/set_verification_status'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_set_verification_status_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxItemSetVerificationStatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_item_set_verification_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_set_verification_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_oauth_select_accounts(sandbox_oauth_select_accounts_request, opts = {}) ⇒ Hash<String, Object>

Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution

Parameters:

Returns:

  • (Hash<String, Object>) 


14022
14023
14024
14025
 
# File 'lib/plaid/api/plaid_api.rb', line 14022

def sandbox_oauth_select_accounts(sandbox_oauth_select_accounts_request, opts = {})
  data, _status_code, _headers = sandbox_oauth_select_accounts_with_http_info(sandbox_oauth_select_accounts_request, opts)
  data
end

#sandbox_oauth_select_accounts_with_http_info(sandbox_oauth_select_accounts_request, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Save the selected accounts when connecting to the Platypus Oauth institution Save the selected accounts when connecting to the Platypus Oauth institution

Parameters:

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
 
# File 'lib/plaid/api/plaid_api.rb', line 14032

def sandbox_oauth_select_accounts_with_http_info(sandbox_oauth_select_accounts_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_oauth_select_accounts ...'
  end
  # verify the required parameter 'sandbox_oauth_select_accounts_request' is set
  if @api_client.config.client_side_validation && sandbox_oauth_select_accounts_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_oauth_select_accounts_request' when calling PlaidApi.sandbox_oauth_select_accounts"
  end
  # resource path
  local_var_path = '/sandbox/oauth/select_accounts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_oauth_select_accounts_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_oauth_select_accounts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_oauth_select_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_payment_profile_reset_login(sandbox_payment_profile_reset_login_request, opts = {}) ⇒ SandboxPaymentProfileResetLoginResponse

Reset the login of a Payment Profile ‘/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a `decision_rationale` `PAYMENT_PROFILE_LOGIN_REQUIRED`. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](plaid.com/docs/transfer/add-to-app/#create-a-link-token).

Parameters:

Returns:



14090
14091
14092
14093
 
# File 'lib/plaid/api/plaid_api.rb', line 14090

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#sandbox_payment_profile_reset_login_with_http_info(sandbox_payment_profile_reset_login_request, opts = {}) ⇒ Array<(SandboxPaymentProfileResetLoginResponse, Integer, Hash)>

Reset the login of a Payment Profile &#x60;/sandbox/payment_profile/reset_login/&#x60; 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 &#x60;/sandbox/payment_profile/reset_login&#x60;, calls to the &#x60;/transfer/authorization/create&#x60; with the Payment Profile will result in a &#x60;decision_rationale&#x60; &#x60;PAYMENT_PROFILE_LOGIN_REQUIRED&#x60;. 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-profile-optional) and [go through the Link flow](plaid.com/docs/transfer/add-to-app/#create-a-link-token).

Parameters:

Returns:



14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
 
# File 'lib/plaid/api/plaid_api.rb', line 14100

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_payment_profile_reset_login ...'
  end
  # verify the required parameter 'sandbox_payment_profile_reset_login_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_payment_profile_reset_login_request' when calling PlaidApi.sandbox_payment_profile_reset_login"
  end
  # resource path
  local_var_path = '/sandbox/payment_profile/reset_login'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxPaymentProfileResetLoginResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_payment_profile_reset_login",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_payment_profile_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_payment_simulate(sandbox_payment_simulate_request, opts = {}) ⇒ SandboxPaymentSimulateResponse

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

Parameters:

Returns:



14158
14159
14160
14161
 
# File 'lib/plaid/api/plaid_api.rb', line 14158

def sandbox_payment_simulate(sandbox_payment_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_payment_simulate_with_http_info(sandbox_payment_simulate_request, opts)
  data
end

#sandbox_payment_simulate_with_http_info(sandbox_payment_simulate_request, opts = {}) ⇒ Array<(SandboxPaymentSimulateResponse, Integer, Hash)>

Simulate a payment event in Sandbox Use the &#x60;/sandbox/payment/simulate&#x60; endpoint to simulate various payment events in the Sandbox environment. This endpoint will trigger the corresponding payment status webhook.

Parameters:

Returns:



14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
 
# File 'lib/plaid/api/plaid_api.rb', line 14168

def sandbox_payment_simulate_with_http_info(sandbox_payment_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_payment_simulate ...'
  end
  # verify the required parameter 'sandbox_payment_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_payment_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_payment_simulate_request' when calling PlaidApi.sandbox_payment_simulate"
  end
  # resource path
  local_var_path = '/sandbox/payment/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_payment_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxPaymentSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_payment_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_payment_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_processor_token_create(sandbox_processor_token_create_request, opts = {}) ⇒ SandboxProcessorTokenCreateResponse

Create a test Item and processor token Use the ‘/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.

Parameters:

Returns:



14226
14227
14228
14229
 
# File 'lib/plaid/api/plaid_api.rb', line 14226

def sandbox_processor_token_create(sandbox_processor_token_create_request, opts = {})
  data, _status_code, _headers = sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts)
  data
end

#sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts = {}) ⇒ Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>

Create a test Item and processor token Use the &#x60;/sandbox/processor_token/create&#x60; endpoint to create a valid &#x60;processor_token&#x60; for an arbitrary institution ID and test credentials. The created &#x60;processor_token&#x60; corresponds to a new Sandbox Item. You can then use this &#x60;processor_token&#x60; with the &#x60;/processor/&#x60; API endpoints in Sandbox. You can also use &#x60;/sandbox/processor_token/create&#x60; with the [&#x60;user_custom&#x60; test username](plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.

Parameters:

Returns:



14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
 
# File 'lib/plaid/api/plaid_api.rb', line 14236

def sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_processor_token_create ...'
  end
  # verify the required parameter 'sandbox_processor_token_create_request' is set
  if @api_client.config.client_side_validation && sandbox_processor_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_processor_token_create_request' when calling PlaidApi.sandbox_processor_token_create"
  end
  # resource path
  local_var_path = '/sandbox/processor_token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_processor_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxProcessorTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_processor_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_public_token_create(sandbox_public_token_create_request, opts = {}) ⇒ SandboxPublicTokenCreateResponse

Create a test Item Use the ‘/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](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/).

Parameters:

Returns:



14294
14295
14296
14297
 
# File 'lib/plaid/api/plaid_api.rb', line 14294

def sandbox_public_token_create(sandbox_public_token_create_request, opts = {})
  data, _status_code, _headers = sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts)
  data
end

#sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts = {}) ⇒ Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>

Create a test Item Use the &#x60;/sandbox/public_token/create&#x60; endpoint to create a valid &#x60;public_token&#x60; for an arbitrary institution ID, initial products, and test credentials. The created &#x60;public_token&#x60; maps to a new Sandbox Item. You can then call &#x60;/item/public_token/exchange&#x60; to exchange the &#x60;public_token&#x60; for an &#x60;access_token&#x60; and perform all API actions. &#x60;/sandbox/public_token/create&#x60; can also be used with the [&#x60;user_custom&#x60; test username](plaid.com/docs/sandbox/user-custom) to generate a test account with custom data, or with Plaid&#39;s [pre-populated Sandbox test accounts](plaid.com/docs/sandbox/test-credentials/).

Parameters:

Returns:



14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
 
# File 'lib/plaid/api/plaid_api.rb', line 14304

def sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_public_token_create ...'
  end
  # verify the required parameter 'sandbox_public_token_create_request' is set
  if @api_client.config.client_side_validation && sandbox_public_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_public_token_create_request' when calling PlaidApi.sandbox_public_token_create"
  end
  # resource path
  local_var_path = '/sandbox/public_token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_public_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxPublicTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_public_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_public_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transactions_create(sandbox_transactions_create_request, opts = {}) ⇒ SandboxTransactionsCreateResponse

Create sandbox transactions 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.

Parameters:

Returns:



14362
14363
14364
14365
 
# File 'lib/plaid/api/plaid_api.rb', line 14362

def sandbox_transactions_create(sandbox_transactions_create_request, opts = {})
  data, _status_code, _headers = sandbox_transactions_create_with_http_info(sandbox_transactions_create_request, opts)
  data
end

#sandbox_transactions_create_with_http_info(sandbox_transactions_create_request, opts = {}) ⇒ Array<(SandboxTransactionsCreateResponse, Integer, Hash)>

Create sandbox transactions Use the &#x60;/sandbox/transactions/create&#x60; 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 &#x60;user_transactions_dynamic&#x60; test user. You can use this to add transactions to test the &#x60;/transactions/get&#x60; and &#x60;/transactions/sync&#x60; endpoints.

Parameters:

Returns:



14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
 
# File 'lib/plaid/api/plaid_api.rb', line 14372

def sandbox_transactions_create_with_http_info(sandbox_transactions_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transactions_create ...'
  end
  # verify the required parameter 'sandbox_transactions_create_request' is set
  if @api_client.config.client_side_validation && sandbox_transactions_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transactions_create_request' when calling PlaidApi.sandbox_transactions_create"
  end
  # resource path
  local_var_path = '/sandbox/transactions/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transactions_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransactionsCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transactions_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transactions_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_fire_webhook(sandbox_transfer_fire_webhook_request, opts = {}) ⇒ SandboxTransferFireWebhookResponse

Manually fire a Transfer webhook Use the ‘/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment.

Parameters:

Returns:



14430
14431
14432
14433
 
# File 'lib/plaid/api/plaid_api.rb', line 14430

def sandbox_transfer_fire_webhook(sandbox_transfer_fire_webhook_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_fire_webhook_with_http_info(sandbox_transfer_fire_webhook_request, opts)
  data
end

#sandbox_transfer_fire_webhook_with_http_info(sandbox_transfer_fire_webhook_request, opts = {}) ⇒ Array<(SandboxTransferFireWebhookResponse, Integer, Hash)>

Manually fire a Transfer webhook Use the &#x60;/sandbox/transfer/fire_webhook&#x60; endpoint to manually trigger a &#x60;TRANSFER_EVENTS_UPDATE&#x60; webhook in the Sandbox environment.

Parameters:

Returns:



14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
 
# File 'lib/plaid/api/plaid_api.rb', line 14440

def sandbox_transfer_fire_webhook_with_http_info(sandbox_transfer_fire_webhook_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_fire_webhook ...'
  end
  # verify the required parameter 'sandbox_transfer_fire_webhook_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_fire_webhook_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_fire_webhook_request' when calling PlaidApi.sandbox_transfer_fire_webhook"
  end
  # resource path
  local_var_path = '/sandbox/transfer/fire_webhook'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_fire_webhook_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferFireWebhookResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_fire_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_ledger_deposit_simulate(sandbox_transfer_ledger_deposit_simulate_request, opts = {}) ⇒ SandboxTransferLedgerDepositSimulateResponse

Simulate a ledger deposit event in Sandbox Use the ‘/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment.

Parameters:

Returns:



14498
14499
14500
14501
 
# File 'lib/plaid/api/plaid_api.rb', line 14498

def sandbox_transfer_ledger_deposit_simulate(sandbox_transfer_ledger_deposit_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_ledger_deposit_simulate_with_http_info(sandbox_transfer_ledger_deposit_simulate_request, opts)
  data
end

#sandbox_transfer_ledger_deposit_simulate_with_http_info(sandbox_transfer_ledger_deposit_simulate_request, opts = {}) ⇒ Array<(SandboxTransferLedgerDepositSimulateResponse, Integer, Hash)>

Simulate a ledger deposit event in Sandbox Use the &#x60;/sandbox/transfer/ledger/deposit/simulate&#x60; endpoint to simulate a ledger deposit event in the Sandbox environment.

Parameters:

Returns:



14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
 
# File 'lib/plaid/api/plaid_api.rb', line 14508

def sandbox_transfer_ledger_deposit_simulate_with_http_info(sandbox_transfer_ledger_deposit_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_ledger_deposit_simulate ...'
  end
  # verify the required parameter 'sandbox_transfer_ledger_deposit_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_ledger_deposit_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_ledger_deposit_simulate_request' when calling PlaidApi.sandbox_transfer_ledger_deposit_simulate"
  end
  # resource path
  local_var_path = '/sandbox/transfer/ledger/deposit/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_ledger_deposit_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferLedgerDepositSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_ledger_deposit_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_ledger_deposit_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_ledger_simulate_available(sandbox_transfer_ledger_simulate_available_request, opts = {}) ⇒ SandboxTransferLedgerSimulateAvailableResponse

Simulate converting pending balance to available balance Use the ‘/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.

Parameters:

Returns:



14566
14567
14568
14569
 
# File 'lib/plaid/api/plaid_api.rb', line 14566

def sandbox_transfer_ledger_simulate_available(sandbox_transfer_ledger_simulate_available_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_ledger_simulate_available_with_http_info(sandbox_transfer_ledger_simulate_available_request, opts)
  data
end

#sandbox_transfer_ledger_simulate_available_with_http_info(sandbox_transfer_ledger_simulate_available_request, opts = {}) ⇒ Array<(SandboxTransferLedgerSimulateAvailableResponse, Integer, Hash)>

Simulate converting pending balance to available balance Use the &#x60;/sandbox/transfer/ledger/simulate_available&#x60; endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.

Parameters:

Returns:



14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
 
# File 'lib/plaid/api/plaid_api.rb', line 14576

def sandbox_transfer_ledger_simulate_available_with_http_info(sandbox_transfer_ledger_simulate_available_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_ledger_simulate_available ...'
  end
  # verify the required parameter 'sandbox_transfer_ledger_simulate_available_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_ledger_simulate_available_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_ledger_simulate_available_request' when calling PlaidApi.sandbox_transfer_ledger_simulate_available"
  end
  # resource path
  local_var_path = '/sandbox/transfer/ledger/simulate_available'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_ledger_simulate_available_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferLedgerSimulateAvailableResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_ledger_simulate_available",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_ledger_simulate_available\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_ledger_withdraw_simulate(sandbox_transfer_ledger_withdraw_simulate_request, opts = {}) ⇒ SandboxTransferLedgerWithdrawSimulateResponse

Simulate a ledger withdraw event in Sandbox Use the ‘/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment.

Parameters:

Returns:



14634
14635
14636
14637
 
# File 'lib/plaid/api/plaid_api.rb', line 14634

def sandbox_transfer_ledger_withdraw_simulate(sandbox_transfer_ledger_withdraw_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_ledger_withdraw_simulate_with_http_info(sandbox_transfer_ledger_withdraw_simulate_request, opts)
  data
end

#sandbox_transfer_ledger_withdraw_simulate_with_http_info(sandbox_transfer_ledger_withdraw_simulate_request, opts = {}) ⇒ Array<(SandboxTransferLedgerWithdrawSimulateResponse, Integer, Hash)>

Simulate a ledger withdraw event in Sandbox Use the &#x60;/sandbox/transfer/ledger/withdraw/simulate&#x60; endpoint to simulate a ledger withdraw event in the Sandbox environment.

Parameters:

Returns:



14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
 
# File 'lib/plaid/api/plaid_api.rb', line 14644

def sandbox_transfer_ledger_withdraw_simulate_with_http_info(sandbox_transfer_ledger_withdraw_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_ledger_withdraw_simulate ...'
  end
  # verify the required parameter 'sandbox_transfer_ledger_withdraw_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_ledger_withdraw_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_ledger_withdraw_simulate_request' when calling PlaidApi.sandbox_transfer_ledger_withdraw_simulate"
  end
  # resource path
  local_var_path = '/sandbox/transfer/ledger/withdraw/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_ledger_withdraw_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferLedgerWithdrawSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_ledger_withdraw_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_ledger_withdraw_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_refund_simulate(sandbox_transfer_refund_simulate_request, opts = {}) ⇒ SandboxTransferRefundSimulateResponse

Simulate a refund event in Sandbox Use the ‘/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

Parameters:

Returns:



14702
14703
14704
14705
 
# File 'lib/plaid/api/plaid_api.rb', line 14702

def sandbox_transfer_refund_simulate(sandbox_transfer_refund_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts)
  data
end

#sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts = {}) ⇒ Array<(SandboxTransferRefundSimulateResponse, Integer, Hash)>

Simulate a refund event in Sandbox Use the &#x60;/sandbox/transfer/refund/simulate&#x60; 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 &#x60;/transfer/event/sync&#x60; or &#x60;/transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

Parameters:

Returns:



14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
 
# File 'lib/plaid/api/plaid_api.rb', line 14712

def sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_refund_simulate ...'
  end
  # verify the required parameter 'sandbox_transfer_refund_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_refund_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_refund_simulate_request' when calling PlaidApi.sandbox_transfer_refund_simulate"
  end
  # resource path
  local_var_path = '/sandbox/transfer/refund/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_refund_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferRefundSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_refund_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_refund_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_repayment_simulate(sandbox_transfer_repayment_simulate_request, opts = {}) ⇒ SandboxTransferRepaymentSimulateResponse

Trigger the creation of a repayment Use the ‘/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.

Parameters:

Returns:



14770
14771
14772
14773
 
# File 'lib/plaid/api/plaid_api.rb', line 14770

def sandbox_transfer_repayment_simulate(sandbox_transfer_repayment_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts)
  data
end

#sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts = {}) ⇒ Array<(SandboxTransferRepaymentSimulateResponse, Integer, Hash)>

Trigger the creation of a repayment Use the &#x60;/sandbox/transfer/repayment/simulate&#x60; 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.

Parameters:

Returns:



14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
 
# File 'lib/plaid/api/plaid_api.rb', line 14780

def sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_repayment_simulate ...'
  end
  # verify the required parameter 'sandbox_transfer_repayment_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_repayment_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_repayment_simulate_request' when calling PlaidApi.sandbox_transfer_repayment_simulate"
  end
  # resource path
  local_var_path = '/sandbox/transfer/repayment/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_repayment_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferRepaymentSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_repayment_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_repayment_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_simulate(sandbox_transfer_simulate_request, opts = {}) ⇒ SandboxTransferSimulateResponse

Simulate a transfer event in Sandbox Use the ‘/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

Parameters:

Returns:



14838
14839
14840
14841
 
# File 'lib/plaid/api/plaid_api.rb', line 14838

def sandbox_transfer_simulate(sandbox_transfer_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts)
  data
end

#sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts = {}) ⇒ Array<(SandboxTransferSimulateResponse, Integer, Hash)>

Simulate a transfer event in Sandbox Use the &#x60;/sandbox/transfer/simulate&#x60; 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 &#x60;/transfer/event/sync&#x60; or &#x60;/transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

Parameters:

Returns:



14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
 
# File 'lib/plaid/api/plaid_api.rb', line 14848

def sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_simulate ...'
  end
  # verify the required parameter 'sandbox_transfer_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_simulate_request' when calling PlaidApi.sandbox_transfer_simulate"
  end
  # resource path
  local_var_path = '/sandbox/transfer/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_sweep_simulate(sandbox_transfer_sweep_simulate_request, opts = {}) ⇒ SandboxTransferSweepSimulateResponse

Simulate creating a sweep Use the ‘/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.

Parameters:

Returns:



14906
14907
14908
14909
 
# File 'lib/plaid/api/plaid_api.rb', line 14906

def sandbox_transfer_sweep_simulate(sandbox_transfer_sweep_simulate_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts)
  data
end

#sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts = {}) ⇒ Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>

Simulate creating a sweep Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of &#x60;swept&#x60; will become &#x60;swept_settled&#x60;, all &#x60;posted&#x60; or &#x60;pending&#x60; transfers with a sweep status of &#x60;unswept&#x60; will become &#x60;swept&#x60;, and all &#x60;returned&#x60; transfers with a sweep status of &#x60;swept&#x60; will become &#x60;return_swept&#x60;.

Parameters:

Returns:



14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
 
# File 'lib/plaid/api/plaid_api.rb', line 14916

def sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_sweep_simulate ...'
  end
  # verify the required parameter 'sandbox_transfer_sweep_simulate_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_sweep_simulate_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_sweep_simulate_request' when calling PlaidApi.sandbox_transfer_sweep_simulate"
  end
  # resource path
  local_var_path = '/sandbox/transfer/sweep/simulate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_sweep_simulate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferSweepSimulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_sweep_simulate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_sweep_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_test_clock_advance(sandbox_transfer_test_clock_advance_request, opts = {}) ⇒ SandboxTransferTestClockAdvanceResponse

Advance a test clock Use the ‘/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For example, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call.

Parameters:

Returns:



14974
14975
14976
14977
 
# File 'lib/plaid/api/plaid_api.rb', line 14974

def sandbox_transfer_test_clock_advance(sandbox_transfer_test_clock_advance_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_test_clock_advance_with_http_info(sandbox_transfer_test_clock_advance_request, opts)
  data
end

#sandbox_transfer_test_clock_advance_with_http_info(sandbox_transfer_test_clock_advance_request, opts = {}) ⇒ Array<(SandboxTransferTestClockAdvanceResponse, Integer, Hash)>

Advance a test clock Use the &#x60;/sandbox/transfer/test_clock/advance&#x60; endpoint to advance a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;virtual_time&#x60; field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing &#x60;virtual_time&#x60;, but may never go back to a lower &#x60;virtual_time&#x60;. 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 &#x60;virtual_time&#x60; &#x3D; t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current &#x60;virtual_time&#x60; should be limited such that there are no more than 20 originations resulting from the advance operation on each &#x60;recurring_transfer&#x60; associated with the &#x60;test_clock&#x60;. For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the &#x60;virtual_time&#x60; up to 80 weeks on each API call.

Parameters:

Returns:



14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
 
# File 'lib/plaid/api/plaid_api.rb', line 14984

def sandbox_transfer_test_clock_advance_with_http_info(sandbox_transfer_test_clock_advance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_advance ...'
  end
  # verify the required parameter 'sandbox_transfer_test_clock_advance_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_test_clock_advance_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_advance_request' when calling PlaidApi.sandbox_transfer_test_clock_advance"
  end
  # resource path
  local_var_path = '/sandbox/transfer/test_clock/advance'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_advance_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferTestClockAdvanceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_test_clock_advance",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_advance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_test_clock_create(sandbox_transfer_test_clock_create_request, opts = {}) ⇒ SandboxTransferTestClockCreateResponse

Create a test clock Use the ‘/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.

Parameters:

Returns:



15042
15043
15044
15045
 
# File 'lib/plaid/api/plaid_api.rb', line 15042

def sandbox_transfer_test_clock_create(sandbox_transfer_test_clock_create_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_test_clock_create_with_http_info(sandbox_transfer_test_clock_create_request, opts)
  data
end

#sandbox_transfer_test_clock_create_with_http_info(sandbox_transfer_test_clock_create_request, opts = {}) ⇒ Array<(SandboxTransferTestClockCreateResponse, Integer, Hash)>

Create a test clock Use the &#x60;/sandbox/transfer/test_clock/create&#x60; endpoint to create a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;virtual_time&#x60; 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.

Parameters:

Returns:



15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
 
# File 'lib/plaid/api/plaid_api.rb', line 15052

def sandbox_transfer_test_clock_create_with_http_info(sandbox_transfer_test_clock_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_create ...'
  end
  # verify the required parameter 'sandbox_transfer_test_clock_create_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_test_clock_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_create_request' when calling PlaidApi.sandbox_transfer_test_clock_create"
  end
  # resource path
  local_var_path = '/sandbox/transfer/test_clock/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferTestClockCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_test_clock_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_test_clock_get(sandbox_transfer_test_clock_get_request, opts = {}) ⇒ SandboxTransferTestClockGetResponse

Get a test clock Use the ‘/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment.

Parameters:

Returns:



15110
15111
15112
15113
 
# File 'lib/plaid/api/plaid_api.rb', line 15110

def sandbox_transfer_test_clock_get(sandbox_transfer_test_clock_get_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_test_clock_get_with_http_info(sandbox_transfer_test_clock_get_request, opts)
  data
end

#sandbox_transfer_test_clock_get_with_http_info(sandbox_transfer_test_clock_get_request, opts = {}) ⇒ Array<(SandboxTransferTestClockGetResponse, Integer, Hash)>

Get a test clock Use the &#x60;/sandbox/transfer/test_clock/get&#x60; endpoint to get a &#x60;test_clock&#x60; in the Sandbox environment.

Parameters:

Returns:



15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
 
# File 'lib/plaid/api/plaid_api.rb', line 15120

def sandbox_transfer_test_clock_get_with_http_info(sandbox_transfer_test_clock_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_get ...'
  end
  # verify the required parameter 'sandbox_transfer_test_clock_get_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_test_clock_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_get_request' when calling PlaidApi.sandbox_transfer_test_clock_get"
  end
  # resource path
  local_var_path = '/sandbox/transfer/test_clock/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferTestClockGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_test_clock_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_transfer_test_clock_list(sandbox_transfer_test_clock_list_request, opts = {}) ⇒ SandboxTransferTestClockListResponse

List test clocks Use the ‘/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks.

Parameters:

Returns:



15178
15179
15180
15181
 
# File 'lib/plaid/api/plaid_api.rb', line 15178

def sandbox_transfer_test_clock_list(sandbox_transfer_test_clock_list_request, opts = {})
  data, _status_code, _headers = sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts)
  data
end

#sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts = {}) ⇒ Array<(SandboxTransferTestClockListResponse, Integer, Hash)>

List test clocks Use the &#x60;/sandbox/transfer/test_clock/list&#x60; endpoint to see a list of all your test clocks in the Sandbox environment, by ascending &#x60;virtual_time&#x60;. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired test clocks.

Parameters:

Returns:



15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
 
# File 'lib/plaid/api/plaid_api.rb', line 15188

def sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_list ...'
  end
  # verify the required parameter 'sandbox_transfer_test_clock_list_request' is set
  if @api_client.config.client_side_validation && sandbox_transfer_test_clock_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_list_request' when calling PlaidApi.sandbox_transfer_test_clock_list"
  end
  # resource path
  local_var_path = '/sandbox/transfer/test_clock/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxTransferTestClockListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_transfer_test_clock_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sandbox_user_reset_login(sandbox_user_reset_login_request, opts = {}) ⇒ SandboxUserResetLoginResponse

Force item(s) for a Sandbox User into an error state ‘/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.

Parameters:

Returns:



15246
15247
15248
15249
 
# File 'lib/plaid/api/plaid_api.rb', line 15246

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, opts = {}) ⇒ Array<(SandboxUserResetLoginResponse, Integer, Hash)>

Force item(s) for a Sandbox User into an error state &#x60;/sandbox/user/reset_login/&#x60; functions the same as &#x60;/sandbox/item/reset_login&#x60;, but will modify Items related to a User. This endpoint forces each Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/user/reset_login&#x60;, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; 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 &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.

Parameters:

Returns:



15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
 
# File 'lib/plaid/api/plaid_api.rb', line 15256

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_user_reset_login ...'
  end
  # verify the required parameter 'sandbox_user_reset_login_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_user_reset_login_request' when calling PlaidApi.sandbox_user_reset_login"
  end
  # resource path
  local_var_path = '/sandbox/user/reset_login'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxUserResetLoginResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.sandbox_user_reset_login",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#sandbox_user_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#session_token_create(session_token_create_request, opts = {}) ⇒ SessionTokenCreateResponse

Create a Link token for Layer ‘/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).

Parameters:

Returns:



15314
15315
15316
15317
 
# File 'lib/plaid/api/plaid_api.rb', line 15314

def session_token_create(session_token_create_request, opts = {})
  data, _status_code, _headers = session_token_create_with_http_info(session_token_create_request, opts)
  data
end

#session_token_create_with_http_info(session_token_create_request, opts = {}) ⇒ Array<(SessionTokenCreateResponse, Integer, Hash)>

Create a Link token for Layer &#x60;/session/token/create&#x60; 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).

Parameters:

Returns:

  • (Array<(SessionTokenCreateResponse, Integer, Hash)>) —

    SessionTokenCreateResponse data, response status code and response headers



15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
 
# File 'lib/plaid/api/plaid_api.rb', line 15324

def session_token_create_with_http_info(session_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.session_token_create ...'
  end
  # verify the required parameter 'session_token_create_request' is set
  if @api_client.config.client_side_validation && session_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'session_token_create_request' when calling PlaidApi.session_token_create"
  end
  # resource path
  local_var_path = '/session/token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(session_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SessionTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.session_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#session_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signal_decision_report(signal_decision_report_request, opts = {}) ⇒ SignalDecisionReportResponse

Report whether you initiated an ACH transaction 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.

Parameters:

Returns:



15382
15383
15384
15385
 
# File 'lib/plaid/api/plaid_api.rb', line 15382

def signal_decision_report(signal_decision_report_request, opts = {})
  data, _status_code, _headers = signal_decision_report_with_http_info(signal_decision_report_request, opts)
  data
end

#signal_decision_report_with_http_info(signal_decision_report_request, opts = {}) ⇒ Array<(SignalDecisionReportResponse, Integer, Hash)>

Report whether you initiated an ACH transaction After you call &#x60;/signal/evaluate&#x60;, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was &#x60;REVIEW&#x60;, or if you take a different action than the one determined by the Signal Rules, you will need to call &#x60;/signal/decision/report&#x60;. 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 &#x60;/signal/decision/report&#x60; (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call &#x60;/signal/decision/report&#x60; again for the transaction to correct Plaid&#39;s records. If you are using Plaid Transfer as your payment processor, you also do not need to call &#x60;/signal/decision/report&#x60;, 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.

Parameters:

Returns:



15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
 
# File 'lib/plaid/api/plaid_api.rb', line 15392

def signal_decision_report_with_http_info(signal_decision_report_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.signal_decision_report ...'
  end
  # verify the required parameter 'signal_decision_report_request' is set
  if @api_client.config.client_side_validation && signal_decision_report_request.nil?
    fail ArgumentError, "Missing the required parameter 'signal_decision_report_request' when calling PlaidApi.signal_decision_report"
  end
  # resource path
  local_var_path = '/signal/decision/report'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_decision_report_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SignalDecisionReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.signal_decision_report",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signal_evaluate(signal_evaluate_request, opts = {}) ⇒ SignalEvaluateResponse

Evaluate a planned ACH transaction 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.

Parameters:

  • signal_evaluate_request (SignalEvaluateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



15450
15451
15452
15453
 
# File 'lib/plaid/api/plaid_api.rb', line 15450

def signal_evaluate(signal_evaluate_request, opts = {})
  data, _status_code, _headers = signal_evaluate_with_http_info(signal_evaluate_request, opts)
  data
end

#signal_evaluate_with_http_info(signal_evaluate_request, opts = {}) ⇒ Array<(SignalEvaluateResponse, Integer, Hash)>

Evaluate a planned ACH transaction Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using &#x60;/signal/evaluate&#x60;, you must first [create a ruleset](plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal-&gt;Rules**](dashboard.plaid.com/signal/risk-profiles). &#x60;/signal/evaluate&#x60; can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the &#x60;ruleset_key&#x60; 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.

Parameters:

  • signal_evaluate_request (SignalEvaluateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SignalEvaluateResponse, Integer, Hash)>) —

    SignalEvaluateResponse data, response status code and response headers



15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
 
# File 'lib/plaid/api/plaid_api.rb', line 15460

def signal_evaluate_with_http_info(signal_evaluate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.signal_evaluate ...'
  end
  # verify the required parameter 'signal_evaluate_request' is set
  if @api_client.config.client_side_validation && signal_evaluate_request.nil?
    fail ArgumentError, "Missing the required parameter 'signal_evaluate_request' when calling PlaidApi.signal_evaluate"
  end
  # resource path
  local_var_path = '/signal/evaluate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_evaluate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.signal_evaluate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signal_prepare(signal_prepare_request, opts = {}) ⇒ SignalPrepareResponse

Opt-in an Item to Signal Transaction Scores 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.

Parameters:

  • signal_prepare_request (SignalPrepareRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



15518
15519
15520
15521
 
# File 'lib/plaid/api/plaid_api.rb', line 15518

def signal_prepare(signal_prepare_request, opts = {})
  data, _status_code, _headers = signal_prepare_with_http_info(signal_prepare_request, opts)
  data
end

#signal_prepare_with_http_info(signal_prepare_request, opts = {}) ⇒ Array<(SignalPrepareResponse, Integer, Hash)>

Opt-in an Item to Signal Transaction Scores When an Item is not initialized with &#x60;signal&#x60;, call &#x60;/signal/prepare&#x60; to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where &#x60;signal&#x60; was added in the &#x60;additional_consented_products&#x60; array but not in the &#x60;products&#x60;, &#x60;optional_products&#x60;, or &#x60;required_if_supported_products&#x60; array. If &#x60;/signal/prepare&#x60; is skipped on an Item that is not initialized with &#x60;signal&#x60;, the initial call to &#x60;/signal/evaluate&#x60; 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 &#x60;signal&#x60;, this endpoint will return a 200 response and will not modify the Item.

Parameters:

  • signal_prepare_request (SignalPrepareRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SignalPrepareResponse, Integer, Hash)>) —

    SignalPrepareResponse data, response status code and response headers



15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
 
# File 'lib/plaid/api/plaid_api.rb', line 15528

def signal_prepare_with_http_info(signal_prepare_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.signal_prepare ...'
  end
  # verify the required parameter 'signal_prepare_request' is set
  if @api_client.config.client_side_validation && signal_prepare_request.nil?
    fail ArgumentError, "Missing the required parameter 'signal_prepare_request' when calling PlaidApi.signal_prepare"
  end
  # resource path
  local_var_path = '/signal/prepare'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_prepare_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SignalPrepareResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.signal_prepare",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#signal_prepare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signal_return_report(signal_return_report_request, opts = {}) ⇒ SignalReturnReportResponse

Report a return for an ACH transaction Call the ‘/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk 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.

Parameters:

Returns:



15586
15587
15588
15589
 
# File 'lib/plaid/api/plaid_api.rb', line 15586

def signal_return_report(signal_return_report_request, opts = {})
  data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
  data
end

#signal_return_report_with_http_info(signal_return_report_request, opts = {}) ⇒ Array<(SignalReturnReportResponse, Integer, Hash)>

Report a return for an ACH transaction Call the &#x60;/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/signal/evaluate&#x60; 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.

Parameters:

Returns:

  • (Array<(SignalReturnReportResponse, Integer, Hash)>) —

    SignalReturnReportResponse data, response status code and response headers



15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
 
# File 'lib/plaid/api/plaid_api.rb', line 15596

def signal_return_report_with_http_info(signal_return_report_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
  end
  # verify the required parameter 'signal_return_report_request' is set
  if @api_client.config.client_side_validation && signal_return_report_request.nil?
    fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
  end
  # resource path
  local_var_path = '/signal/return/report'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.signal_return_report",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signal_schedule(signal_schedule_request, opts = {}) ⇒ SignalScheduleResponse

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

Parameters:

  • signal_schedule_request (SignalScheduleRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



15654
15655
15656
15657
 
# File 'lib/plaid/api/plaid_api.rb', line 15654

def signal_schedule(signal_schedule_request, opts = {})
  data, _status_code, _headers = signal_schedule_with_http_info(signal_schedule_request, opts)
  data
end

#signal_schedule_with_http_info(signal_schedule_request, opts = {}) ⇒ Array<(SignalScheduleResponse, Integer, Hash)>

Schedule a planned ACH transaction Use &#x60;/signal/schedule&#x60; to schedule a planned ACH transaction.

Parameters:

  • signal_schedule_request (SignalScheduleRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SignalScheduleResponse, Integer, Hash)>) —

    SignalScheduleResponse data, response status code and response headers



15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
 
# File 'lib/plaid/api/plaid_api.rb', line 15664

def signal_schedule_with_http_info(signal_schedule_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.signal_schedule ...'
  end
  # verify the required parameter 'signal_schedule_request' is set
  if @api_client.config.client_side_validation && signal_schedule_request.nil?
    fail ArgumentError, "Missing the required parameter 'signal_schedule_request' when calling PlaidApi.signal_schedule"
  end
  # resource path
  local_var_path = '/signal/schedule'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_schedule_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SignalScheduleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.signal_schedule",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#signal_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#statements_download(statements_download_request, opts = {}) ⇒ File

Retrieve a single statement. The ‘/statements/download` endpoint retrieves a single statement PDF in binary format. The response will contain a `Plaid-Content-Hash` header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system.

Parameters:

Returns:

  • (File) 


15722
15723
15724
15725
 
# File 'lib/plaid/api/plaid_api.rb', line 15722

def statements_download(statements_download_request, opts = {})
  data, _status_code, _headers = statements_download_with_http_info(statements_download_request, opts)
  data
end

#statements_download_with_http_info(statements_download_request, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve a single statement. The &#x60;/statements/download&#x60; endpoint retrieves a single statement PDF in binary format. The response will contain a &#x60;Plaid-Content-Hash&#x60; 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.

Parameters:

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
 
# File 'lib/plaid/api/plaid_api.rb', line 15732

def statements_download_with_http_info(statements_download_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.statements_download ...'
  end
  # verify the required parameter 'statements_download_request' is set
  if @api_client.config.client_side_validation && statements_download_request.nil?
    fail ArgumentError, "Missing the required parameter 'statements_download_request' when calling PlaidApi.statements_download"
  end
  # resource path
  local_var_path = '/statements/download'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(statements_download_request)

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.statements_download",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#statements_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#statements_list(statements_list_request, opts = {}) ⇒ StatementsListResponse

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

Parameters:

  • statements_list_request (StatementsListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



15790
15791
15792
15793
 
# File 'lib/plaid/api/plaid_api.rb', line 15790

def statements_list(statements_list_request, opts = {})
  data, _status_code, _headers = statements_list_with_http_info(statements_list_request, opts)
  data
end

#statements_list_with_http_info(statements_list_request, opts = {}) ⇒ Array<(StatementsListResponse, Integer, Hash)>

Retrieve a list of all statements associated with an item. The &#x60;/statements/list&#x60; endpoint retrieves a list of all statements associated with an item.

Parameters:

  • statements_list_request (StatementsListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StatementsListResponse, Integer, Hash)>) —

    StatementsListResponse data, response status code and response headers



15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
 
# File 'lib/plaid/api/plaid_api.rb', line 15800

def statements_list_with_http_info(statements_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.statements_list ...'
  end
  # verify the required parameter 'statements_list_request' is set
  if @api_client.config.client_side_validation && statements_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'statements_list_request' when calling PlaidApi.statements_list"
  end
  # resource path
  local_var_path = '/statements/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(statements_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'StatementsListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.statements_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#statements_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#statements_refresh(statements_refresh_request, opts = {}) ⇒ StatementsRefreshResponse

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

Parameters:

Returns:



15858
15859
15860
15861
 
# File 'lib/plaid/api/plaid_api.rb', line 15858

def statements_refresh(statements_refresh_request, opts = {})
  data, _status_code, _headers = statements_refresh_with_http_info(statements_refresh_request, opts)
  data
end

#statements_refresh_with_http_info(statements_refresh_request, opts = {}) ⇒ Array<(StatementsRefreshResponse, Integer, Hash)>

Refresh statements data. &#x60;/statements/refresh&#x60; initiates an on-demand extraction to fetch the statements for the provided dates.

Parameters:

Returns:

  • (Array<(StatementsRefreshResponse, Integer, Hash)>) —

    StatementsRefreshResponse data, response status code and response headers



15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
 
# File 'lib/plaid/api/plaid_api.rb', line 15868

def statements_refresh_with_http_info(statements_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.statements_refresh ...'
  end
  # verify the required parameter 'statements_refresh_request' is set
  if @api_client.config.client_side_validation && statements_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'statements_refresh_request' when calling PlaidApi.statements_refresh"
  end
  # resource path
  local_var_path = '/statements/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(statements_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'StatementsRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.statements_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#statements_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_enhance(transactions_enhance_get_request, opts = {}) ⇒ TransactionsEnhanceGetResponse

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

Parameters:

Returns:



15926
15927
15928
15929
 
# File 'lib/plaid/api/plaid_api.rb', line 15926

def transactions_enhance(transactions_enhance_get_request, opts = {})
  data, _status_code, _headers = transactions_enhance_with_http_info(transactions_enhance_get_request, opts)
  data
end

#transactions_enhance_with_http_info(transactions_enhance_get_request, opts = {}) ⇒ Array<(TransactionsEnhanceGetResponse, Integer, Hash)>

enhance locally-held transaction data The &#x60;/beta/transactions/v1/enhance&#x60; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.

Parameters:

Returns:



15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
 
# File 'lib/plaid/api/plaid_api.rb', line 15936

def transactions_enhance_with_http_info(transactions_enhance_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enhance ...'
  end
  # verify the required parameter 'transactions_enhance_get_request' is set
  if @api_client.config.client_side_validation && transactions_enhance_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_enhance_get_request' when calling PlaidApi.transactions_enhance"
  end
  # resource path
  local_var_path = '/beta/transactions/v1/enhance'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enhance_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsEnhanceGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_enhance",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_enhance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_enrich(transactions_enrich_request, opts = {}) ⇒ TransactionsEnrichResponse

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

Parameters:

Returns:



15994
15995
15996
15997
 
# File 'lib/plaid/api/plaid_api.rb', line 15994

def transactions_enrich(transactions_enrich_request, opts = {})
  data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_request, opts)
  data
end

#transactions_enrich_with_http_info(transactions_enrich_request, opts = {}) ⇒ Array<(TransactionsEnrichResponse, Integer, Hash)>

Enrich locally-held transaction data The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.

Parameters:

Returns:

  • (Array<(TransactionsEnrichResponse, Integer, Hash)>) —

    TransactionsEnrichResponse data, response status code and response headers



16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
 
# File 'lib/plaid/api/plaid_api.rb', line 16004

def transactions_enrich_with_http_info(transactions_enrich_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enrich ...'
  end
  # verify the required parameter 'transactions_enrich_request' is set
  if @api_client.config.client_side_validation && transactions_enrich_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_enrich_request' when calling PlaidApi.transactions_enrich"
  end
  # resource path
  local_var_path = '/transactions/enrich'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enrich_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsEnrichResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_enrich",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_enrich\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_get(transactions_get_request, opts = {}) ⇒ TransactionsGetResponse

Get transaction data Note: All new implementations are encouraged to use ‘/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](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/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To find out when the Item was last updated, use the [Item Debugger](plaid.com/docs/account/activity/#troubleshooting-with-item-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/#initial_update) and [`HISTORICAL_UPDATE`](plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.

Parameters:

Returns:



16062
16063
16064
16065
 
# File 'lib/plaid/api/plaid_api.rb', line 16062

def transactions_get(transactions_get_request, opts = {})
  data, _status_code, _headers = transactions_get_with_http_info(transactions_get_request, opts)
  data
end

#transactions_get_with_http_info(transactions_get_request, opts = {}) ⇒ Array<(TransactionsGetResponse, Integer, Hash)>

Get transaction data Note: All new implementations are encouraged to use &#x60;/transactions/sync&#x60; rather than &#x60;/transactions/get&#x60;. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and improves developer ease-of-use for handling transactions updates. The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; 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 &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; 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-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.

Parameters:

Returns:

  • (Array<(TransactionsGetResponse, Integer, Hash)>) —

    TransactionsGetResponse data, response status code and response headers



16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
 
# File 'lib/plaid/api/plaid_api.rb', line 16072

def transactions_get_with_http_info(transactions_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_get ...'
  end
  # verify the required parameter 'transactions_get_request' is set
  if @api_client.config.client_side_validation && transactions_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_get_request' when calling PlaidApi.transactions_get"
  end
  # resource path
  local_var_path = '/transactions/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_recurring_get(transactions_recurring_get_request, opts = {}) ⇒ TransactionsRecurringGetResponse

Fetch recurring transaction streams The ‘/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](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-request-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/transactions/#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/transactions/#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/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.

Parameters:

Returns:



16130
16131
16132
16133
 
# File 'lib/plaid/api/plaid_api.rb', line 16130

def transactions_recurring_get(transactions_recurring_get_request, opts = {})
  data, _status_code, _headers = transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts)
  data
end

#transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts = {}) ⇒ Array<(TransactionsRecurringGetResponse, Integer, Hash)>

Fetch recurring transaction streams The &#x60;/transactions/recurring/get&#x60; 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 &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). When using Recurring Transactions, for best results, make sure to use the [&#x60;days_requested&#x60;](plaid.com/docs/api/link/#link-token-create-request-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 &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.

Parameters:

Returns:



16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
 
# File 'lib/plaid/api/plaid_api.rb', line 16140

def transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_recurring_get ...'
  end
  # verify the required parameter 'transactions_recurring_get_request' is set
  if @api_client.config.client_side_validation && transactions_recurring_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_recurring_get_request' when calling PlaidApi.transactions_recurring_get"
  end
  # resource path
  local_var_path = '/transactions/recurring/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_recurring_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsRecurringGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_recurring_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_refresh(transactions_refresh_request, opts = {}) ⇒ TransactionsRefreshResponse

Refresh transaction data ‘/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/transactions/#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/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) 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.

Parameters:

Returns:



16198
16199
16200
16201
 
# File 'lib/plaid/api/plaid_api.rb', line 16198

def transactions_refresh(transactions_refresh_request, opts = {})
  data, _status_code, _headers = transactions_refresh_with_http_info(transactions_refresh_request, opts)
  data
end

#transactions_refresh_with_http_info(transactions_refresh_request, opts = {}) ⇒ Array<(TransactionsRefreshResponse, Integer, Hash)>

Refresh transaction data &#x60;/transactions/refresh&#x60; 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 &#x60;/transactions/refresh&#x60;. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; 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. &#x60;/transactions/refresh&#x60; 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.

Parameters:

Returns:

  • (Array<(TransactionsRefreshResponse, Integer, Hash)>) —

    TransactionsRefreshResponse data, response status code and response headers



16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
 
# File 'lib/plaid/api/plaid_api.rb', line 16208

def transactions_refresh_with_http_info(transactions_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_refresh ...'
  end
  # verify the required parameter 'transactions_refresh_request' is set
  if @api_client.config.client_side_validation && transactions_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_refresh_request' when calling PlaidApi.transactions_refresh"
  end
  # resource path
  local_var_path = '/transactions/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_rules_create(transactions_rules_create_request, opts = {}) ⇒ TransactionsRulesCreateResponse

Create transaction category rule The ‘/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item’s transactions returned in ‘/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.

Parameters:

Returns:



16266
16267
16268
16269
 
# File 'lib/plaid/api/plaid_api.rb', line 16266

def transactions_rules_create(transactions_rules_create_request, opts = {})
  data, _status_code, _headers = transactions_rules_create_with_http_info(transactions_rules_create_request, opts)
  data
end

#transactions_rules_create_with_http_info(transactions_rules_create_request, opts = {}) ⇒ Array<(TransactionsRulesCreateResponse, Integer, Hash)>

Create transaction category rule The &#x60;/transactions/rules/v1/create&#x60; endpoint creates transaction categorization rules. Rules will be applied on the Item&#39;s transactions returned in &#x60;/transactions/get&#x60; response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.

Parameters:

Returns:



16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
 
# File 'lib/plaid/api/plaid_api.rb', line 16276

def transactions_rules_create_with_http_info(transactions_rules_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_create ...'
  end
  # verify the required parameter 'transactions_rules_create_request' is set
  if @api_client.config.client_side_validation && transactions_rules_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_rules_create_request' when calling PlaidApi.transactions_rules_create"
  end
  # resource path
  local_var_path = '/beta/transactions/rules/v1/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsRulesCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_rules_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_rules_list(transactions_rules_list_request, opts = {}) ⇒ TransactionsRulesListResponse

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

Parameters:

Returns:



16334
16335
16336
16337
 
# File 'lib/plaid/api/plaid_api.rb', line 16334

def transactions_rules_list(transactions_rules_list_request, opts = {})
  data, _status_code, _headers = transactions_rules_list_with_http_info(transactions_rules_list_request, opts)
  data
end

#transactions_rules_list_with_http_info(transactions_rules_list_request, opts = {}) ⇒ Array<(TransactionsRulesListResponse, Integer, Hash)>

Return a list of rules created for the Item associated with the access token. The &#x60;/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the Item associated with the access token.

Parameters:

Returns:



16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
 
# File 'lib/plaid/api/plaid_api.rb', line 16344

def transactions_rules_list_with_http_info(transactions_rules_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_list ...'
  end
  # verify the required parameter 'transactions_rules_list_request' is set
  if @api_client.config.client_side_validation && transactions_rules_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_rules_list_request' when calling PlaidApi.transactions_rules_list"
  end
  # resource path
  local_var_path = '/beta/transactions/rules/v1/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsRulesListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_rules_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_rules_remove(transactions_rules_remove_request, opts = {}) ⇒ TransactionsRulesRemoveResponse

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

Parameters:

Returns:



16402
16403
16404
16405
 
# File 'lib/plaid/api/plaid_api.rb', line 16402

def transactions_rules_remove(transactions_rules_remove_request, opts = {})
  data, _status_code, _headers = transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts)
  data
end

#transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts = {}) ⇒ Array<(TransactionsRulesRemoveResponse, Integer, Hash)>

Remove transaction rule The &#x60;/transactions/rules/v1/remove&#x60; endpoint is used to remove a transaction rule.

Parameters:

Returns:



16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
 
# File 'lib/plaid/api/plaid_api.rb', line 16412

def transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_remove ...'
  end
  # verify the required parameter 'transactions_rules_remove_request' is set
  if @api_client.config.client_side_validation && transactions_rules_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_rules_remove_request' when calling PlaidApi.transactions_rules_remove"
  end
  # resource path
  local_var_path = '/beta/transactions/rules/v1/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsRulesRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_rules_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_sync(transactions_sync_request, opts = {}) ⇒ TransactionsSyncResponse

Get incremental transaction updates on an Item 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/errors/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-item-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/transactions/#sync_updates_available) webhook.

Parameters:

Returns:



16470
16471
16472
16473
 
# File 'lib/plaid/api/plaid_api.rb', line 16470

def transactions_sync(transactions_sync_request, opts = {})
  data, _status_code, _headers = transactions_sync_with_http_info(transactions_sync_request, opts)
  data
end

#transactions_sync_with_http_info(transactions_sync_request, opts = {}) ⇒ Array<(TransactionsSyncResponse, Integer, Hash)>

Get incremental transaction updates on an Item The &#x60;/transactions/sync&#x60; 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 &#x60;/transactions/sync&#x60;, see the [Transactions integration overview](plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/transactions/get&#x60;, see the [Transactions Sync migration guide](plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](plaid.com/docs/errors/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 &#x60;/link/token/create&#x60; call or if &#x60;/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/transactions/sync&#x60; 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-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.

Parameters:

Returns:

  • (Array<(TransactionsSyncResponse, Integer, Hash)>) —

    TransactionsSyncResponse data, response status code and response headers



16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
 
# File 'lib/plaid/api/plaid_api.rb', line 16480

def transactions_sync_with_http_info(transactions_sync_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_sync ...'
  end
  # verify the required parameter 'transactions_sync_request' is set
  if @api_client.config.client_side_validation && transactions_sync_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_sync_request' when calling PlaidApi.transactions_sync"
  end
  # resource path
  local_var_path = '/transactions/sync'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_sync_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_sync",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transactions_user_insights_get(transactions_user_insights_get_request, opts = {}) ⇒ TransactionsUserInsightsGetResponse

Obtain user insights based on transactions sent through /transactions/enrich The ‘/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta.

Parameters:

Returns:



16538
16539
16540
16541
 
# File 'lib/plaid/api/plaid_api.rb', line 16538

def transactions_user_insights_get(transactions_user_insights_get_request, opts = {})
  data, _status_code, _headers = transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts)
  data
end

#transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts = {}) ⇒ Array<(TransactionsUserInsightsGetResponse, Integer, Hash)>

Obtain user insights based on transactions sent through /transactions/enrich The &#x60;/beta/transactions/user_insights/v1/get&#x60; gets user insights for clients who have enriched data with &#x60;/transactions/enrich&#x60;. The product is currently in beta.

Parameters:

Returns:



16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
 
# File 'lib/plaid/api/plaid_api.rb', line 16548

def transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_user_insights_get ...'
  end
  # verify the required parameter 'transactions_user_insights_get_request' is set
  if @api_client.config.client_side_validation && transactions_user_insights_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transactions_user_insights_get_request' when calling PlaidApi.transactions_user_insights_get"
  end
  # resource path
  local_var_path = '/beta/transactions/user_insights/v1/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_user_insights_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionsUserInsightsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transactions_user_insights_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transactions_user_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_authorization_cancel(transfer_authorization_cancel_request, opts = {}) ⇒ TransferAuthorizationCancelResponse

Cancel a transfer authorization 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.

Parameters:

Returns:



16606
16607
16608
16609
 
# File 'lib/plaid/api/plaid_api.rb', line 16606

def transfer_authorization_cancel(transfer_authorization_cancel_request, opts = {})
  data, _status_code, _headers = transfer_authorization_cancel_with_http_info(transfer_authorization_cancel_request, opts)
  data
end

#transfer_authorization_cancel_with_http_info(transfer_authorization_cancel_request, opts = {}) ⇒ Array<(TransferAuthorizationCancelResponse, Integer, Hash)>

Cancel a transfer authorization Use the &#x60;/transfer/authorization/cancel&#x60; endpoint to cancel a transfer authorization. A transfer authorization is eligible for cancellation if it has not yet been used to create a transfer.

Parameters:

Returns:



16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
 
# File 'lib/plaid/api/plaid_api.rb', line 16616

def transfer_authorization_cancel_with_http_info(transfer_authorization_cancel_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_authorization_cancel ...'
  end
  # verify the required parameter 'transfer_authorization_cancel_request' is set
  if @api_client.config.client_side_validation && transfer_authorization_cancel_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_authorization_cancel_request' when calling PlaidApi.transfer_authorization_cancel"
  end
  # resource path
  local_var_path = '/transfer/authorization/cancel'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_authorization_cancel_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferAuthorizationCancelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_authorization_cancel",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_authorization_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_authorization_create(transfer_authorization_create_request, opts = {}) ⇒ TransferAuthorizationCreateResponse

Create a transfer authorization Use the ‘/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. 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.

Parameters:

Returns:



16674
16675
16676
16677
 
# File 'lib/plaid/api/plaid_api.rb', line 16674

def transfer_authorization_create(transfer_authorization_create_request, opts = {})
  data, _status_code, _headers = transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts)
  data
end

#transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts = {}) ⇒ Array<(TransferAuthorizationCreateResponse, Integer, Hash)>

Create a transfer authorization Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. 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 &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the &#x60;authorization.decision&#x60; is &#x60;user_action_required&#x60;, 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 &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, 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&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, 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 &#x60;user_action_required&#x60;, [reset the login for an Item](plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. 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 &#x60;RISK&#x60;, 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.

Parameters:

Returns:



16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
 
# File 'lib/plaid/api/plaid_api.rb', line 16684

def transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_authorization_create ...'
  end
  # verify the required parameter 'transfer_authorization_create_request' is set
  if @api_client.config.client_side_validation && transfer_authorization_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_authorization_create_request' when calling PlaidApi.transfer_authorization_create"
  end
  # resource path
  local_var_path = '/transfer/authorization/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_authorization_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferAuthorizationCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_authorization_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_balance_get(transfer_balance_get_request, opts = {}) ⇒ TransferBalanceGetResponse

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

Parameters:

Returns:



16742
16743
16744
16745
 
# File 'lib/plaid/api/plaid_api.rb', line 16742

def transfer_balance_get(transfer_balance_get_request, opts = {})
  data, _status_code, _headers = transfer_balance_get_with_http_info(transfer_balance_get_request, opts)
  data
end

#transfer_balance_get_with_http_info(transfer_balance_get_request, opts = {}) ⇒ Array<(TransferBalanceGetResponse, Integer, Hash)>

(Deprecated) Retrieve a balance held with Plaid (Deprecated) Use the &#x60;/transfer/balance/get&#x60; endpoint to view a balance held with Plaid.

Parameters:

Returns:

  • (Array<(TransferBalanceGetResponse, Integer, Hash)>) —

    TransferBalanceGetResponse data, response status code and response headers



16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
 
# File 'lib/plaid/api/plaid_api.rb', line 16752

def transfer_balance_get_with_http_info(transfer_balance_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_balance_get ...'
  end
  # verify the required parameter 'transfer_balance_get_request' is set
  if @api_client.config.client_side_validation && transfer_balance_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_balance_get_request' when calling PlaidApi.transfer_balance_get"
  end
  # resource path
  local_var_path = '/transfer/balance/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_balance_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferBalanceGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_balance_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_cancel(transfer_cancel_request, opts = {}) ⇒ TransferCancelResponse

Cancel a transfer Use the ‘/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.

Parameters:

  • transfer_cancel_request (TransferCancelRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



16810
16811
16812
16813
 
# File 'lib/plaid/api/plaid_api.rb', line 16810

def transfer_cancel(transfer_cancel_request, opts = {})
  data, _status_code, _headers = transfer_cancel_with_http_info(transfer_cancel_request, opts)
  data
end

#transfer_cancel_with_http_info(transfer_cancel_request, opts = {}) ⇒ Array<(TransferCancelResponse, Integer, Hash)>

Cancel a transfer Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer. A transfer is eligible for cancellation if the &#x60;cancellable&#x60; property returned by &#x60;/transfer/get&#x60; is &#x60;true&#x60;.

Parameters:

  • transfer_cancel_request (TransferCancelRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransferCancelResponse, Integer, Hash)>) —

    TransferCancelResponse data, response status code and response headers



16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
 
# File 'lib/plaid/api/plaid_api.rb', line 16820

def transfer_cancel_with_http_info(transfer_cancel_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_cancel ...'
  end
  # verify the required parameter 'transfer_cancel_request' is set
  if @api_client.config.client_side_validation && transfer_cancel_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_cancel_request' when calling PlaidApi.transfer_cancel"
  end
  # resource path
  local_var_path = '/transfer/cancel'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_cancel_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferCancelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_cancel",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_capabilities_get(transfer_capabilities_get_request, opts = {}) ⇒ TransferCapabilitiesGetResponse

Get RTP eligibility information of a transfer 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`.

Parameters:

Returns:



16878
16879
16880
16881
 
# File 'lib/plaid/api/plaid_api.rb', line 16878

def transfer_capabilities_get(transfer_capabilities_get_request, opts = {})
  data, _status_code, _headers = transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts)
  data
end

#transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts = {}) ⇒ Array<(TransferCapabilitiesGetResponse, Integer, Hash)>

Get RTP eligibility information of a transfer Use the &#x60;/transfer/capabilities/get&#x60; 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 &#x60;/transfer/migrate_account&#x60;.

Parameters:

Returns:



16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'lib/plaid/api/plaid_api.rb', line 16888

def transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_capabilities_get ...'
  end
  # verify the required parameter 'transfer_capabilities_get_request' is set
  if @api_client.config.client_side_validation && transfer_capabilities_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_capabilities_get_request' when calling PlaidApi.transfer_capabilities_get"
  end
  # resource path
  local_var_path = '/transfer/capabilities/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_capabilities_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferCapabilitiesGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_capabilities_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_capabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_configuration_get(transfer_configuration_get_request, opts = {}) ⇒ TransferConfigurationGetResponse

Get transfer product configuration Use the ‘/transfer/configuration/get` endpoint to view your transfer product configurations.

Parameters:

Returns:



16946
16947
16948
16949
 
# File 'lib/plaid/api/plaid_api.rb', line 16946

def transfer_configuration_get(transfer_configuration_get_request, opts = {})
  data, _status_code, _headers = transfer_configuration_get_with_http_info(transfer_configuration_get_request, opts)
  data
end

#transfer_configuration_get_with_http_info(transfer_configuration_get_request, opts = {}) ⇒ Array<(TransferConfigurationGetResponse, Integer, Hash)>

Get transfer product configuration Use the &#x60;/transfer/configuration/get&#x60; endpoint to view your transfer product configurations.

Parameters:

Returns:



16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
 
# File 'lib/plaid/api/plaid_api.rb', line 16956

def transfer_configuration_get_with_http_info(transfer_configuration_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_configuration_get ...'
  end
  # verify the required parameter 'transfer_configuration_get_request' is set
  if @api_client.config.client_side_validation && transfer_configuration_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_configuration_get_request' when calling PlaidApi.transfer_configuration_get"
  end
  # resource path
  local_var_path = '/transfer/configuration/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_configuration_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferConfigurationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_configuration_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_configuration_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_create(transfer_create_request, opts = {}) ⇒ TransferCreateResponse

Create a transfer 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/).

Parameters:

  • transfer_create_request (TransferCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



17014
17015
17016
17017
 
# File 'lib/plaid/api/plaid_api.rb', line 17014

def transfer_create(transfer_create_request, opts = {})
  data, _status_code, _headers = transfer_create_with_http_info(transfer_create_request, opts)
  data
end

#transfer_create_with_http_info(transfer_create_request, opts = {}) ⇒ Array<(TransferCreateResponse, Integer, Hash)>

Create a transfer Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided &#x60;transfer_id&#x60; 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/).

Parameters:

  • transfer_create_request (TransferCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransferCreateResponse, Integer, Hash)>) —

    TransferCreateResponse data, response status code and response headers



17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
 
# File 'lib/plaid/api/plaid_api.rb', line 17024

def transfer_create_with_http_info(transfer_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_create ...'
  end
  # verify the required parameter 'transfer_create_request' is set
  if @api_client.config.client_side_validation && transfer_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_create_request' when calling PlaidApi.transfer_create"
  end
  # resource path
  local_var_path = '/transfer/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_diligence_document_upload(transfer_diligence_document_upload_request, opts = {}) ⇒ TransferDiligenceDocumentUploadResponse

Upload transfer diligence document on behalf of the originator Third-party sender customers can use ‘/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.

Parameters:

Returns:



17082
17083
17084
17085
 
# File 'lib/plaid/api/plaid_api.rb', line 17082

def transfer_diligence_document_upload(transfer_diligence_document_upload_request, opts = {})
  data, _status_code, _headers = transfer_diligence_document_upload_with_http_info(transfer_diligence_document_upload_request, opts)
  data
end

#transfer_diligence_document_upload_with_http_info(transfer_diligence_document_upload_request, opts = {}) ⇒ Array<(TransferDiligenceDocumentUploadResponse, Integer, Hash)>

Upload transfer diligence document on behalf of the originator Third-party sender customers can use &#x60;/transfer/diligence/document/upload&#x60; 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 &#x60;client_id&#x60; in the &#x60;PLAID-CLIENT-ID&#x60; header and &#x60;secret&#x60; in the &#x60;PLAID-SECRET&#x60; header.

Parameters:

Returns:



17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
 
# File 'lib/plaid/api/plaid_api.rb', line 17092

def transfer_diligence_document_upload_with_http_info(transfer_diligence_document_upload_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_diligence_document_upload ...'
  end
  # verify the required parameter 'transfer_diligence_document_upload_request' is set
  if @api_client.config.client_side_validation && transfer_diligence_document_upload_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_diligence_document_upload_request' when calling PlaidApi.transfer_diligence_document_upload"
  end
  # resource path
  local_var_path = '/transfer/diligence/document/upload'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_diligence_document_upload_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferDiligenceDocumentUploadResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_diligence_document_upload",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_diligence_document_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_diligence_submit(transfer_diligence_submit_request, opts = {}) ⇒ TransferDiligenceSubmitResponse

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

Parameters:

Returns:



17150
17151
17152
17153
 
# File 'lib/plaid/api/plaid_api.rb', line 17150

def transfer_diligence_submit(transfer_diligence_submit_request, opts = {})
  data, _status_code, _headers = transfer_diligence_submit_with_http_info(transfer_diligence_submit_request, opts)
  data
end

#transfer_diligence_submit_with_http_info(transfer_diligence_submit_request, opts = {}) ⇒ Array<(TransferDiligenceSubmitResponse, Integer, Hash)>

Submit transfer diligence on behalf of the originator Use the &#x60;/transfer/diligence/submit&#x60; endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).

Parameters:

Returns:



17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
 
# File 'lib/plaid/api/plaid_api.rb', line 17160

def transfer_diligence_submit_with_http_info(transfer_diligence_submit_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_diligence_submit ...'
  end
  # verify the required parameter 'transfer_diligence_submit_request' is set
  if @api_client.config.client_side_validation && transfer_diligence_submit_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_diligence_submit_request' when calling PlaidApi.transfer_diligence_submit"
  end
  # resource path
  local_var_path = '/transfer/diligence/submit'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_diligence_submit_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferDiligenceSubmitResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_diligence_submit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_diligence_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_event_list(transfer_event_list_request, opts = {}) ⇒ TransferEventListResponse

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

Parameters:

Returns:



17218
17219
17220
17221
 
# File 'lib/plaid/api/plaid_api.rb', line 17218

def transfer_event_list(transfer_event_list_request, opts = {})
  data, _status_code, _headers = transfer_event_list_with_http_info(transfer_event_list_request, opts)
  data
end

#transfer_event_list_with_http_info(transfer_event_list_request, opts = {}) ⇒ Array<(TransferEventListResponse, Integer, Hash)>

List transfer events Use the &#x60;/transfer/event/list&#x60; endpoint to get a list of transfer events based on specified filter criteria.

Parameters:

Returns:

  • (Array<(TransferEventListResponse, Integer, Hash)>) —

    TransferEventListResponse data, response status code and response headers



17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
 
# File 'lib/plaid/api/plaid_api.rb', line 17228

def transfer_event_list_with_http_info(transfer_event_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_list ...'
  end
  # verify the required parameter 'transfer_event_list_request' is set
  if @api_client.config.client_side_validation && transfer_event_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_event_list_request' when calling PlaidApi.transfer_event_list"
  end
  # resource path
  local_var_path = '/transfer/event/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferEventListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_event_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_event_sync(transfer_event_sync_request, opts = {}) ⇒ TransferEventSyncResponse

Sync transfer events ‘/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.

Parameters:

Returns:



17286
17287
17288
17289
 
# File 'lib/plaid/api/plaid_api.rb', line 17286

def transfer_event_sync(transfer_event_sync_request, opts = {})
  data, _status_code, _headers = transfer_event_sync_with_http_info(transfer_event_sync_request, opts)
  data
end

#transfer_event_sync_with_http_info(transfer_event_sync_request, opts = {}) ⇒ Array<(TransferEventSyncResponse, Integer, Hash)>

Sync transfer events &#x60;/transfer/event/sync&#x60; allows you to request up to the next 500 transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/transfer/event/sync&#x60; endpoint to guarantee you have seen all transfer events.

Parameters:

Returns:

  • (Array<(TransferEventSyncResponse, Integer, Hash)>) —

    TransferEventSyncResponse data, response status code and response headers



17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
 
# File 'lib/plaid/api/plaid_api.rb', line 17296

def transfer_event_sync_with_http_info(transfer_event_sync_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_sync ...'
  end
  # verify the required parameter 'transfer_event_sync_request' is set
  if @api_client.config.client_side_validation && transfer_event_sync_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_event_sync_request' when calling PlaidApi.transfer_event_sync"
  end
  # resource path
  local_var_path = '/transfer/event/sync'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_sync_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferEventSyncResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_event_sync",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_event_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_get(transfer_get_request, opts = {}) ⇒ TransferGetResponse

Retrieve a transfer 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.

Parameters:

  • transfer_get_request (TransferGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



17354
17355
17356
17357
 
# File 'lib/plaid/api/plaid_api.rb', line 17354

def transfer_get(transfer_get_request, opts = {})
  data, _status_code, _headers = transfer_get_with_http_info(transfer_get_request, opts)
  data
end

#transfer_get_with_http_info(transfer_get_request, opts = {}) ⇒ Array<(TransferGetResponse, Integer, Hash)>

Retrieve a transfer The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60; or &#x60;authorization_id&#x60;. One of &#x60;transfer_id&#x60; or &#x60;authorization_id&#x60; must be populated but not both.

Parameters:

  • transfer_get_request (TransferGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransferGetResponse, Integer, Hash)>) —

    TransferGetResponse data, response status code and response headers



17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
 
# File 'lib/plaid/api/plaid_api.rb', line 17364

def transfer_get_with_http_info(transfer_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_get ...'
  end
  # verify the required parameter 'transfer_get_request' is set
  if @api_client.config.client_side_validation && transfer_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_get_request' when calling PlaidApi.transfer_get"
  end
  # resource path
  local_var_path = '/transfer/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_intent_create(transfer_intent_create_request, opts = {}) ⇒ TransferIntentCreateResponse

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

Parameters:

Returns:



17422
17423
17424
17425
 
# File 'lib/plaid/api/plaid_api.rb', line 17422

def transfer_intent_create(transfer_intent_create_request, opts = {})
  data, _status_code, _headers = transfer_intent_create_with_http_info(transfer_intent_create_request, opts)
  data
end

#transfer_intent_create_with_http_info(transfer_intent_create_request, opts = {}) ⇒ Array<(TransferIntentCreateResponse, Integer, Hash)>

Create a transfer intent object to invoke the Transfer UI Use the &#x60;/transfer/intent/create&#x60; endpoint to generate a transfer intent object and invoke the Transfer UI.

Parameters:

Returns:



17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
 
# File 'lib/plaid/api/plaid_api.rb', line 17432

def transfer_intent_create_with_http_info(transfer_intent_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_create ...'
  end
  # verify the required parameter 'transfer_intent_create_request' is set
  if @api_client.config.client_side_validation && transfer_intent_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_intent_create_request' when calling PlaidApi.transfer_intent_create"
  end
  # resource path
  local_var_path = '/transfer/intent/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_intent_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferIntentCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_intent_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_intent_get(transfer_intent_get_request, opts = {}) ⇒ TransferIntentGetResponse

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

Parameters:

Returns:



17490
17491
17492
17493
 
# File 'lib/plaid/api/plaid_api.rb', line 17490

def transfer_intent_get(transfer_intent_get_request, opts = {})
  data, _status_code, _headers = transfer_intent_get_with_http_info(transfer_intent_get_request, opts)
  data
end

#transfer_intent_get_with_http_info(transfer_intent_get_request, opts = {}) ⇒ Array<(TransferIntentGetResponse, Integer, Hash)>

Retrieve more information about a transfer intent Use the &#x60;/transfer/intent/get&#x60; endpoint to retrieve more information about a transfer intent.

Parameters:

Returns:

  • (Array<(TransferIntentGetResponse, Integer, Hash)>) —

    TransferIntentGetResponse data, response status code and response headers



17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
 
# File 'lib/plaid/api/plaid_api.rb', line 17500

def transfer_intent_get_with_http_info(transfer_intent_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_get ...'
  end
  # verify the required parameter 'transfer_intent_get_request' is set
  if @api_client.config.client_side_validation && transfer_intent_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_intent_get_request' when calling PlaidApi.transfer_intent_get"
  end
  # resource path
  local_var_path = '/transfer/intent/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_intent_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferIntentGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_intent_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_ledger_deposit(transfer_ledger_deposit_request, opts = {}) ⇒ TransferLedgerDepositResponse

Deposit funds into a Plaid Ledger balance Use the ‘/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger.

Parameters:

Returns:



17558
17559
17560
17561
 
# File 'lib/plaid/api/plaid_api.rb', line 17558

def transfer_ledger_deposit(transfer_ledger_deposit_request, opts = {})
  data, _status_code, _headers = transfer_ledger_deposit_with_http_info(transfer_ledger_deposit_request, opts)
  data
end

#transfer_ledger_deposit_with_http_info(transfer_ledger_deposit_request, opts = {}) ⇒ Array<(TransferLedgerDepositResponse, Integer, Hash)>

Deposit funds into a Plaid Ledger balance Use the &#x60;/transfer/ledger/deposit&#x60; endpoint to deposit funds into Plaid Ledger.

Parameters:

Returns:



17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
 
# File 'lib/plaid/api/plaid_api.rb', line 17568

def transfer_ledger_deposit_with_http_info(transfer_ledger_deposit_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_deposit ...'
  end
  # verify the required parameter 'transfer_ledger_deposit_request' is set
  if @api_client.config.client_side_validation && transfer_ledger_deposit_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_ledger_deposit_request' when calling PlaidApi.transfer_ledger_deposit"
  end
  # resource path
  local_var_path = '/transfer/ledger/deposit'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_deposit_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferLedgerDepositResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_ledger_deposit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_ledger_distribute(transfer_ledger_distribute_request, opts = {}) ⇒ TransferLedgerDistributeResponse

Move available balance between ledgers 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.

Parameters:

Returns:



17626
17627
17628
17629
 
# File 'lib/plaid/api/plaid_api.rb', line 17626

def transfer_ledger_distribute(transfer_ledger_distribute_request, opts = {})
  data, _status_code, _headers = transfer_ledger_distribute_with_http_info(transfer_ledger_distribute_request, opts)
  data
end

#transfer_ledger_distribute_with_http_info(transfer_ledger_distribute_request, opts = {}) ⇒ Array<(TransferLedgerDistributeResponse, Integer, Hash)>

Move available balance between ledgers Use the &#x60;/transfer/ledger/distribute&#x60; 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.

Parameters:

Returns:



17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
 
# File 'lib/plaid/api/plaid_api.rb', line 17636

def transfer_ledger_distribute_with_http_info(transfer_ledger_distribute_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_distribute ...'
  end
  # verify the required parameter 'transfer_ledger_distribute_request' is set
  if @api_client.config.client_side_validation && transfer_ledger_distribute_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_ledger_distribute_request' when calling PlaidApi.transfer_ledger_distribute"
  end
  # resource path
  local_var_path = '/transfer/ledger/distribute'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_distribute_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferLedgerDistributeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_ledger_distribute",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_distribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_ledger_event_list(transfer_ledger_event_list_request, opts = {}) ⇒ TransferLedgerEventListResponse

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

Parameters:

Returns:



17694
17695
17696
17697
 
# File 'lib/plaid/api/plaid_api.rb', line 17694

def transfer_ledger_event_list(transfer_ledger_event_list_request, opts = {})
  data, _status_code, _headers = transfer_ledger_event_list_with_http_info(transfer_ledger_event_list_request, opts)
  data
end

#transfer_ledger_event_list_with_http_info(transfer_ledger_event_list_request, opts = {}) ⇒ Array<(TransferLedgerEventListResponse, Integer, Hash)>

List transfer ledger events Use the &#x60;/transfer/ledger/event/list&#x60; endpoint to get a list of ledger events for a specific ledger based on specified filter criteria.

Parameters:

Returns:



17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
 
# File 'lib/plaid/api/plaid_api.rb', line 17704

def transfer_ledger_event_list_with_http_info(transfer_ledger_event_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_event_list ...'
  end
  # verify the required parameter 'transfer_ledger_event_list_request' is set
  if @api_client.config.client_side_validation && transfer_ledger_event_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_ledger_event_list_request' when calling PlaidApi.transfer_ledger_event_list"
  end
  # resource path
  local_var_path = '/transfer/ledger/event/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_event_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferLedgerEventListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_ledger_event_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_ledger_get(transfer_ledger_get_request, opts = {}) ⇒ TransferLedgerGetResponse

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

Parameters:

Returns:



17762
17763
17764
17765
 
# File 'lib/plaid/api/plaid_api.rb', line 17762

def transfer_ledger_get(transfer_ledger_get_request, opts = {})
  data, _status_code, _headers = transfer_ledger_get_with_http_info(transfer_ledger_get_request, opts)
  data
end

#transfer_ledger_get_with_http_info(transfer_ledger_get_request, opts = {}) ⇒ Array<(TransferLedgerGetResponse, Integer, Hash)>

Retrieve Plaid Ledger balance Use the &#x60;/transfer/ledger/get&#x60; endpoint to view a balance on the ledger held with Plaid.

Parameters:

Returns:

  • (Array<(TransferLedgerGetResponse, Integer, Hash)>) —

    TransferLedgerGetResponse data, response status code and response headers



17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
 
# File 'lib/plaid/api/plaid_api.rb', line 17772

def transfer_ledger_get_with_http_info(transfer_ledger_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_get ...'
  end
  # verify the required parameter 'transfer_ledger_get_request' is set
  if @api_client.config.client_side_validation && transfer_ledger_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_ledger_get_request' when calling PlaidApi.transfer_ledger_get"
  end
  # resource path
  local_var_path = '/transfer/ledger/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferLedgerGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_ledger_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_ledger_withdraw(transfer_ledger_withdraw_request, opts = {}) ⇒ TransferLedgerWithdrawResponse

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

Parameters:

Returns:



17830
17831
17832
17833
 
# File 'lib/plaid/api/plaid_api.rb', line 17830

def transfer_ledger_withdraw(transfer_ledger_withdraw_request, opts = {})
  data, _status_code, _headers = transfer_ledger_withdraw_with_http_info(transfer_ledger_withdraw_request, opts)
  data
end

#transfer_ledger_withdraw_with_http_info(transfer_ledger_withdraw_request, opts = {}) ⇒ Array<(TransferLedgerWithdrawResponse, Integer, Hash)>

Withdraw funds from a Plaid Ledger balance Use the &#x60;/transfer/ledger/withdraw&#x60; endpoint to withdraw funds from a Plaid Ledger balance.

Parameters:

Returns:



17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
 
# File 'lib/plaid/api/plaid_api.rb', line 17840

def transfer_ledger_withdraw_with_http_info(transfer_ledger_withdraw_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_withdraw ...'
  end
  # verify the required parameter 'transfer_ledger_withdraw_request' is set
  if @api_client.config.client_side_validation && transfer_ledger_withdraw_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_ledger_withdraw_request' when calling PlaidApi.transfer_ledger_withdraw"
  end
  # resource path
  local_var_path = '/transfer/ledger/withdraw'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_withdraw_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferLedgerWithdrawResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_ledger_withdraw",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_withdraw\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_list(transfer_list_request, opts = {}) ⇒ TransferListResponse

List transfers Use the ‘/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.

Parameters:

  • transfer_list_request (TransferListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



17898
17899
17900
17901
 
# File 'lib/plaid/api/plaid_api.rb', line 17898

def transfer_list(transfer_list_request, opts = {})
  data, _status_code, _headers = transfer_list_with_http_info(transfer_list_request, opts)
  data
end

#transfer_list_with_http_info(transfer_list_request, opts = {}) ⇒ Array<(TransferListResponse, Integer, Hash)>

List transfers Use the &#x60;/transfer/list&#x60; endpoint to see a list of all your transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired transfers.

Parameters:

  • transfer_list_request (TransferListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransferListResponse, Integer, Hash)>) —

    TransferListResponse data, response status code and response headers



17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
 
# File 'lib/plaid/api/plaid_api.rb', line 17908

def transfer_list_with_http_info(transfer_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_list ...'
  end
  # verify the required parameter 'transfer_list_request' is set
  if @api_client.config.client_side_validation && transfer_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_list_request' when calling PlaidApi.transfer_list"
  end
  # resource path
  local_var_path = '/transfer/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_metrics_get(transfer_metrics_get_request, opts = {}) ⇒ TransferMetricsGetResponse

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

Parameters:

Returns:



17966
17967
17968
17969
 
# File 'lib/plaid/api/plaid_api.rb', line 17966

def transfer_metrics_get(transfer_metrics_get_request, opts = {})
  data, _status_code, _headers = transfer_metrics_get_with_http_info(transfer_metrics_get_request, opts)
  data
end

#transfer_metrics_get_with_http_info(transfer_metrics_get_request, opts = {}) ⇒ Array<(TransferMetricsGetResponse, Integer, Hash)>

Get transfer product usage metrics Use the &#x60;/transfer/metrics/get&#x60; endpoint to view your transfer product usage metrics.

Parameters:

Returns:

  • (Array<(TransferMetricsGetResponse, Integer, Hash)>) —

    TransferMetricsGetResponse data, response status code and response headers



17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
 
# File 'lib/plaid/api/plaid_api.rb', line 17976

def transfer_metrics_get_with_http_info(transfer_metrics_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_metrics_get ...'
  end
  # verify the required parameter 'transfer_metrics_get_request' is set
  if @api_client.config.client_side_validation && transfer_metrics_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_metrics_get_request' when calling PlaidApi.transfer_metrics_get"
  end
  # resource path
  local_var_path = '/transfer/metrics/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_metrics_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferMetricsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_metrics_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_migrate_account(transfer_migrate_account_request, opts = {}) ⇒ TransferMigrateAccountResponse

Migrate account into Transfers 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).

Parameters:

Returns:



18034
18035
18036
18037
 
# File 'lib/plaid/api/plaid_api.rb', line 18034

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts = {}) ⇒ Array<(TransferMigrateAccountResponse, Integer, Hash)>

Migrate account into Transfers As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; 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 &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager or [Support](dashboard.plaid.com/support).

Parameters:

Returns:



18044
18045
18046
18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
 
# File 'lib/plaid/api/plaid_api.rb', line 18044

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_migrate_account ...'
  end
  # verify the required parameter 'transfer_migrate_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'transfer_migrate_account_request' when calling PlaidApi.transfer_migrate_account"
  end
  # resource path
  local_var_path = '/transfer/migrate_account'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'TransferMigrateAccountResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_migrate_account",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_originator_create(transfer_originator_create_request, opts = {}) ⇒ TransferOriginatorCreateResponse

Create a new originator Use the ‘/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`.

Parameters:

Returns:



18102
18103
18104
18105
 
# File 'lib/plaid/api/plaid_api.rb', line 18102

def transfer_originator_create(transfer_originator_create_request, opts = {})
  data, _status_code, _headers = transfer_originator_create_with_http_info(transfer_originator_create_request, opts)
  data
end

#transfer_originator_create_with_http_info(transfer_originator_create_request, opts = {}) ⇒ Array<(TransferOriginatorCreateResponse, Integer, Hash)>

Create a new originator Use the &#x60;/transfer/originator/create&#x60; endpoint to create a new originator and return an &#x60;originator_client_id&#x60;.

Parameters:

Returns:



18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
 
# File 'lib/plaid/api/plaid_api.rb', line 18112

def transfer_originator_create_with_http_info(transfer_originator_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_create ...'
  end
  # verify the required parameter 'transfer_originator_create_request' is set
  if @api_client.config.client_side_validation && transfer_originator_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_originator_create_request' when calling PlaidApi.transfer_originator_create"
  end
  # resource path
  local_var_path = '/transfer/originator/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferOriginatorCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_originator_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_originator_funding_account_create(transfer_originator_funding_account_create_request, opts = {}) ⇒ TransferOriginatorFundingAccountCreateResponse

Create a new funding account for an originator Use the ‘/transfer/originator/funding_account/create` endpoint to create a new funding account for the originator.

Parameters:

Returns:



18170
18171
18172
18173
 
# File 'lib/plaid/api/plaid_api.rb', line 18170

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#transfer_originator_funding_account_create_with_http_info(transfer_originator_funding_account_create_request, opts = {}) ⇒ Array<(TransferOriginatorFundingAccountCreateResponse, Integer, Hash)>

Create a new funding account for an originator Use the &#x60;/transfer/originator/funding_account/create&#x60; endpoint to create a new funding account for the originator.

Parameters:

Returns:



18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
 
# File 'lib/plaid/api/plaid_api.rb', line 18180

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_funding_account_create ...'
  end
  # verify the required parameter 'transfer_originator_funding_account_create_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'transfer_originator_funding_account_create_request' when calling PlaidApi.transfer_originator_funding_account_create"
  end
  # resource path
  local_var_path = '/transfer/originator/funding_account/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'TransferOriginatorFundingAccountCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_originator_funding_account_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_funding_account_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_originator_funding_account_update(transfer_originator_funding_account_update_request, opts = {}) ⇒ TransferOriginatorFundingAccountUpdateResponse

Update the funding account associated with the originator Use the ‘/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator.

Parameters:

Returns:



18238
18239
18240
18241
 
# File 'lib/plaid/api/plaid_api.rb', line 18238

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#transfer_originator_funding_account_update_with_http_info(transfer_originator_funding_account_update_request, opts = {}) ⇒ Array<(TransferOriginatorFundingAccountUpdateResponse, Integer, Hash)>

Update the funding account associated with the originator Use the &#x60;/transfer/originator/funding_account/update&#x60; endpoint to update the funding account associated with the originator.

Parameters:

Returns:



18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
 
# File 'lib/plaid/api/plaid_api.rb', line 18248

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_funding_account_update ...'
  end
  # verify the required parameter 'transfer_originator_funding_account_update_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'transfer_originator_funding_account_update_request' when calling PlaidApi.transfer_originator_funding_account_update"
  end
  # resource path
  local_var_path = '/transfer/originator/funding_account/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'TransferOriginatorFundingAccountUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_originator_funding_account_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_funding_account_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_originator_get(transfer_originator_get_request, opts = {}) ⇒ TransferOriginatorGetResponse

Get status of an originator’s onboarding The ‘/transfer/originator/get` endpoint gets status updates for an originator’s onboarding process. This information is also available via the Transfer page on the Plaid dashboard.

Parameters:

Returns:



18306
18307
18308
18309
 
# File 'lib/plaid/api/plaid_api.rb', line 18306

def transfer_originator_get(transfer_originator_get_request, opts = {})
  data, _status_code, _headers = transfer_originator_get_with_http_info(transfer_originator_get_request, opts)
  data
end

#transfer_originator_get_with_http_info(transfer_originator_get_request, opts = {}) ⇒ Array<(TransferOriginatorGetResponse, Integer, Hash)>

Get status of an originator&#39;s onboarding The &#x60;/transfer/originator/get&#x60; endpoint gets status updates for an originator&#39;s onboarding process. This information is also available via the Transfer page on the Plaid dashboard.

Parameters:

Returns:



18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
 
# File 'lib/plaid/api/plaid_api.rb', line 18316

def transfer_originator_get_with_http_info(transfer_originator_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_get ...'
  end
  # verify the required parameter 'transfer_originator_get_request' is set
  if @api_client.config.client_side_validation && transfer_originator_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_originator_get_request' when calling PlaidApi.transfer_originator_get"
  end
  # resource path
  local_var_path = '/transfer/originator/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'examples'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferOriginatorGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_originator_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_originator_list(transfer_originator_list_request, opts = {}) ⇒ TransferOriginatorListResponse

Get status of all originators’ onboarding The ‘/transfer/originator/list` endpoint gets status updates for all of your originators’ onboarding. This information is also available via the Plaid dashboard.

Parameters:

Returns:



18374
18375
18376
18377
 
# File 'lib/plaid/api/plaid_api.rb', line 18374

def transfer_originator_list(transfer_originator_list_request, opts = {})
  data, _status_code, _headers = transfer_originator_list_with_http_info(transfer_originator_list_request, opts)
  data
end

#transfer_originator_list_with_http_info(transfer_originator_list_request, opts = {}) ⇒ Array<(TransferOriginatorListResponse, Integer, Hash)>

Get status of all originators&#39; onboarding The &#x60;/transfer/originator/list&#x60; endpoint gets status updates for all of your originators&#39; onboarding. This information is also available via the Plaid dashboard.

Parameters:

Returns:



18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
 
# File 'lib/plaid/api/plaid_api.rb', line 18384

def transfer_originator_list_with_http_info(transfer_originator_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_list ...'
  end
  # verify the required parameter 'transfer_originator_list_request' is set
  if @api_client.config.client_side_validation && transfer_originator_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_originator_list_request' when calling PlaidApi.transfer_originator_list"
  end
  # resource path
  local_var_path = '/transfer/originator/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferOriginatorListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_originator_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_platform_originator_create(transfer_platform_originator_create_request, opts = {}) ⇒ TransferPlatformOriginatorCreateResponse

Create an originator for Transfer for Platforms customers 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.

Parameters:

Returns:



18442
18443
18444
18445
 
# File 'lib/plaid/api/plaid_api.rb', line 18442

def transfer_platform_originator_create(transfer_platform_originator_create_request, opts = {})
  data, _status_code, _headers = transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts)
  data
end

#transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts = {}) ⇒ Array<(TransferPlatformOriginatorCreateResponse, Integer, Hash)>

Create an originator for Transfer for Platforms customers Use the &#x60;/transfer/platform/originator/create&#x60; endpoint to submit information about the originator you are onboarding, including the originator&#39;s agreement to the required legal terms.

Parameters:

Returns:



18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
 
# File 'lib/plaid/api/plaid_api.rb', line 18452

def transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_originator_create ...'
  end
  # verify the required parameter 'transfer_platform_originator_create_request' is set
  if @api_client.config.client_side_validation && transfer_platform_originator_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_platform_originator_create_request' when calling PlaidApi.transfer_platform_originator_create"
  end
  # resource path
  local_var_path = '/transfer/platform/originator/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_originator_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferPlatformOriginatorCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_platform_originator_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_platform_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_platform_person_create(transfer_platform_person_create_request, opts = {}) ⇒ TransferPlatformPersonCreateResponse

Create a person associated with an originator 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.

Parameters:

Returns:



18510
18511
18512
18513
 
# File 'lib/plaid/api/plaid_api.rb', line 18510

def transfer_platform_person_create(transfer_platform_person_create_request, opts = {})
  data, _status_code, _headers = transfer_platform_person_create_with_http_info(transfer_platform_person_create_request, opts)
  data
end

#transfer_platform_person_create_with_http_info(transfer_platform_person_create_request, opts = {}) ⇒ Array<(TransferPlatformPersonCreateResponse, Integer, Hash)>

Create a person associated with an originator Use the &#x60;/transfer/platform/person/create&#x60; endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal identification information for them.

Parameters:

Returns:



18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
 
# File 'lib/plaid/api/plaid_api.rb', line 18520

def transfer_platform_person_create_with_http_info(transfer_platform_person_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_person_create ...'
  end
  # verify the required parameter 'transfer_platform_person_create_request' is set
  if @api_client.config.client_side_validation && transfer_platform_person_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_platform_person_create_request' when calling PlaidApi.transfer_platform_person_create"
  end
  # resource path
  local_var_path = '/transfer/platform/person/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_person_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferPlatformPersonCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_platform_person_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_platform_person_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_platform_requirement_submit(transfer_platform_requirement_submit_request, opts = {}) ⇒ TransferPlatformRequirementSubmitResponse

Submit additional onboarding information on behalf of an originator 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/1NEQkTD0sVK50iAQi6xHigrexDUxZ4QxXqSEfV_FFTiU/) for a list of requirement types and possible values.

Parameters:

Returns:



18578
18579
18580
18581
 
# File 'lib/plaid/api/plaid_api.rb', line 18578

def transfer_platform_requirement_submit(transfer_platform_requirement_submit_request, opts = {})
  data, _status_code, _headers = transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts)
  data
end

#transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts = {}) ⇒ Array<(TransferPlatformRequirementSubmitResponse, Integer, Hash)>

Submit additional onboarding information on behalf of an originator Use the &#x60;/transfer/platform/requirement/submit&#x60; 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/1NEQkTD0sVK50iAQi6xHigrexDUxZ4QxXqSEfV_FFTiU/) for a list of requirement types and possible values.

Parameters:

Returns:



18588
18589
18590
18591
18592
18593
18594
18595
18596
18597
18598
18599
18600
18601
18602
18603
18604
18605
18606
18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
 
# File 'lib/plaid/api/plaid_api.rb', line 18588

def transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_requirement_submit ...'
  end
  # verify the required parameter 'transfer_platform_requirement_submit_request' is set
  if @api_client.config.client_side_validation && transfer_platform_requirement_submit_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_platform_requirement_submit_request' when calling PlaidApi.transfer_platform_requirement_submit"
  end
  # resource path
  local_var_path = '/transfer/platform/requirement/submit'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_requirement_submit_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferPlatformRequirementSubmitResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_platform_requirement_submit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_platform_requirement_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_questionnaire_create(transfer_questionnaire_create_request, opts = {}) ⇒ TransferQuestionnaireCreateResponse

Generate a Plaid-hosted onboarding UI URL. The ‘/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.

Parameters:

Returns:



18646
18647
18648
18649
 
# File 'lib/plaid/api/plaid_api.rb', line 18646

def transfer_questionnaire_create(transfer_questionnaire_create_request, opts = {})
  data, _status_code, _headers = transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts)
  data
end

#transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts = {}) ⇒ Array<(TransferQuestionnaireCreateResponse, Integer, Hash)>

Generate a Plaid-hosted onboarding UI URL. The &#x60;/transfer/questionnaire/create&#x60; 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.

Parameters:

Returns:



18656
18657
18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
 
# File 'lib/plaid/api/plaid_api.rb', line 18656

def transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_questionnaire_create ...'
  end
  # verify the required parameter 'transfer_questionnaire_create_request' is set
  if @api_client.config.client_side_validation && transfer_questionnaire_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_questionnaire_create_request' when calling PlaidApi.transfer_questionnaire_create"
  end
  # resource path
  local_var_path = '/transfer/questionnaire/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_questionnaire_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferQuestionnaireCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_questionnaire_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_questionnaire_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_recurring_cancel(transfer_recurring_cancel_request, opts = {}) ⇒ TransferRecurringCancelResponse

Cancel a recurring transfer. Use the ‘/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn’t been submitted to bank will be cancelled.

Parameters:

Returns:



18714
18715
18716
18717
 
# File 'lib/plaid/api/plaid_api.rb', line 18714

def transfer_recurring_cancel(transfer_recurring_cancel_request, opts = {})
  data, _status_code, _headers = transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts)
  data
end

#transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts = {}) ⇒ Array<(TransferRecurringCancelResponse, Integer, Hash)>

Cancel a recurring transfer. Use the &#x60;/transfer/recurring/cancel&#x60; endpoint to cancel a recurring transfer. Scheduled transfer that hasn&#39;t been submitted to bank will be cancelled.

Parameters:

Returns:



18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
 
# File 'lib/plaid/api/plaid_api.rb', line 18724

def transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_cancel ...'
  end
  # verify the required parameter 'transfer_recurring_cancel_request' is set
  if @api_client.config.client_side_validation && transfer_recurring_cancel_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_recurring_cancel_request' when calling PlaidApi.transfer_recurring_cancel"
  end
  # resource path
  local_var_path = '/transfer/recurring/cancel'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_cancel_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRecurringCancelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_recurring_cancel",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_recurring_create(transfer_recurring_create_request, opts = {}) ⇒ TransferRecurringCreateResponse

Create a recurring transfer Use the ‘/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Transfer for Platforms (beta) customers.

Parameters:

Returns:



18782
18783
18784
18785
 
# File 'lib/plaid/api/plaid_api.rb', line 18782

def transfer_recurring_create(transfer_recurring_create_request, opts = {})
  data, _status_code, _headers = transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts)
  data
end

#transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts = {}) ⇒ Array<(TransferRecurringCreateResponse, Integer, Hash)>

Create a recurring transfer Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Transfer for Platforms (beta) customers.

Parameters:

Returns:



18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
18829
18830
18831
18832
18833
18834
18835
18836
18837
18838
18839
18840
18841
18842
18843
 
# File 'lib/plaid/api/plaid_api.rb', line 18792

def transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_create ...'
  end
  # verify the required parameter 'transfer_recurring_create_request' is set
  if @api_client.config.client_side_validation && transfer_recurring_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_recurring_create_request' when calling PlaidApi.transfer_recurring_create"
  end
  # resource path
  local_var_path = '/transfer/recurring/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRecurringCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_recurring_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_recurring_get(transfer_recurring_get_request, opts = {}) ⇒ TransferRecurringGetResponse

Retrieve a recurring transfer The ‘/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.

Parameters:

Returns:



18850
18851
18852
18853
 
# File 'lib/plaid/api/plaid_api.rb', line 18850

def transfer_recurring_get(transfer_recurring_get_request, opts = {})
  data, _status_code, _headers = transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts)
  data
end

#transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts = {}) ⇒ Array<(TransferRecurringGetResponse, Integer, Hash)>

Retrieve a recurring transfer The &#x60;/transfer/recurring/get&#x60; fetches information about the recurring transfer corresponding to the given &#x60;recurring_transfer_id&#x60;.

Parameters:

Returns:



18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
 
# File 'lib/plaid/api/plaid_api.rb', line 18860

def transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_get ...'
  end
  # verify the required parameter 'transfer_recurring_get_request' is set
  if @api_client.config.client_side_validation && transfer_recurring_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_recurring_get_request' when calling PlaidApi.transfer_recurring_get"
  end
  # resource path
  local_var_path = '/transfer/recurring/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRecurringGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_recurring_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_recurring_list(transfer_recurring_list_request, opts = {}) ⇒ TransferRecurringListResponse

List recurring transfers Use the ‘/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired recurring transfers.

Parameters:

Returns:



18918
18919
18920
18921
 
# File 'lib/plaid/api/plaid_api.rb', line 18918

def transfer_recurring_list(transfer_recurring_list_request, opts = {})
  data, _status_code, _headers = transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts)
  data
end

#transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts = {}) ⇒ Array<(TransferRecurringListResponse, Integer, Hash)>

List recurring transfers Use the &#x60;/transfer/recurring/list&#x60; endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired recurring transfers.

Parameters:

Returns:



18928
18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
 
# File 'lib/plaid/api/plaid_api.rb', line 18928

def transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_list ...'
  end
  # verify the required parameter 'transfer_recurring_list_request' is set
  if @api_client.config.client_side_validation && transfer_recurring_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_recurring_list_request' when calling PlaidApi.transfer_recurring_list"
  end
  # resource path
  local_var_path = '/transfer/recurring/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRecurringListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_recurring_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_refund_cancel(transfer_refund_cancel_request, opts = {}) ⇒ TransferRefundCancelResponse

Cancel a refund Use the ‘/transfer/refund/cancel` endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.

Parameters:

Returns:



18986
18987
18988
18989
 
# File 'lib/plaid/api/plaid_api.rb', line 18986

def transfer_refund_cancel(transfer_refund_cancel_request, opts = {})
  data, _status_code, _headers = transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts)
  data
end

#transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts = {}) ⇒ Array<(TransferRefundCancelResponse, Integer, Hash)>

Cancel a refund Use the &#x60;/transfer/refund/cancel&#x60; endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.

Parameters:

Returns:



18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
 
# File 'lib/plaid/api/plaid_api.rb', line 18996

def transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_cancel ...'
  end
  # verify the required parameter 'transfer_refund_cancel_request' is set
  if @api_client.config.client_side_validation && transfer_refund_cancel_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_refund_cancel_request' when calling PlaidApi.transfer_refund_cancel"
  end
  # resource path
  local_var_path = '/transfer/refund/cancel'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_cancel_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRefundCancelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_refund_cancel",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_refund_create(transfer_refund_create_request, opts = {}) ⇒ TransferRefundCreateResponse

Create a refund Use the ‘/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. 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.

Parameters:

Returns:



19054
19055
19056
19057
 
# File 'lib/plaid/api/plaid_api.rb', line 19054

def transfer_refund_create(transfer_refund_create_request, opts = {})
  data, _status_code, _headers = transfer_refund_create_with_http_info(transfer_refund_create_request, opts)
  data
end

#transfer_refund_create_with_http_info(transfer_refund_create_request, opts = {}) ⇒ Array<(TransferRefundCreateResponse, Integer, Hash)>

Create a refund Use the &#x60;/transfer/refund/create&#x60; 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&#39;s &#x60;access_token&#x60; is no longer valid (e.g. if the user revoked OAuth consent or the Item was deleted via &#x60;/item/remove&#x60;), 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.

Parameters:

Returns:



19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
 
# File 'lib/plaid/api/plaid_api.rb', line 19064

def transfer_refund_create_with_http_info(transfer_refund_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_create ...'
  end
  # verify the required parameter 'transfer_refund_create_request' is set
  if @api_client.config.client_side_validation && transfer_refund_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_refund_create_request' when calling PlaidApi.transfer_refund_create"
  end
  # resource path
  local_var_path = '/transfer/refund/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRefundCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_refund_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_refund_get(transfer_refund_get_request, opts = {}) ⇒ TransferRefundGetResponse

Retrieve a refund The ‘/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`.

Parameters:

Returns:



19122
19123
19124
19125
 
# File 'lib/plaid/api/plaid_api.rb', line 19122

def transfer_refund_get(transfer_refund_get_request, opts = {})
  data, _status_code, _headers = transfer_refund_get_with_http_info(transfer_refund_get_request, opts)
  data
end

#transfer_refund_get_with_http_info(transfer_refund_get_request, opts = {}) ⇒ Array<(TransferRefundGetResponse, Integer, Hash)>

Retrieve a refund The &#x60;/transfer/refund/get&#x60; endpoint fetches information about the refund corresponding to the given &#x60;refund_id&#x60;.

Parameters:

Returns:

  • (Array<(TransferRefundGetResponse, Integer, Hash)>) —

    TransferRefundGetResponse data, response status code and response headers



19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169
19170
19171
19172
19173
19174
19175
19176
19177
19178
19179
19180
19181
19182
19183
 
# File 'lib/plaid/api/plaid_api.rb', line 19132

def transfer_refund_get_with_http_info(transfer_refund_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_get ...'
  end
  # verify the required parameter 'transfer_refund_get_request' is set
  if @api_client.config.client_side_validation && transfer_refund_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_refund_get_request' when calling PlaidApi.transfer_refund_get"
  end
  # resource path
  local_var_path = '/transfer/refund/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRefundGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_refund_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_repayment_list(transfer_repayment_list_request, opts = {}) ⇒ TransferRepaymentListResponse

Lists historical repayments The ‘/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.

Parameters:

Returns:



19190
19191
19192
19193
 
# File 'lib/plaid/api/plaid_api.rb', line 19190

def transfer_repayment_list(transfer_repayment_list_request, opts = {})
  data, _status_code, _headers = transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts)
  data
end

#transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts = {}) ⇒ Array<(TransferRepaymentListResponse, Integer, Hash)>

Lists historical repayments The &#x60;/transfer/repayment/list&#x60; endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given &#x60;start_time&#x60;.

Parameters:

Returns:



19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230
19231
19232
19233
19234
19235
19236
19237
19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
19251
 
# File 'lib/plaid/api/plaid_api.rb', line 19200

def transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_repayment_list ...'
  end
  # verify the required parameter 'transfer_repayment_list_request' is set
  if @api_client.config.client_side_validation && transfer_repayment_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_repayment_list_request' when calling PlaidApi.transfer_repayment_list"
  end
  # resource path
  local_var_path = '/transfer/repayment/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_repayment_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRepaymentListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_repayment_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_repayment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_repayment_return_list(transfer_repayment_return_list_request, opts = {}) ⇒ TransferRepaymentReturnListResponse

List the returns included in a repayment The ‘/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.

Parameters:

Returns:



19258
19259
19260
19261
 
# File 'lib/plaid/api/plaid_api.rb', line 19258

def transfer_repayment_return_list(transfer_repayment_return_list_request, opts = {})
  data, _status_code, _headers = transfer_repayment_return_list_with_http_info(transfer_repayment_return_list_request, opts)
  data
end

#transfer_repayment_return_list_with_http_info(transfer_repayment_return_list_request, opts = {}) ⇒ Array<(TransferRepaymentReturnListResponse, Integer, Hash)>

List the returns included in a repayment The &#x60;/transfer/repayment/return/list&#x60; 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.

Parameters:

Returns:



19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298
19299
19300
19301
19302
19303
19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
 
# File 'lib/plaid/api/plaid_api.rb', line 19268

def transfer_repayment_return_list_with_http_info(transfer_repayment_return_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_repayment_return_list ...'
  end
  # verify the required parameter 'transfer_repayment_return_list_request' is set
  if @api_client.config.client_side_validation && transfer_repayment_return_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_repayment_return_list_request' when calling PlaidApi.transfer_repayment_return_list"
  end
  # resource path
  local_var_path = '/transfer/repayment/return/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_repayment_return_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferRepaymentReturnListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_repayment_return_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_repayment_return_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_sweep_get(transfer_sweep_get_request, opts = {}) ⇒ TransferSweepGetResponse

Retrieve a sweep The ‘/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.

Parameters:

Returns:



19326
19327
19328
19329
 
# File 'lib/plaid/api/plaid_api.rb', line 19326

def transfer_sweep_get(transfer_sweep_get_request, opts = {})
  data, _status_code, _headers = transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts)
  data
end

#transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts = {}) ⇒ Array<(TransferSweepGetResponse, Integer, Hash)>

Retrieve a sweep The &#x60;/transfer/sweep/get&#x60; endpoint fetches a sweep corresponding to the given &#x60;sweep_id&#x60;.

Parameters:

Returns:

  • (Array<(TransferSweepGetResponse, Integer, Hash)>) —

    TransferSweepGetResponse data, response status code and response headers



19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
 
# File 'lib/plaid/api/plaid_api.rb', line 19336

def transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_get ...'
  end
  # verify the required parameter 'transfer_sweep_get_request' is set
  if @api_client.config.client_side_validation && transfer_sweep_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_sweep_get_request' when calling PlaidApi.transfer_sweep_get"
  end
  # resource path
  local_var_path = '/transfer/sweep/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferSweepGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_sweep_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_sweep_list(transfer_sweep_list_request, opts = {}) ⇒ TransferSweepListResponse

List sweeps The ‘/transfer/sweep/list` endpoint fetches sweeps matching the given filters.

Parameters:

Returns:



19394
19395
19396
19397
 
# File 'lib/plaid/api/plaid_api.rb', line 19394

def transfer_sweep_list(transfer_sweep_list_request, opts = {})
  data, _status_code, _headers = transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts)
  data
end

#transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts = {}) ⇒ Array<(TransferSweepListResponse, Integer, Hash)>

List sweeps The &#x60;/transfer/sweep/list&#x60; endpoint fetches sweeps matching the given filters.

Parameters:

Returns:

  • (Array<(TransferSweepListResponse, Integer, Hash)>) —

    TransferSweepListResponse data, response status code and response headers



19404
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
 
# File 'lib/plaid/api/plaid_api.rb', line 19404

def transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_list ...'
  end
  # verify the required parameter 'transfer_sweep_list_request' is set
  if @api_client.config.client_side_validation && transfer_sweep_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'transfer_sweep_list_request' when calling PlaidApi.transfer_sweep_list"
  end
  # resource path
  local_var_path = '/transfer/sweep/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TransferSweepListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.transfer_sweep_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_account_session_event_send(user_account_session_event_send_request, opts = {}) ⇒ UserAccountSessionEventSendResponse

Send User Account Session Event This endpoint allows sending client-specific events related to Layer sessions for analytics and tracking purposes.

Parameters:

Returns:



19462
19463
19464
19465
 
# File 'lib/plaid/api/plaid_api.rb', line 19462

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#user_account_session_event_send_with_http_info(user_account_session_event_send_request, opts = {}) ⇒ Array<(UserAccountSessionEventSendResponse, Integer, Hash)>

Send User Account Session Event This endpoint allows sending client-specific events related to Layer sessions for analytics and tracking purposes.

Parameters:

Returns:



19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
 
# File 'lib/plaid/api/plaid_api.rb', line 19472

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_account_session_event_send ...'
  end
  # verify the required parameter 'user_account_session_event_send_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'user_account_session_event_send_request' when calling PlaidApi.user_account_session_event_send"
  end
  # resource path
  local_var_path = '/user_account/session/event/send'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'UserAccountSessionEventSendResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_account_session_event_send",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_account_session_event_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_account_session_get(user_account_session_get_request, opts = {}) ⇒ UserAccountSessionGetResponse

Retrieve User Account 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).

Parameters:

Returns:



19530
19531
19532
19533
 
# File 'lib/plaid/api/plaid_api.rb', line 19530

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#user_account_session_get_with_http_info(user_account_session_get_request, opts = {}) ⇒ Array<(UserAccountSessionGetResponse, Integer, Hash)>

Retrieve User Account 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).

Parameters:

Returns:



19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
 
# File 'lib/plaid/api/plaid_api.rb', line 19540

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_account_session_get ...'
  end
  # verify the required parameter 'user_account_session_get_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'user_account_session_get_request' when calling PlaidApi.user_account_session_get"
  end
  # resource path
  local_var_path = '/user_account/session/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'UserAccountSessionGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_account_session_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_account_session_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_create(user_create_request, opts = {}) ⇒ UserCreateResponse

Create user 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.

Parameters:

  • user_create_request (UserCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:



19599
19600
19601
19602
 
# File 'lib/plaid/api/plaid_api.rb', line 19599

def user_create(user_create_request, opts = {})
  data, _status_code, _headers = user_create_with_http_info(user_create_request, opts)
  data
end

#user_create_with_http_info(user_create_request, opts = {}) ⇒ Array<(UserCreateResponse, Integer, Hash)>

Create user For Plaid products and flows that use the user object, &#x60;/user/create&#x60; provides you a single token to access all data associated with the user. You must call this endpoint before calling &#x60;/link/token/create&#x60; 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 &#x60;/user/create&#x60; first; Plaid will resolve or create the user when &#x60;user.client_user_id&#x60; is provided in &#x60;/link/token/create&#x60;. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a &#x60;client_user_id&#x60; and an &#x60;identity&#x60; object and will return a &#x60;user_id&#x60;. For customers who began using it before that date, the endpoint takes a &#x60;client_user_id&#x60; and a &#x60;consumer_report_user_identity&#x60; object and will return a &#x60;user_token&#x60; and &#x60;user_id&#x60;. 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 &#x60;identity&#x60; (new) or &#x60;consumer_report_user_identity&#x60; (legacy) object must be present. If it is not provided during the &#x60;/user/create&#x60; call, it can be added later by calling &#x60;/user/update&#x60;. In order to generate a Plaid Check Consumer Report, the following &#x60;identity&#x60; fields, at minimum, are required and must be non-empty: &#x60;name&#x60;, &#x60;date_of_birth&#x60;, &#x60;emails&#x60;, &#x60;phone_numbers&#x60;, and &#x60;addresses&#x60;, (with at least one email, phone number, and address designated as &#x60;primary&#x60;). Plaid Check Consumer Reports can only be created for US-based users; the user&#39;s address country must be &#x60;US&#x60;. If creating a report for sharing with a GSE such as Fannie or Freddie, the user&#39;s full SSN must be provided via the &#x60;id_numbers&#x60; 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 &#x60;identity&#x60; 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.

Parameters:

  • user_create_request (UserCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:

  • (Array<(UserCreateResponse, Integer, Hash)>) —

    UserCreateResponse data, response status code and response headers



19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
19659
19660
19661
19662
 
# File 'lib/plaid/api/plaid_api.rb', line 19610

def user_create_with_http_info(user_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_create ...'
  end
  # verify the required parameter 'user_create_request' is set
  if @api_client.config.client_side_validation && user_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_create_request' when calling PlaidApi.user_create"
  end
  # resource path
  local_var_path = '/user/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Plaid-New-User-API-Enabled'] = opts[:'plaid_new_user_api_enabled'] if !opts[:'plaid_new_user_api_enabled'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_financial_data_refresh(user_financial_data_refresh_request, opts = {}) ⇒ UserFinancialDataRefreshResponse

Refresh user items for Financial-Insights bundle ‘/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.

Parameters:

Returns:



19669
19670
19671
19672
 
# File 'lib/plaid/api/plaid_api.rb', line 19669

def user_financial_data_refresh(user_financial_data_refresh_request, opts = {})
  data, _status_code, _headers = user_financial_data_refresh_with_http_info(user_financial_data_refresh_request, opts)
  data
end

#user_financial_data_refresh_with_http_info(user_financial_data_refresh_request, opts = {}) ⇒ Array<(UserFinancialDataRefreshResponse, Integer, Hash)>

Refresh user items for Financial-Insights bundle &#x60;/user/financial_data/refresh&#x60; 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 &#x60;results&#x60; array in the response to understand the outcome for each Item. This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/financial_data/refresh&#x60; to target all Items for a user instead.

Parameters:

Returns:



19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
 
# File 'lib/plaid/api/plaid_api.rb', line 19679

def user_financial_data_refresh_with_http_info(user_financial_data_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_financial_data_refresh ...'
  end
  # verify the required parameter 'user_financial_data_refresh_request' is set
  if @api_client.config.client_side_validation && user_financial_data_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_financial_data_refresh_request' when calling PlaidApi.user_financial_data_refresh"
  end
  # resource path
  local_var_path = '/user/financial_data/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_financial_data_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserFinancialDataRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_financial_data_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_financial_data_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get(user_get_request, opts = {}) ⇒ UserGetResponse

Retrieve user identity and information 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).

Parameters:

  • user_get_request (UserGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:



19738
19739
19740
19741
 
# File 'lib/plaid/api/plaid_api.rb', line 19738

def user_get(user_get_request, opts = {})
  data, _status_code, _headers = user_get_with_http_info(user_get_request, opts)
  data
end

#user_get_with_http_info(user_get_request, opts = {}) ⇒ Array<(UserGetResponse, Integer, Hash)>

Retrieve user identity and information Get user details using a &#x60;user_id&#x60;. This endpoint only supports users that were created on the new user API flow, without a &#x60;user_token&#x60;. For more details, see [New User APIs](plaid.com/docs/api/users/user-apis).

Parameters:

  • user_get_request (UserGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:

  • (Array<(UserGetResponse, Integer, Hash)>) —

    UserGetResponse data, response status code and response headers



19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
 
# File 'lib/plaid/api/plaid_api.rb', line 19749

def user_get_with_http_info(user_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_get ...'
  end
  # verify the required parameter 'user_get_request' is set
  if @api_client.config.client_side_validation && user_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_get_request' when calling PlaidApi.user_get"
  end
  # resource path
  local_var_path = '/user/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Plaid-New-User-API-Enabled'] = opts[:'plaid_new_user_api_enabled'] if !opts[:'plaid_new_user_api_enabled'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_identity_remove(user_identity_remove_request, opts = {}) ⇒ UserIdentityRemoveResponse

Remove user identity data 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.

Parameters:

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:



19809
19810
19811
19812
 
# File 'lib/plaid/api/plaid_api.rb', line 19809

def user_identity_remove(user_identity_remove_request, opts = {})
  data, _status_code, _headers = user_identity_remove_with_http_info(user_identity_remove_request, opts)
  data
end

#user_identity_remove_with_http_info(user_identity_remove_request, opts = {}) ⇒ Array<(UserIdentityRemoveResponse, Integer, Hash)>

Remove user identity data 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.

Parameters:

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:

  • (Array<(UserIdentityRemoveResponse, Integer, Hash)>) —

    UserIdentityRemoveResponse data, response status code and response headers



19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
 
# File 'lib/plaid/api/plaid_api.rb', line 19820

def user_identity_remove_with_http_info(user_identity_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_identity_remove ...'
  end
  # verify the required parameter 'user_identity_remove_request' is set
  if @api_client.config.client_side_validation && user_identity_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_identity_remove_request' when calling PlaidApi.user_identity_remove"
  end
  # resource path
  local_var_path = '/user/identity/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Plaid-New-User-API-Enabled'] = opts[:'plaid_new_user_api_enabled'] if !opts[:'plaid_new_user_api_enabled'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_identity_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserIdentityRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_identity_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_identity_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_items_associate(user_items_associate_request, opts = {}) ⇒ UserItemsAssociateResponse

Associate Items to a User 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.

Parameters:

Returns:



19879
19880
19881
19882
 
# File 'lib/plaid/api/plaid_api.rb', line 19879

def user_items_associate(user_items_associate_request, opts = {})
  data, _status_code, _headers = user_items_associate_with_http_info(user_items_associate_request, opts)
  data
end

#user_items_associate_with_http_info(user_items_associate_request, opts = {}) ⇒ Array<(UserItemsAssociateResponse, Integer, Hash)>

Associate Items to a User 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.

Parameters:

Returns:

  • (Array<(UserItemsAssociateResponse, Integer, Hash)>) —

    UserItemsAssociateResponse data, response status code and response headers



19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
19899
19900
19901
19902
19903
19904
19905
19906
19907
19908
19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
19928
19929
19930
19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
 
# File 'lib/plaid/api/plaid_api.rb', line 19889

def user_items_associate_with_http_info(user_items_associate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_items_associate ...'
  end
  # verify the required parameter 'user_items_associate_request' is set
  if @api_client.config.client_side_validation && user_items_associate_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_items_associate_request' when calling PlaidApi.user_items_associate"
  end
  # resource path
  local_var_path = '/user/items/associate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_items_associate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserItemsAssociateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_items_associate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_items_associate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_items_get(user_items_get_request, opts = {}) ⇒ UserItemsGetResponse

Get Items associated with a User 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`.

Parameters:

  • user_items_get_request (UserItemsGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



19947
19948
19949
19950
 
# File 'lib/plaid/api/plaid_api.rb', line 19947

def user_items_get(user_items_get_request, opts = {})
  data, _status_code, _headers = user_items_get_with_http_info(user_items_get_request, opts)
  data
end

#user_items_get_with_http_info(user_items_get_request, opts = {}) ⇒ Array<(UserItemsGetResponse, Integer, Hash)>

Get Items associated with a User Returns Items associated with a &#x60;user_id&#x60;, 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 &#x60;user_id&#x60;.

Parameters:

  • user_items_get_request (UserItemsGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UserItemsGetResponse, Integer, Hash)>) —

    UserItemsGetResponse data, response status code and response headers



19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
20007
20008
 
# File 'lib/plaid/api/plaid_api.rb', line 19957

def user_items_get_with_http_info(user_items_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_items_get ...'
  end
  # verify the required parameter 'user_items_get_request' is set
  if @api_client.config.client_side_validation && user_items_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_items_get_request' when calling PlaidApi.user_items_get"
  end
  # resource path
  local_var_path = '/user/items/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_items_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserItemsGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_items_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_items_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_items_remove(user_items_remove_request, opts = {}) ⇒ UserItemsRemoveResponse

Remove Items from a User 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.

Parameters:

  • user_items_remove_request (UserItemsRemoveRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



20015
20016
20017
20018
 
# File 'lib/plaid/api/plaid_api.rb', line 20015

def user_items_remove(user_items_remove_request, opts = {})
  data, _status_code, _headers = user_items_remove_with_http_info(user_items_remove_request, opts)
  data
end

#user_items_remove_with_http_info(user_items_remove_request, opts = {}) ⇒ Array<(UserItemsRemoveResponse, Integer, Hash)>

Remove Items from a User Removes specific Items associated with a user. It is equivalent to calling &#x60;/item/remove&#x60; 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 &#x60;/item/remove&#x60;, this deletes Item product data, terminates billing on the Item&#39;s products, and fires webhooks to the financial institution. Once removed, Items cannot be reconnected without going through Link again.

Parameters:

  • user_items_remove_request (UserItemsRemoveRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UserItemsRemoveResponse, Integer, Hash)>) —

    UserItemsRemoveResponse data, response status code and response headers



20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
20057
20058
20059
20060
20061
20062
20063
20064
20065
20066
20067
20068
20069
20070
20071
20072
20073
20074
20075
20076
 
# File 'lib/plaid/api/plaid_api.rb', line 20025

def user_items_remove_with_http_info(user_items_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_items_remove ...'
  end
  # verify the required parameter 'user_items_remove_request' is set
  if @api_client.config.client_side_validation && user_items_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_items_remove_request' when calling PlaidApi.user_items_remove"
  end
  # resource path
  local_var_path = '/user/items/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_items_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserItemsRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_items_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_items_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_products_terminate(user_products_terminate_request, opts = {}) ⇒ UserProductsTerminateResponse

Terminate user-based products ‘/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.

Parameters:

Returns:



20083
20084
20085
20086
 
# File 'lib/plaid/api/plaid_api.rb', line 20083

def user_products_terminate(user_products_terminate_request, opts = {})
  data, _status_code, _headers = user_products_terminate_with_http_info(user_products_terminate_request, opts)
  data
end

#user_products_terminate_with_http_info(user_products_terminate_request, opts = {}) ⇒ Array<(UserProductsTerminateResponse, Integer, Hash)>

Terminate user-based products &#x60;/user/products/terminate&#x60; 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.

Parameters:

Returns:



20093
20094
20095
20096
20097
20098
20099
20100
20101
20102
20103
20104
20105
20106
20107
20108
20109
20110
20111
20112
20113
20114
20115
20116
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
20135
20136
20137
20138
20139
20140
20141
20142
20143
20144
 
# File 'lib/plaid/api/plaid_api.rb', line 20093

def user_products_terminate_with_http_info(user_products_terminate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_products_terminate ...'
  end
  # verify the required parameter 'user_products_terminate_request' is set
  if @api_client.config.client_side_validation && user_products_terminate_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_products_terminate_request' when calling PlaidApi.user_products_terminate"
  end
  # resource path
  local_var_path = '/user/products/terminate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_products_terminate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserProductsTerminateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_products_terminate",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_products_terminate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_remove(user_remove_request, opts = {}) ⇒ UserRemoveResponse

Remove user ‘/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user.

Parameters:

  • user_remove_request (UserRemoveRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:



20152
20153
20154
20155
 
# File 'lib/plaid/api/plaid_api.rb', line 20152

def user_remove(user_remove_request, opts = {})
  data, _status_code, _headers = user_remove_with_http_info(user_remove_request, opts)
  data
end

#user_remove_with_http_info(user_remove_request, opts = {}) ⇒ Array<(UserRemoveResponse, Integer, Hash)>

Remove user &#x60;/user/remove&#x60; deletes a &#x60;user_id&#x60; or &#x60;user_token&#x60; and and associated information, including any Items associated with the user.

Parameters:

  • user_remove_request (UserRemoveRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:

  • (Array<(UserRemoveResponse, Integer, Hash)>) —

    UserRemoveResponse data, response status code and response headers



20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
20176
20177
20178
20179
20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
20213
20214
20215
 
# File 'lib/plaid/api/plaid_api.rb', line 20163

def user_remove_with_http_info(user_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_remove ...'
  end
  # verify the required parameter 'user_remove_request' is set
  if @api_client.config.client_side_validation && user_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_remove_request' when calling PlaidApi.user_remove"
  end
  # resource path
  local_var_path = '/user/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Plaid-New-User-API-Enabled'] = opts[:'plaid_new_user_api_enabled'] if !opts[:'plaid_new_user_api_enabled'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_third_party_token_create(user_third_party_token_create_request, opts = {}) ⇒ UserThirdPartyTokenCreateResponse

Create a third-party user token 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`.

Parameters:

Returns:



20222
20223
20224
20225
 
# File 'lib/plaid/api/plaid_api.rb', line 20222

def user_third_party_token_create(user_third_party_token_create_request, opts = {})
  data, _status_code, _headers = user_third_party_token_create_with_http_info(user_third_party_token_create_request, opts)
  data
end

#user_third_party_token_create_with_http_info(user_third_party_token_create_request, opts = {}) ⇒ Array<(UserThirdPartyTokenCreateResponse, Integer, Hash)>

Create a third-party user token 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 &#x60;third_party_user_token&#x60; along with the &#x60;user_token&#x60; and &#x60;third_party_client_id&#x60;, as it is not possible to retrieve a previously created &#x60;third_party_user_token&#x60;.

Parameters:

Returns:



20232
20233
20234
20235
20236
20237
20238
20239
20240
20241
20242
20243
20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/plaid/api/plaid_api.rb', line 20232

def user_third_party_token_create_with_http_info(user_third_party_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_third_party_token_create ...'
  end
  # verify the required parameter 'user_third_party_token_create_request' is set
  if @api_client.config.client_side_validation && user_third_party_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_third_party_token_create_request' when calling PlaidApi.user_third_party_token_create"
  end
  # resource path
  local_var_path = '/user/third_party_token/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_third_party_token_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserThirdPartyTokenCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_third_party_token_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_third_party_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_third_party_token_remove(user_third_party_token_remove_request, opts = {}) ⇒ UserThirdPartyTokenRemoveResponse

Remove a third-party user token 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.

Parameters:

Returns:



20290
20291
20292
20293
 
# File 'lib/plaid/api/plaid_api.rb', line 20290

def user_third_party_token_remove(user_third_party_token_remove_request, opts = {})
  data, _status_code, _headers = user_third_party_token_remove_with_http_info(user_third_party_token_remove_request, opts)
  data
end

#user_third_party_token_remove_with_http_info(user_third_party_token_remove_request, opts = {}) ⇒ Array<(UserThirdPartyTokenRemoveResponse, Integer, Hash)>

Remove a third-party user token 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.

Parameters:

Returns:



20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
20310
20311
20312
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
 
# File 'lib/plaid/api/plaid_api.rb', line 20300

def user_third_party_token_remove_with_http_info(user_third_party_token_remove_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_third_party_token_remove ...'
  end
  # verify the required parameter 'user_third_party_token_remove_request' is set
  if @api_client.config.client_side_validation && user_third_party_token_remove_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_third_party_token_remove_request' when calling PlaidApi.user_third_party_token_remove"
  end
  # resource path
  local_var_path = '/user/third_party_token/remove'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_third_party_token_remove_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserThirdPartyTokenRemoveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_third_party_token_remove",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_third_party_token_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_transactions_refresh(user_transactions_refresh_request, opts = {}) ⇒ UserTransactionsRefreshResponse

Refresh user items for Transactions bundle ‘/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.

Parameters:

Returns:



20358
20359
20360
20361
 
# File 'lib/plaid/api/plaid_api.rb', line 20358

def user_transactions_refresh(user_transactions_refresh_request, opts = {})
  data, _status_code, _headers = user_transactions_refresh_with_http_info(user_transactions_refresh_request, opts)
  data
end

#user_transactions_refresh_with_http_info(user_transactions_refresh_request, opts = {}) ⇒ Array<(UserTransactionsRefreshResponse, Integer, Hash)>

Refresh user items for Transactions bundle &#x60;/user/transactions/refresh&#x60; 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 &#x60;results&#x60; array in the response to understand the outcome for each Item. This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/transactions/refresh&#x60; to target all Items for a user instead.

Parameters:

Returns:



20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
20396
20397
20398
20399
20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
20415
20416
20417
20418
20419
 
# File 'lib/plaid/api/plaid_api.rb', line 20368

def user_transactions_refresh_with_http_info(user_transactions_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_transactions_refresh ...'
  end
  # verify the required parameter 'user_transactions_refresh_request' is set
  if @api_client.config.client_side_validation && user_transactions_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_transactions_refresh_request' when calling PlaidApi.user_transactions_refresh"
  end
  # resource path
  local_var_path = '/user/transactions/refresh'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_transactions_refresh_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserTransactionsRefreshResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_transactions_refresh",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_update(user_update_request, opts = {}) ⇒ UserUpdateResponse

Update user information 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.

Parameters:

  • user_update_request (UserUpdateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:



20427
20428
20429
20430
 
# File 'lib/plaid/api/plaid_api.rb', line 20427

def user_update(user_update_request, opts = {})
  data, _status_code, _headers = user_update_with_http_info(user_update_request, opts)
  data
end

#user_update_with_http_info(user_update_request, opts = {}) ⇒ Array<(UserUpdateResponse, Integer, Hash)>

Update user information This endpoint updates user information for an existing &#x60;user_id&#x60; or &#x60;user_token&#x60;. If an existing &#x60;user_id&#x60; or &#x60;user_token&#x60; is missing fields required for a given use case (e.g. creating a Consumer Report) use &#x60;/user/update&#x60; to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged.

Parameters:

  • user_update_request (UserUpdateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :plaid_new_user_api_enabled (Boolean) —

    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. (default to false)

Returns:

  • (Array<(UserUpdateResponse, Integer, Hash)>) —

    UserUpdateResponse data, response status code and response headers



20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
 
# File 'lib/plaid/api/plaid_api.rb', line 20438

def user_update_with_http_info(user_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.user_update ...'
  end
  # verify the required parameter 'user_update_request' is set
  if @api_client.config.client_side_validation && user_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_update_request' when calling PlaidApi.user_update"
  end
  # resource path
  local_var_path = '/user/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Plaid-New-User-API-Enabled'] = opts[:'plaid_new_user_api_enabled'] if !opts[:'plaid_new_user_api_enabled'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(user_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UserUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.user_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#user_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#wallet_create(wallet_create_request, opts = {}) ⇒ WalletCreateResponse

Create an e-wallet Create an e-wallet. The response is the newly created e-wallet object.

Parameters:

  • wallet_create_request (WalletCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



20497
20498
20499
20500
 
# File 'lib/plaid/api/plaid_api.rb', line 20497

def wallet_create(wallet_create_request, opts = {})
  data, _status_code, _headers = wallet_create_with_http_info(wallet_create_request, opts)
  data
end

#wallet_create_with_http_info(wallet_create_request, opts = {}) ⇒ Array<(WalletCreateResponse, Integer, Hash)>

Create an e-wallet Create an e-wallet. The response is the newly created e-wallet object.

Parameters:

  • wallet_create_request (WalletCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WalletCreateResponse, Integer, Hash)>) —

    WalletCreateResponse data, response status code and response headers



20507
20508
20509
20510
20511
20512
20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
20524
20525
20526
20527
20528
20529
20530
20531
20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
20556
20557
20558
 
# File 'lib/plaid/api/plaid_api.rb', line 20507

def wallet_create_with_http_info(wallet_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_create ...'
  end
  # verify the required parameter 'wallet_create_request' is set
  if @api_client.config.client_side_validation && wallet_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_create_request' when calling PlaidApi.wallet_create"
  end
  # resource path
  local_var_path = '/wallet/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WalletCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.wallet_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#wallet_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#wallet_get(wallet_get_request, opts = {}) ⇒ WalletGetResponse

Fetch an e-wallet Fetch an e-wallet. The response includes the current balance.

Parameters:

  • wallet_get_request (WalletGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



20565
20566
20567
20568
 
# File 'lib/plaid/api/plaid_api.rb', line 20565

def wallet_get(wallet_get_request, opts = {})
  data, _status_code, _headers = wallet_get_with_http_info(wallet_get_request, opts)
  data
end

#wallet_get_with_http_info(wallet_get_request, opts = {}) ⇒ Array<(WalletGetResponse, Integer, Hash)>

Fetch an e-wallet Fetch an e-wallet. The response includes the current balance.

Parameters:

  • wallet_get_request (WalletGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WalletGetResponse, Integer, Hash)>) —

    WalletGetResponse data, response status code and response headers



20575
20576
20577
20578
20579
20580
20581
20582
20583
20584
20585
20586
20587
20588
20589
20590
20591
20592
20593
20594
20595
20596
20597
20598
20599
20600
20601
20602
20603
20604
20605
20606
20607
20608
20609
20610
20611
20612
20613
20614
20615
20616
20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
 
# File 'lib/plaid/api/plaid_api.rb', line 20575

def wallet_get_with_http_info(wallet_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_get ...'
  end
  # verify the required parameter 'wallet_get_request' is set
  if @api_client.config.client_side_validation && wallet_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_get_request' when calling PlaidApi.wallet_get"
  end
  # resource path
  local_var_path = '/wallet/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WalletGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.wallet_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#wallet_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#wallet_list(wallet_list_request, opts = {}) ⇒ WalletListResponse

Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation.

Parameters:

  • wallet_list_request (WalletListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



20633
20634
20635
20636
 
# File 'lib/plaid/api/plaid_api.rb', line 20633

def wallet_list(wallet_list_request, opts = {})
  data, _status_code, _headers = wallet_list_with_http_info(wallet_list_request, opts)
  data
end

#wallet_list_with_http_info(wallet_list_request, opts = {}) ⇒ Array<(WalletListResponse, Integer, Hash)>

Fetch a list of e-wallets This endpoint lists all e-wallets in descending order of creation.

Parameters:

  • wallet_list_request (WalletListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WalletListResponse, Integer, Hash)>) —

    WalletListResponse data, response status code and response headers



20643
20644
20645
20646
20647
20648
20649
20650
20651
20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
20694
 
# File 'lib/plaid/api/plaid_api.rb', line 20643

def wallet_list_with_http_info(wallet_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_list ...'
  end
  # verify the required parameter 'wallet_list_request' is set
  if @api_client.config.client_side_validation && wallet_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_list_request' when calling PlaidApi.wallet_list"
  end
  # resource path
  local_var_path = '/wallet/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WalletListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.wallet_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#wallet_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#wallet_transaction_execute(wallet_transaction_execute_request, opts = {}) ⇒ WalletTransactionExecuteResponse

Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.

Parameters:

Returns:



20701
20702
20703
20704
 
# File 'lib/plaid/api/plaid_api.rb', line 20701

def wallet_transaction_execute(wallet_transaction_execute_request, opts = {})
  data, _status_code, _headers = wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts)
  data
end

#wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts = {}) ⇒ Array<(WalletTransactionExecuteResponse, Integer, Hash)>

Execute a transaction using an e-wallet Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.

Parameters:

Returns:



20711
20712
20713
20714
20715
20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
20761
20762
 
# File 'lib/plaid/api/plaid_api.rb', line 20711

def wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_execute ...'
  end
  # verify the required parameter 'wallet_transaction_execute_request' is set
  if @api_client.config.client_side_validation && wallet_transaction_execute_request.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_transaction_execute_request' when calling PlaidApi.wallet_transaction_execute"
  end
  # resource path
  local_var_path = '/wallet/transaction/execute'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_execute_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WalletTransactionExecuteResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.wallet_transaction_execute",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#wallet_transaction_get(wallet_transaction_get_request, opts = {}) ⇒ WalletTransactionGetResponse

Fetch an e-wallet transaction Fetch a specific e-wallet transaction

Parameters:

Returns:



20769
20770
20771
20772
 
# File 'lib/plaid/api/plaid_api.rb', line 20769

def wallet_transaction_get(wallet_transaction_get_request, opts = {})
  data, _status_code, _headers = wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts)
  data
end

#wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts = {}) ⇒ Array<(WalletTransactionGetResponse, Integer, Hash)>

Fetch an e-wallet transaction Fetch a specific e-wallet transaction

Parameters:

Returns:



20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
20790
20791
20792
20793
20794
20795
20796
20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
20812
20813
20814
20815
20816
20817
20818
20819
20820
20821
20822
20823
20824
20825
20826
20827
20828
20829
20830
 
# File 'lib/plaid/api/plaid_api.rb', line 20779

def wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_get ...'
  end
  # verify the required parameter 'wallet_transaction_get_request' is set
  if @api_client.config.client_side_validation && wallet_transaction_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_transaction_get_request' when calling PlaidApi.wallet_transaction_get"
  end
  # resource path
  local_var_path = '/wallet/transaction/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WalletTransactionGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.wallet_transaction_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#wallet_transaction_list(wallet_transaction_list_request, opts = {}) ⇒ WalletTransactionListResponse

List e-wallet transactions This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the ‘created_at` time.

Parameters:

Returns:



20837
20838
20839
20840
 
# File 'lib/plaid/api/plaid_api.rb', line 20837

def wallet_transaction_list(wallet_transaction_list_request, opts = {})
  data, _status_code, _headers = wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts)
  data
end

#wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts = {}) ⇒ Array<(WalletTransactionListResponse, Integer, Hash)>

List e-wallet transactions This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.

Parameters:

Returns:



20847
20848
20849
20850
20851
20852
20853
20854
20855
20856
20857
20858
20859
20860
20861
20862
20863
20864
20865
20866
20867
20868
20869
20870
20871
20872
20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
 
# File 'lib/plaid/api/plaid_api.rb', line 20847

def wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_list ...'
  end
  # verify the required parameter 'wallet_transaction_list_request' is set
  if @api_client.config.client_side_validation && wallet_transaction_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_transaction_list_request' when calling PlaidApi.wallet_transaction_list"
  end
  # resource path
  local_var_path = '/wallet/transaction/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.wallet_transaction_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_create(watchlist_screening_entity_create_request, opts = {}) ⇒ WatchlistScreeningEntityCreateResponse

Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.

Parameters:

Returns:



20905
20906
20907
20908
 
# File 'lib/plaid/api/plaid_api.rb', line 20905

def watchlist_screening_entity_create(watchlist_screening_entity_create_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_create_with_http_info(watchlist_screening_entity_create_request, opts)
  data
end

#watchlist_screening_entity_create_with_http_info(watchlist_screening_entity_create_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityCreateResponse, Integer, Hash)>

Create a watchlist screening for an entity Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.

Parameters:

Returns:



20915
20916
20917
20918
20919
20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
 
# File 'lib/plaid/api/plaid_api.rb', line 20915

def watchlist_screening_entity_create_with_http_info(watchlist_screening_entity_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_create ...'
  end
  # verify the required parameter 'watchlist_screening_entity_create_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_create_request' when calling PlaidApi.watchlist_screening_entity_create"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_get(watchlist_screening_entity_get_request, opts = {}) ⇒ WatchlistScreeningEntityGetResponse

Get an entity screening Retrieve an entity watchlist screening.

Parameters:

Returns:



20973
20974
20975
20976
 
# File 'lib/plaid/api/plaid_api.rb', line 20973

def watchlist_screening_entity_get(watchlist_screening_entity_get_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_get_with_http_info(watchlist_screening_entity_get_request, opts)
  data
end

#watchlist_screening_entity_get_with_http_info(watchlist_screening_entity_get_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityGetResponse, Integer, Hash)>

Get an entity screening Retrieve an entity watchlist screening.

Parameters:

Returns:



20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
 
# File 'lib/plaid/api/plaid_api.rb', line 20983

def watchlist_screening_entity_get_with_http_info(watchlist_screening_entity_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_get ...'
  end
  # verify the required parameter 'watchlist_screening_entity_get_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_get_request' when calling PlaidApi.watchlist_screening_entity_get"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_history_list(watchlist_screening_entity_history_list_request, opts = {}) ⇒ WatchlistScreeningEntityHistoryListResponse

List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

Parameters:

Returns:



21041
21042
21043
21044
 
# File 'lib/plaid/api/plaid_api.rb', line 21041

def watchlist_screening_entity_history_list(watchlist_screening_entity_history_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_history_list_with_http_info(watchlist_screening_entity_history_list_request, opts)
  data
end

#watchlist_screening_entity_history_list_with_http_info(watchlist_screening_entity_history_list_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityHistoryListResponse, Integer, Hash)>

List history for entity watchlist screenings List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

Parameters:

Returns:



21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
21090
21091
21092
21093
21094
21095
21096
21097
21098
21099
21100
21101
21102
 
# File 'lib/plaid/api/plaid_api.rb', line 21051

def watchlist_screening_entity_history_list_with_http_info(watchlist_screening_entity_history_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_history_list ...'
  end
  # verify the required parameter 'watchlist_screening_entity_history_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_history_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_history_list_request' when calling PlaidApi.watchlist_screening_entity_history_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/history/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_history_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityHistoryListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_history_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_history_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_hit_list(watchlist_screening_entity_hit_list_request, opts = {}) ⇒ WatchlistScreeningEntityHitListResponse

List hits for entity watchlist screenings List all hits for the entity watchlist screening.

Parameters:

Returns:



21109
21110
21111
21112
 
# File 'lib/plaid/api/plaid_api.rb', line 21109

def watchlist_screening_entity_hit_list(watchlist_screening_entity_hit_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_hit_list_with_http_info(watchlist_screening_entity_hit_list_request, opts)
  data
end

#watchlist_screening_entity_hit_list_with_http_info(watchlist_screening_entity_hit_list_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityHitListResponse, Integer, Hash)>

List hits for entity watchlist screenings List all hits for the entity watchlist screening.

Parameters:

Returns:



21119
21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
21168
21169
21170
 
# File 'lib/plaid/api/plaid_api.rb', line 21119

def watchlist_screening_entity_hit_list_with_http_info(watchlist_screening_entity_hit_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_hit_list ...'
  end
  # verify the required parameter 'watchlist_screening_entity_hit_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_hit_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_hit_list_request' when calling PlaidApi.watchlist_screening_entity_hit_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/hit/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_hit_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityHitListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_hit_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_hit_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_list(watchlist_screening_entity_list_request, opts = {}) ⇒ WatchlistScreeningEntityListResponse

List entity watchlist screenings List all entity screenings.

Parameters:

Returns:



21177
21178
21179
21180
 
# File 'lib/plaid/api/plaid_api.rb', line 21177

def watchlist_screening_entity_list(watchlist_screening_entity_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_list_with_http_info(watchlist_screening_entity_list_request, opts)
  data
end

#watchlist_screening_entity_list_with_http_info(watchlist_screening_entity_list_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityListResponse, Integer, Hash)>

List entity watchlist screenings List all entity screenings.

Parameters:

Returns:



21187
21188
21189
21190
21191
21192
21193
21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
21206
21207
21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
 
# File 'lib/plaid/api/plaid_api.rb', line 21187

def watchlist_screening_entity_list_with_http_info(watchlist_screening_entity_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_list ...'
  end
  # verify the required parameter 'watchlist_screening_entity_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_list_request' when calling PlaidApi.watchlist_screening_entity_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_program_get(watchlist_screening_entity_program_get_request, opts = {}) ⇒ WatchlistScreeningEntityProgramGetResponse

Get entity watchlist screening program Get an entity watchlist screening program

Parameters:

Returns:



21245
21246
21247
21248
 
# File 'lib/plaid/api/plaid_api.rb', line 21245

def watchlist_screening_entity_program_get(watchlist_screening_entity_program_get_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_program_get_with_http_info(watchlist_screening_entity_program_get_request, opts)
  data
end

#watchlist_screening_entity_program_get_with_http_info(watchlist_screening_entity_program_get_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityProgramGetResponse, Integer, Hash)>

Get entity watchlist screening program Get an entity watchlist screening program

Parameters:

Returns:



21255
21256
21257
21258
21259
21260
21261
21262
21263
21264
21265
21266
21267
21268
21269
21270
21271
21272
21273
21274
21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
21304
21305
21306
 
# File 'lib/plaid/api/plaid_api.rb', line 21255

def watchlist_screening_entity_program_get_with_http_info(watchlist_screening_entity_program_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_get ...'
  end
  # verify the required parameter 'watchlist_screening_entity_program_get_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_program_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_program_get_request' when calling PlaidApi.watchlist_screening_entity_program_get"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/program/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_program_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityProgramGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_program_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_program_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_program_list(watchlist_screening_entity_program_list_request, opts = {}) ⇒ WatchlistScreeningEntityProgramListResponse

List entity watchlist screening programs List all entity watchlist screening programs

Parameters:

Returns:



21313
21314
21315
21316
 
# File 'lib/plaid/api/plaid_api.rb', line 21313

def watchlist_screening_entity_program_list(watchlist_screening_entity_program_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_program_list_with_http_info(watchlist_screening_entity_program_list_request, opts)
  data
end

#watchlist_screening_entity_program_list_with_http_info(watchlist_screening_entity_program_list_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityProgramListResponse, Integer, Hash)>

List entity watchlist screening programs List all entity watchlist screening programs

Parameters:

Returns:



21323
21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
21361
21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
21372
21373
21374
 
# File 'lib/plaid/api/plaid_api.rb', line 21323

def watchlist_screening_entity_program_list_with_http_info(watchlist_screening_entity_program_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_list ...'
  end
  # verify the required parameter 'watchlist_screening_entity_program_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_program_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_program_list_request' when calling PlaidApi.watchlist_screening_entity_program_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/program/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_program_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityProgramListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_program_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_program_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_review_create(watchlist_screening_entity_review_create_request, opts = {}) ⇒ WatchlistScreeningEntityReviewCreateResponse

Create a review for an entity watchlist screening Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

Parameters:

Returns:



21381
21382
21383
21384
 
# File 'lib/plaid/api/plaid_api.rb', line 21381

def watchlist_screening_entity_review_create(watchlist_screening_entity_review_create_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_review_create_with_http_info(watchlist_screening_entity_review_create_request, opts)
  data
end

#watchlist_screening_entity_review_create_with_http_info(watchlist_screening_entity_review_create_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityReviewCreateResponse, Integer, Hash)>

Create a review for an entity watchlist screening Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

Parameters:

Returns:



21391
21392
21393
21394
21395
21396
21397
21398
21399
21400
21401
21402
21403
21404
21405
21406
21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
21440
21441
21442
 
# File 'lib/plaid/api/plaid_api.rb', line 21391

def watchlist_screening_entity_review_create_with_http_info(watchlist_screening_entity_review_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_create ...'
  end
  # verify the required parameter 'watchlist_screening_entity_review_create_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_review_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_review_create_request' when calling PlaidApi.watchlist_screening_entity_review_create"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/review/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_review_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityReviewCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_review_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_review_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_review_list(watchlist_screening_entity_review_list_request, opts = {}) ⇒ WatchlistScreeningEntityReviewListResponse

List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

Parameters:

Returns:



21449
21450
21451
21452
 
# File 'lib/plaid/api/plaid_api.rb', line 21449

def watchlist_screening_entity_review_list(watchlist_screening_entity_review_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_review_list_with_http_info(watchlist_screening_entity_review_list_request, opts)
  data
end

#watchlist_screening_entity_review_list_with_http_info(watchlist_screening_entity_review_list_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityReviewListResponse, Integer, Hash)>

List reviews for entity watchlist screenings List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

Parameters:

Returns:



21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
21480
21481
21482
21483
21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
21502
21503
21504
21505
21506
21507
21508
21509
21510
 
# File 'lib/plaid/api/plaid_api.rb', line 21459

def watchlist_screening_entity_review_list_with_http_info(watchlist_screening_entity_review_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_list ...'
  end
  # verify the required parameter 'watchlist_screening_entity_review_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_review_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_review_list_request' when calling PlaidApi.watchlist_screening_entity_review_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/review/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_review_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityReviewListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_review_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_review_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_entity_update(watchlist_screening_entity_update_request, opts = {}) ⇒ WatchlistScreeningEntityUpdateResponse

Update an entity screening Update an entity watchlist screening.

Parameters:

  • watchlist_screening_entity_update_request (WatchlistScreeningEntityUpdateRequest) —

    The entity screening was successfully updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



21517
21518
21519
21520
 
# File 'lib/plaid/api/plaid_api.rb', line 21517

def watchlist_screening_entity_update(watchlist_screening_entity_update_request, opts = {})
  data, _status_code, _headers = watchlist_screening_entity_update_with_http_info(watchlist_screening_entity_update_request, opts)
  data
end

#watchlist_screening_entity_update_with_http_info(watchlist_screening_entity_update_request, opts = {}) ⇒ Array<(WatchlistScreeningEntityUpdateResponse, Integer, Hash)>

Update an entity screening Update an entity watchlist screening.

Parameters:

  • watchlist_screening_entity_update_request (WatchlistScreeningEntityUpdateRequest) —

    The entity screening was successfully updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



21527
21528
21529
21530
21531
21532
21533
21534
21535
21536
21537
21538
21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
21572
21573
21574
21575
21576
21577
21578
 
# File 'lib/plaid/api/plaid_api.rb', line 21527

def watchlist_screening_entity_update_with_http_info(watchlist_screening_entity_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_update ...'
  end
  # verify the required parameter 'watchlist_screening_entity_update_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_entity_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_update_request' when calling PlaidApi.watchlist_screening_entity_update"
  end
  # resource path
  local_var_path = '/watchlist_screening/entity/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_entity_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_create(watchlist_screening_individual_create_request, opts = {}) ⇒ WatchlistScreeningIndividualCreateResponse

Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.

Parameters:

Returns:



21585
21586
21587
21588
 
# File 'lib/plaid/api/plaid_api.rb', line 21585

def watchlist_screening_individual_create(watchlist_screening_individual_create_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_create_with_http_info(watchlist_screening_individual_create_request, opts)
  data
end

#watchlist_screening_individual_create_with_http_info(watchlist_screening_individual_create_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualCreateResponse, Integer, Hash)>

Create a watchlist screening for a person Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.

Parameters:

Returns:



21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
21611
21612
21613
21614
21615
21616
21617
21618
21619
21620
21621
21622
21623
21624
21625
21626
21627
21628
21629
21630
21631
21632
21633
21634
21635
21636
21637
21638
21639
21640
21641
21642
21643
21644
21645
21646
 
# File 'lib/plaid/api/plaid_api.rb', line 21595

def watchlist_screening_individual_create_with_http_info(watchlist_screening_individual_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_create ...'
  end
  # verify the required parameter 'watchlist_screening_individual_create_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_create_request' when calling PlaidApi.watchlist_screening_individual_create"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_get(watchlist_screening_individual_get_request, opts = {}) ⇒ WatchlistScreeningIndividualGetResponse

Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening

Parameters:

Returns:



21653
21654
21655
21656
 
# File 'lib/plaid/api/plaid_api.rb', line 21653

def watchlist_screening_individual_get(watchlist_screening_individual_get_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_get_with_http_info(watchlist_screening_individual_get_request, opts)
  data
end

#watchlist_screening_individual_get_with_http_info(watchlist_screening_individual_get_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualGetResponse, Integer, Hash)>

Retrieve an individual watchlist screening Retrieve a previously created individual watchlist screening

Parameters:

Returns:



21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
21695
21696
21697
21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
 
# File 'lib/plaid/api/plaid_api.rb', line 21663

def watchlist_screening_individual_get_with_http_info(watchlist_screening_individual_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_get ...'
  end
  # verify the required parameter 'watchlist_screening_individual_get_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_get_request' when calling PlaidApi.watchlist_screening_individual_get"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_history_list(watchlist_screening_individual_history_list_request, opts = {}) ⇒ WatchlistScreeningIndividualHistoryListResponse

List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

Parameters:

Returns:



21721
21722
21723
21724
 
# File 'lib/plaid/api/plaid_api.rb', line 21721

def watchlist_screening_individual_history_list(watchlist_screening_individual_history_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_history_list_with_http_info(watchlist_screening_individual_history_list_request, opts)
  data
end

#watchlist_screening_individual_history_list_with_http_info(watchlist_screening_individual_history_list_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualHistoryListResponse, Integer, Hash)>

List history for individual watchlist screenings List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

Parameters:

Returns:



21731
21732
21733
21734
21735
21736
21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
21760
21761
21762
21763
21764
21765
21766
21767
21768
21769
21770
21771
21772
21773
21774
21775
21776
21777
21778
21779
21780
21781
21782
 
# File 'lib/plaid/api/plaid_api.rb', line 21731

def watchlist_screening_individual_history_list_with_http_info(watchlist_screening_individual_history_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_history_list ...'
  end
  # verify the required parameter 'watchlist_screening_individual_history_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_history_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_history_list_request' when calling PlaidApi.watchlist_screening_individual_history_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/history/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_history_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualHistoryListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_history_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_history_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_hit_list(watchlist_screening_individual_hit_list_request, opts = {}) ⇒ WatchlistScreeningIndividualHitListResponse

List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening.

Parameters:

Returns:



21789
21790
21791
21792
 
# File 'lib/plaid/api/plaid_api.rb', line 21789

def watchlist_screening_individual_hit_list(watchlist_screening_individual_hit_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_hit_list_with_http_info(watchlist_screening_individual_hit_list_request, opts)
  data
end

#watchlist_screening_individual_hit_list_with_http_info(watchlist_screening_individual_hit_list_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualHitListResponse, Integer, Hash)>

List hits for individual watchlist screening List all hits found by Plaid for a particular individual watchlist screening.

Parameters:

Returns:



21799
21800
21801
21802
21803
21804
21805
21806
21807
21808
21809
21810
21811
21812
21813
21814
21815
21816
21817
21818
21819
21820
21821
21822
21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
 
# File 'lib/plaid/api/plaid_api.rb', line 21799

def watchlist_screening_individual_hit_list_with_http_info(watchlist_screening_individual_hit_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_hit_list ...'
  end
  # verify the required parameter 'watchlist_screening_individual_hit_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_hit_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_hit_list_request' when calling PlaidApi.watchlist_screening_individual_hit_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/hit/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_hit_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualHitListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_hit_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_hit_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_list(watchlist_screening_individual_list_request, opts = {}) ⇒ WatchlistScreeningIndividualListResponse

List Individual Watchlist Screenings List previously created watchlist screenings for individuals

Parameters:

Returns:



21857
21858
21859
21860
 
# File 'lib/plaid/api/plaid_api.rb', line 21857

def watchlist_screening_individual_list(watchlist_screening_individual_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_list_with_http_info(watchlist_screening_individual_list_request, opts)
  data
end

#watchlist_screening_individual_list_with_http_info(watchlist_screening_individual_list_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualListResponse, Integer, Hash)>

List Individual Watchlist Screenings List previously created watchlist screenings for individuals

Parameters:

Returns:



21867
21868
21869
21870
21871
21872
21873
21874
21875
21876
21877
21878
21879
21880
21881
21882
21883
21884
21885
21886
21887
21888
21889
21890
21891
21892
21893
21894
21895
21896
21897
21898
21899
21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
21911
21912
21913
21914
21915
21916
21917
21918
 
# File 'lib/plaid/api/plaid_api.rb', line 21867

def watchlist_screening_individual_list_with_http_info(watchlist_screening_individual_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_list ...'
  end
  # verify the required parameter 'watchlist_screening_individual_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_list_request' when calling PlaidApi.watchlist_screening_individual_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_program_get(watchlist_screening_individual_program_get_request, opts = {}) ⇒ WatchlistScreeningIndividualProgramGetResponse

Get individual watchlist screening program Get an individual watchlist screening program

Parameters:

Returns:



21925
21926
21927
21928
 
# File 'lib/plaid/api/plaid_api.rb', line 21925

def watchlist_screening_individual_program_get(watchlist_screening_individual_program_get_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_program_get_with_http_info(watchlist_screening_individual_program_get_request, opts)
  data
end

#watchlist_screening_individual_program_get_with_http_info(watchlist_screening_individual_program_get_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualProgramGetResponse, Integer, Hash)>

Get individual watchlist screening program Get an individual watchlist screening program

Parameters:

Returns:



21935
21936
21937
21938
21939
21940
21941
21942
21943
21944
21945
21946
21947
21948
21949
21950
21951
21952
21953
21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
21964
21965
21966
21967
21968
21969
21970
21971
21972
21973
21974
21975
21976
21977
21978
21979
21980
21981
21982
21983
21984
21985
21986
 
# File 'lib/plaid/api/plaid_api.rb', line 21935

def watchlist_screening_individual_program_get_with_http_info(watchlist_screening_individual_program_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_get ...'
  end
  # verify the required parameter 'watchlist_screening_individual_program_get_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_program_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_program_get_request' when calling PlaidApi.watchlist_screening_individual_program_get"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/program/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_program_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualProgramGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_program_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_program_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_program_list(watchlist_screening_individual_program_list_request, opts = {}) ⇒ WatchlistScreeningIndividualProgramListResponse

List individual watchlist screening programs List all individual watchlist screening programs

Parameters:

Returns:



21993
21994
21995
21996
 
# File 'lib/plaid/api/plaid_api.rb', line 21993

def watchlist_screening_individual_program_list(watchlist_screening_individual_program_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_program_list_with_http_info(watchlist_screening_individual_program_list_request, opts)
  data
end

#watchlist_screening_individual_program_list_with_http_info(watchlist_screening_individual_program_list_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualProgramListResponse, Integer, Hash)>

List individual watchlist screening programs List all individual watchlist screening programs

Parameters:

Returns:



22003
22004
22005
22006
22007
22008
22009
22010
22011
22012
22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
22028
22029
22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
22047
22048
22049
22050
22051
22052
22053
22054
 
# File 'lib/plaid/api/plaid_api.rb', line 22003

def watchlist_screening_individual_program_list_with_http_info(watchlist_screening_individual_program_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_list ...'
  end
  # verify the required parameter 'watchlist_screening_individual_program_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_program_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_program_list_request' when calling PlaidApi.watchlist_screening_individual_program_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/program/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_program_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualProgramListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_program_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_program_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_review_create(watchlist_screening_individual_review_create_request, opts = {}) ⇒ WatchlistScreeningIndividualReviewCreateResponse

Create a review for an individual watchlist screening Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

Parameters:

Returns:



22061
22062
22063
22064
 
# File 'lib/plaid/api/plaid_api.rb', line 22061

def watchlist_screening_individual_review_create(watchlist_screening_individual_review_create_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_review_create_with_http_info(watchlist_screening_individual_review_create_request, opts)
  data
end

#watchlist_screening_individual_review_create_with_http_info(watchlist_screening_individual_review_create_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualReviewCreateResponse, Integer, Hash)>

Create a review for an individual watchlist screening Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

Parameters:

Returns:



22071
22072
22073
22074
22075
22076
22077
22078
22079
22080
22081
22082
22083
22084
22085
22086
22087
22088
22089
22090
22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
22102
22103
22104
22105
22106
22107
22108
22109
22110
22111
22112
22113
22114
22115
22116
22117
22118
22119
22120
22121
22122
 
# File 'lib/plaid/api/plaid_api.rb', line 22071

def watchlist_screening_individual_review_create_with_http_info(watchlist_screening_individual_review_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_review_create ...'
  end
  # verify the required parameter 'watchlist_screening_individual_review_create_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_review_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_review_create_request' when calling PlaidApi.watchlist_screening_individual_review_create"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/review/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_review_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualReviewCreateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_review_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_review_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_review_list(watchlist_screening_individual_review_list_request, opts = {}) ⇒ WatchlistScreeningIndividualReviewListResponse

List reviews for individual watchlist screenings List all reviews for the individual watchlist screening.

Parameters:

Returns:



22129
22130
22131
22132
 
# File 'lib/plaid/api/plaid_api.rb', line 22129

def watchlist_screening_individual_review_list(watchlist_screening_individual_review_list_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_review_list_with_http_info(watchlist_screening_individual_review_list_request, opts)
  data
end

#watchlist_screening_individual_review_list_with_http_info(watchlist_screening_individual_review_list_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualReviewListResponse, Integer, Hash)>

List reviews for individual watchlist screenings List all reviews for the individual watchlist screening.

Parameters:

Returns:



22139
22140
22141
22142
22143
22144
22145
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156
22157
22158
22159
22160
22161
22162
22163
22164
22165
22166
22167
22168
22169
22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
22182
22183
22184
22185
22186
22187
22188
22189
22190
 
# File 'lib/plaid/api/plaid_api.rb', line 22139

def watchlist_screening_individual_review_list_with_http_info(watchlist_screening_individual_review_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_review_list ...'
  end
  # verify the required parameter 'watchlist_screening_individual_review_list_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_review_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_review_list_request' when calling PlaidApi.watchlist_screening_individual_review_list"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/review/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_review_list_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualReviewListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_review_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_review_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#watchlist_screening_individual_update(watchlist_screening_individual_update_request, opts = {}) ⇒ WatchlistScreeningIndividualUpdateResponse

Update individual watchlist screening Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update ‘search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change.

Parameters:

Returns:



22197
22198
22199
22200
 
# File 'lib/plaid/api/plaid_api.rb', line 22197

def watchlist_screening_individual_update(watchlist_screening_individual_update_request, opts = {})
  data, _status_code, _headers = watchlist_screening_individual_update_with_http_info(watchlist_screening_individual_update_request, opts)
  data
end

#watchlist_screening_individual_update_with_http_info(watchlist_screening_individual_update_request, opts = {}) ⇒ Array<(WatchlistScreeningIndividualUpdateResponse, Integer, Hash)>

Update individual watchlist screening Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update &#x60;search_terms&#x60; and &#x60;status&#x60; at the same time since editing &#x60;search_terms&#x60; may trigger an automatic &#x60;status&#x60; change.

Parameters:

Returns:



22207
22208
22209
22210
22211
22212
22213
22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
22230
22231
22232
22233
22234
22235
22236
22237
22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
22255
22256
22257
22258
 
# File 'lib/plaid/api/plaid_api.rb', line 22207

def watchlist_screening_individual_update_with_http_info(watchlist_screening_individual_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_update ...'
  end
  # verify the required parameter 'watchlist_screening_individual_update_request' is set
  if @api_client.config.client_side_validation && watchlist_screening_individual_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_update_request' when calling PlaidApi.watchlist_screening_individual_update"
  end
  # resource path
  local_var_path = '/watchlist_screening/individual/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.watchlist_screening_individual_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhook_verification_key_get(webhook_verification_key_get_request, opts = {}) ⇒ WebhookVerificationKeyGetResponse

Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the ‘Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.

Parameters:

Returns:



22265
22266
22267
22268
 
# File 'lib/plaid/api/plaid_api.rb', line 22265

def webhook_verification_key_get(webhook_verification_key_get_request, opts = {})
  data, _status_code, _headers = webhook_verification_key_get_with_http_info(webhook_verification_key_get_request, opts)
  data
end

#webhook_verification_key_get_with_http_info(webhook_verification_key_get_request, opts = {}) ⇒ Array<(WebhookVerificationKeyGetResponse, Integer, Hash)>

Get webhook verification key Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the &#x60;Plaid-Verification&#x60; header. The &#x60;/webhook_verification_key/get&#x60; endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.

Parameters:

Returns:



22275
22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
22287
22288
22289
22290
22291
22292
22293
22294
22295
22296
22297
22298
22299
22300
22301
22302
22303
22304
22305
22306
22307
22308
22309
22310
22311
22312
22313
22314
22315
22316
22317
22318
22319
22320
22321
22322
22323
22324
22325
22326
 
# File 'lib/plaid/api/plaid_api.rb', line 22275

def webhook_verification_key_get_with_http_info(webhook_verification_key_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.webhook_verification_key_get ...'
  end
  # verify the required parameter 'webhook_verification_key_get_request' is set
  if @api_client.config.client_side_validation && webhook_verification_key_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_verification_key_get_request' when calling PlaidApi.webhook_verification_key_get"
  end
  # resource path
  local_var_path = '/webhook_verification_key/get'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_verification_key_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WebhookVerificationKeyGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

  new_options = opts.merge(
    :operation => :"PlaidApi.webhook_verification_key_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaidApi#webhook_verification_key_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end