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 may return a balance object, only ‘/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.

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 may return a balance object, only &#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; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.

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
 
# 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](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. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use ‘/accounts/balance/get` instead. Note that some information is nullable.

Parameters:

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/plaid/api/plaid_api.rb', line 92

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. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [&#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. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use &#x60;/accounts/balance/get&#x60; instead. Note that some information is nullable.

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



102
103
104
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
 
# File 'lib/plaid/api/plaid_api.rb', line 102

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



157
158
159
160
 
# File 'lib/plaid/api/plaid_api.rb', line 157

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



167
168
169
170
171
172
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
 
# File 'lib/plaid/api/plaid_api.rb', line 167

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the ‘/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.

Parameters:

Returns:



222
223
224
225
 
# File 'lib/plaid/api/plaid_api.rb', line 222

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 Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the &#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:



232
233
234
235
236
237
238
239
240
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
 
# File 'lib/plaid/api/plaid_api.rb', line 232

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

Parameters:

Returns:



287
288
289
290
 
# File 'lib/plaid/api/plaid_api.rb', line 287

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/create&#x60;.

Parameters:

Returns:

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

    AssetReportGetResponse data, response status code and response headers



297
298
299
300
301
302
303
304
305
306
307
308
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
 
# File 'lib/plaid/api/plaid_api.rb', line 297

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



352
353
354
355
 
# File 'lib/plaid/api/plaid_api.rb', line 352

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:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
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
 
# File 'lib/plaid/api/plaid_api.rb', line 362

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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`. 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:



417
418
419
420
 
# File 'lib/plaid/api/plaid_api.rb', line 417

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;. 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



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
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
 
# File 'lib/plaid/api/plaid_api.rb', line 427

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



482
483
484
485
 
# File 'lib/plaid/api/plaid_api.rb', line 482

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



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
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
 
# File 'lib/plaid/api/plaid_api.rb', line 492

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 the `/asset_report/get` endpoint with `include_insights` set to `true`.

Parameters:

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

    the optional parameters

Returns:



547
548
549
550
 
# File 'lib/plaid/api/plaid_api.rb', line 547

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 the &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;.

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



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
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
 
# File 'lib/plaid/api/plaid_api.rb', line 557

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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) 


612
613
614
615
 
# File 'lib/plaid/api/plaid_api.rb', line 612

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



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/plaid/api/plaid_api.rb', line 622

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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



677
678
679
680
 
# File 'lib/plaid/api/plaid_api.rb', line 677

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



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/plaid/api/plaid_api.rb', line 687

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 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:



742
743
744
745
 
# File 'lib/plaid/api/plaid_api.rb', line 742

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 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



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/plaid/api/plaid_api.rb', line 752

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if ‘auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item. 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:



807
808
809
810
 
# File 'lib/plaid/api/plaid_api.rb', line 807

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 and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if &#x60;auth&#x60; was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Also note that &#x60;/auth/get&#x60; will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item. 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



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/plaid/api/plaid_api.rb', line 817

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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:



872
873
874
875
 
# File 'lib/plaid/api/plaid_api.rb', line 872

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:



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/plaid/api/plaid_api.rb', line 882

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



937
938
939
940
 
# File 'lib/plaid/api/plaid_api.rb', line 937

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



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
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/plaid/api/plaid_api.rb', line 947

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



1002
1003
1004
1005
 
# File 'lib/plaid/api/plaid_api.rb', line 1002

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



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
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/plaid/api/plaid_api.rb', line 1012

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 bank transfer events based on specified filter criteria.

Parameters:

Returns:



1067
1068
1069
1070
 
# File 'lib/plaid/api/plaid_api.rb', line 1067

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 bank transfer events based on specified filter criteria.

Parameters:

Returns:



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
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/plaid/api/plaid_api.rb', line 1077

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.

Parameters:

Returns:



1132
1133
1134
1135
 
# File 'lib/plaid/api/plaid_api.rb', line 1132

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 bank transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/bank_transfer/event/sync&#x60; endpoint to guarantee you have seen all bank transfer events.

Parameters:

Returns:



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
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/plaid/api/plaid_api.rb', line 1142

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



1197
1198
1199
1200
 
# File 'lib/plaid/api/plaid_api.rb', line 1197

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



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
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
 
# File 'lib/plaid/api/plaid_api.rb', line 1207

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



1262
1263
1264
1265
 
# File 'lib/plaid/api/plaid_api.rb', line 1262

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



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
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/plaid/api/plaid_api.rb', line 1272

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



1327
1328
1329
1330
 
# File 'lib/plaid/api/plaid_api.rb', line 1327

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:



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
1381
1382
1383
1384
1385
 
# File 'lib/plaid/api/plaid_api.rb', line 1337

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



1392
1393
1394
1395
 
# File 'lib/plaid/api/plaid_api.rb', line 1392

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:



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
1449
1450
 
# File 'lib/plaid/api/plaid_api.rb', line 1402

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



1457
1458
1459
1460
 
# File 'lib/plaid/api/plaid_api.rb', line 1457

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:



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
 
# File 'lib/plaid/api/plaid_api.rb', line 1467

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#categories_get(body, opts = {}) ⇒ CategoriesGetResponse

Get Categories Send a request to the ‘/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.

Parameters:

  • body (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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

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)>

Get Categories Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.

Parameters:

  • body (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    CategoriesGetResponse data, response status code and response headers



1532
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1532

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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:



1587
1588
1589
1590
 
# File 'lib/plaid/api/plaid_api.rb', line 1587

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:



1597
1598
1599
1600
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1597

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



1652
1653
1654
1655
 
# File 'lib/plaid/api/plaid_api.rb', line 1652

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:



1662
1663
1664
1665
1666
1667
1668
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1662

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the ‘/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.

Parameters:

Returns:



1717
1718
1719
1720
 
# File 'lib/plaid/api/plaid_api.rb', line 1717

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 participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the &#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:



1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1727

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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.

Parameters:

Returns:



1782
1783
1784
1785
 
# File 'lib/plaid/api/plaid_api.rb', line 1782

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.

Parameters:

Returns:

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

    CreditBankIncomeGetResponse data, response status code and response headers



1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1792

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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.

Parameters:

Returns:

  • (File) 


1847
1848
1849
1850
 
# File 'lib/plaid/api/plaid_api.rb', line 1847

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.

Parameters:

Returns:

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

    File data, response status code and response headers



1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1857

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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 bank income report data for a specific user.

Parameters:

Returns:



1912
1913
1914
1915
 
# File 'lib/plaid/api/plaid_api.rb', line 1912

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 bank income report data for a specific user.

Parameters:

Returns:



1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1922

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



1977
1978
1979
1980
 
# File 'lib/plaid/api/plaid_api.rb', line 1977

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



1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
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
 
# File 'lib/plaid/api/plaid_api.rb', line 1987

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



2042
2043
2044
2045
 
# File 'lib/plaid/api/plaid_api.rb', line 2042

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:



2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
 
# File 'lib/plaid/api/plaid_api.rb', line 2052

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



2107
2108
2109
2110
 
# File 'lib/plaid/api/plaid_api.rb', line 2107

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:



2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
 
# File 'lib/plaid/api/plaid_api.rb', line 2117

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



2172
2173
2174
2175
 
# File 'lib/plaid/api/plaid_api.rb', line 2172

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:



2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'lib/plaid/api/plaid_api.rb', line 2182

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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 access to an Asset Report to a third party, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to the third party who needs access. 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 to whom you want to grant access to the Report.

Parameters:

Returns:



2237
2238
2239
2240
 
# File 'lib/plaid/api/plaid_api.rb', line 2237

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 &#x60;relay_token&#x60; 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 access to an Asset Report to a third party, use the &#x60;/credit/relay/create&#x60; endpoint to create a &#x60;relay_token&#x60; and then pass that token to the third party who needs access. 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 to whom you want to grant access to the Report.

Parameters:

Returns:

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

    CreditRelayCreateResponse data, response status code and response headers



2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
 
# File 'lib/plaid/api/plaid_api.rb', line 2247

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 get a report that was shared with them, using an `relay_token` that was created by the report owner.

Parameters:

  • credit_relay_get_request (CreditRelayGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2302
2303
2304
2305
 
# File 'lib/plaid/api/plaid_api.rb', line 2302

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 get a report that was shared with them, using an &#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



2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
 
# File 'lib/plaid/api/plaid_api.rb', line 2312

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_refresh(credit_relay_refresh_request, opts = {}) ⇒ CreditRelayRefreshResponse

Refresh a report of a Relay Token The ‘/credit/relay/refresh` endpoint allows third parties to refresh an report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.

Parameters:

Returns:



2367
2368
2369
2370
 
# File 'lib/plaid/api/plaid_api.rb', line 2367

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 an 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 based on the old one, but with the most recent data available.

Parameters:

Returns:

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

    CreditRelayRefreshResponse data, response status code and response headers



2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
 
# File 'lib/plaid/api/plaid_api.rb', line 2377

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 Credit Relay Token The ‘/credit/relay/remove` endpoint allows you to invalidate a `relay_token`, meaning the third party holding the token will no longer be able to use it to access the reports to which the `relay_token` gives access to. The report, items associated with it, 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:



2432
2433
2434
2435
 
# File 'lib/plaid/api/plaid_api.rb', line 2432

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 Credit Relay Token The &#x60;/credit/relay/remove&#x60; endpoint allows you to invalidate a &#x60;relay_token&#x60;, meaning the third party holding the token will no longer be able to use it to access the reports to which the &#x60;relay_token&#x60; gives access to. The report, items associated with it, 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.

Parameters:

Returns:

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

    CreditRelayRemoveResponse data, response status code and response headers



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
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
 
# File 'lib/plaid/api/plaid_api.rb', line 2442

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



2497
2498
2499
2500
 
# File 'lib/plaid/api/plaid_api.rb', line 2497

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:



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
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
 
# File 'lib/plaid/api/plaid_api.rb', line 2507

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



2562
2563
2564
2565
 
# File 'lib/plaid/api/plaid_api.rb', line 2562

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



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
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
 
# File 'lib/plaid/api/plaid_api.rb', line 2572

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 Retrieve information about a dashboard user.

Parameters:

Returns:



2627
2628
2629
2630
 
# File 'lib/plaid/api/plaid_api.rb', line 2627

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 Retrieve information about a dashboard user.

Parameters:

Returns:

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

    DashboardUserGetResponse data, response status code and response headers



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
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
 
# File 'lib/plaid/api/plaid_api.rb', line 2637

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 List all dashboard users associated with your account.

Parameters:

Returns:



2692
2693
2694
2695
 
# File 'lib/plaid/api/plaid_api.rb', line 2692

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 List all dashboard users associated with your account.

Parameters:

Returns:

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

    DashboardUserListResponse data, response status code and response headers



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
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
 
# File 'lib/plaid/api/plaid_api.rb', line 2702

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {}) ⇒ DepositSwitchAltCreateResponse

Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to ‘/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.

Parameters:

Returns:



2757
2758
2759
2760
 
# File 'lib/plaid/api/plaid_api.rb', line 2757

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

#deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {}) ⇒ Array<(DepositSwitchAltCreateResponse, Integer, Hash)>

Create a deposit switch without using Plaid Exchange This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.

Parameters:

Returns:



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
2809
2810
2811
2812
2813
2814
2815
 
# File 'lib/plaid/api/plaid_api.rb', line 2767

def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
  end
  # verify the required parameter 'deposit_switch_alt_create_request' is set
  if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
  end
  # resource path
  local_var_path = '/deposit_switch/alt/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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"PlaidApi.deposit_switch_alt_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#deposit_switch_alt_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deposit_switch_create(deposit_switch_create_request, opts = {}) ⇒ DepositSwitchCreateResponse

Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.

Parameters:

Returns:



2822
2823
2824
2825
 
# File 'lib/plaid/api/plaid_api.rb', line 2822

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

#deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {}) ⇒ Array<(DepositSwitchCreateResponse, Integer, Hash)>

Create a deposit switch This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.

Parameters:

Returns:

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

    DepositSwitchCreateResponse data, response status code and response headers



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
2877
2878
2879
2880
 
# File 'lib/plaid/api/plaid_api.rb', line 2832

def deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_create ...'
  end
  # verify the required parameter 'deposit_switch_create_request' is set
  if @api_client.config.client_side_validation && deposit_switch_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'deposit_switch_create_request' when calling PlaidApi.deposit_switch_create"
  end
  # resource path
  local_var_path = '/deposit_switch/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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"PlaidApi.deposit_switch_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#deposit_switch_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deposit_switch_get(deposit_switch_get_request, opts = {}) ⇒ DepositSwitchGetResponse

Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user’s direct deposit allocation preferences.

Parameters:

Returns:



2887
2888
2889
2890
 
# File 'lib/plaid/api/plaid_api.rb', line 2887

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

#deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {}) ⇒ Array<(DepositSwitchGetResponse, Integer, Hash)>

Retrieve a deposit switch This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user&#39;s direct deposit allocation preferences.

Parameters:

Returns:

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

    DepositSwitchGetResponse data, response status code and response headers



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
2945
 
# File 'lib/plaid/api/plaid_api.rb', line 2897

def deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_get ...'
  end
  # verify the required parameter 'deposit_switch_get_request' is set
  if @api_client.config.client_side_validation && deposit_switch_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'deposit_switch_get_request' when calling PlaidApi.deposit_switch_get"
  end
  # resource path
  local_var_path = '/deposit_switch/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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"PlaidApi.deposit_switch_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#deposit_switch_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deposit_switch_token_create(deposit_switch_token_create_request, opts = {}) ⇒ DepositSwitchTokenCreateResponse

Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.

Parameters:

Returns:



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

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

#deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {}) ⇒ Array<(DepositSwitchTokenCreateResponse, Integer, Hash)>

Create a deposit switch token In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.

Parameters:

Returns:



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
 
# File 'lib/plaid/api/plaid_api.rb', line 2962

def deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_token_create ...'
  end
  # verify the required parameter 'deposit_switch_token_create_request' is set
  if @api_client.config.client_side_validation && deposit_switch_token_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'deposit_switch_token_create_request' when calling PlaidApi.deposit_switch_token_create"
  end
  # resource path
  local_var_path = '/deposit_switch/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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"PlaidApi.deposit_switch_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#deposit_switch_token_create\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:



3017
3018
3019
3020
 
# File 'lib/plaid/api/plaid_api.rb', line 3017

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



3027
3028
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3027

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



3082
3083
3084
3085
 
# File 'lib/plaid/api/plaid_api.rb', line 3082

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:



3092
3093
3094
3095
3096
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3092

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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) 


3147
3148
3149
3150
 
# File 'lib/plaid/api/plaid_api.rb', line 3147

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



3157
3158
3159
3160
3161
3162
3163
3164
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3157

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](plaid.com/docs/api/versioning/#version-2019-05-29).

Parameters:

  • identity_get_request (IdentityGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3212
3213
3214
3215
 
# File 'lib/plaid/api/plaid_api.rb', line 3212

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. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the &#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



3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3222

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.

Parameters:

  • identity_match_request (IdentityMatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3277
3278
3279
3280
 
# File 'lib/plaid/api/plaid_api.rb', line 3277

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. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.

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



3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3287

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don’t know whether the associated user already has an active Identity Verification, you can specify ‘"is_idempotent": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.

Parameters:

Returns:



3342
3343
3344
3345
 
# File 'lib/plaid/api/plaid_api.rb', line 3342

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; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, 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 &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code.

Parameters:

Returns:



3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3352

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



3407
3408
3409
3410
 
# File 'lib/plaid/api/plaid_api.rb', line 3407

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:



3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3417

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



3472
3473
3474
3475
 
# File 'lib/plaid/api/plaid_api.rb', line 3472

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:



3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
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
 
# File 'lib/plaid/api/plaid_api.rb', line 3482

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



3537
3538
3539
3540
 
# File 'lib/plaid/api/plaid_api.rb', line 3537

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:



3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
 
# File 'lib/plaid/api/plaid_api.rb', line 3547

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



3602
3603
3604
3605
 
# File 'lib/plaid/api/plaid_api.rb', line 3602

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:



3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
 
# File 'lib/plaid/api/plaid_api.rb', line 3612

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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) 


3667
3668
3669
3670
 
# File 'lib/plaid/api/plaid_api.rb', line 3667

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



3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
 
# File 'lib/plaid/api/plaid_api.rb', line 3677

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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



3732
3733
3734
3735
 
# File 'lib/plaid/api/plaid_api.rb', line 3732

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:



3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'lib/plaid/api/plaid_api.rb', line 3742

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



3797
3798
3799
3800
 
# File 'lib/plaid/api/plaid_api.rb', line 3797

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:



3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
 
# File 'lib/plaid/api/plaid_api.rb', line 3807

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_refresh(income_verification_refresh_request, opts = {}) ⇒ IncomeVerificationRefreshResponse

(Deprecated) Refresh an income verification ‘/income/verification/refresh` refreshes a given income verification.

Parameters:

Returns:



3862
3863
3864
3865
 
# File 'lib/plaid/api/plaid_api.rb', line 3862

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

#income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {}) ⇒ Array<(IncomeVerificationRefreshResponse, Integer, Hash)>

(Deprecated) Refresh an income verification &#x60;/income/verification/refresh&#x60; refreshes a given income verification.

Parameters:

Returns:



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
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
 
# File 'lib/plaid/api/plaid_api.rb', line 3872

def income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_refresh ...'
  end
  # verify the required parameter 'income_verification_refresh_request' is set
  if @api_client.config.client_side_validation && income_verification_refresh_request.nil?
    fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
  end
  # resource path
  local_var_path = '/income/verification/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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"PlaidApi.income_verification_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#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#income_verification_taxforms_get(request_body, 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:

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

    the optional parameters

Returns:



3927
3928
3929
3930
 
# File 'lib/plaid/api/plaid_api.rb', line 3927

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

#income_verification_taxforms_get_with_http_info(request_body, 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:

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

    the optional parameters

Returns:



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
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
 
# File 'lib/plaid/api/plaid_api.rb', line 3937

def income_verification_taxforms_get_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_taxforms_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.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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] || '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:



3992
3993
3994
3995
 
# File 'lib/plaid/api/plaid_api.rb', line 3992

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:



4057
4058
4059
4060
 
# File 'lib/plaid/api/plaid_api.rb', line 4057

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



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
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
 
# File 'lib/plaid/api/plaid_api.rb', line 4067

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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



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
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
 
# File 'lib/plaid/api/plaid_api.rb', line 4002

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



4122
4123
4124
4125
 
# File 'lib/plaid/api/plaid_api.rb', line 4122

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



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
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'lib/plaid/api/plaid_api.rb', line 4132

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



4187
4188
4189
4190
 
# File 'lib/plaid/api/plaid_api.rb', line 4187

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:



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
4237
4238
4239
4240
4241
4242
4243
4244
4245
 
# File 'lib/plaid/api/plaid_api.rb', line 4197

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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.

Parameters:

Returns:



4252
4253
4254
4255
 
# File 'lib/plaid/api/plaid_api.rb', line 4252

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.

Parameters:

Returns:



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
4305
4306
4307
4308
4309
4310
 
# File 'lib/plaid/api/plaid_api.rb', line 4262

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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:



4317
4318
4319
4320
 
# File 'lib/plaid/api/plaid_api.rb', line 4317

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:



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
4373
4374
4375
 
# File 'lib/plaid/api/plaid_api.rb', line 4327

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_application_list(item_application_list_request, opts = {}) ⇒ ItemApplicationListResponse

List a user’s connected applications List a user’s connected applications

Parameters:

Returns:



4382
4383
4384
4385
 
# File 'lib/plaid/api/plaid_api.rb', line 4382

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



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 4392

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



4447
4448
4449
4450
 
# File 'lib/plaid/api/plaid_api.rb', line 4447

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:



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
 
# File 'lib/plaid/api/plaid_api.rb', line 4457

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



4512
4513
4514
4515
 
# File 'lib/plaid/api/plaid_api.rb', line 4512

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:



4522
4523
4524
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4522

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



4577
4578
4579
4580
 
# File 'lib/plaid/api/plaid_api.rb', line 4577

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



4587
4588
4589
4590
4591
4592
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4587

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).

Parameters:

  • item_import_request (ItemImportRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4642
4643
4644
4645
 
# File 'lib/plaid/api/plaid_api.rb', line 4642

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. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (&#x60;target_account_id&#x60;).

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



4652
4653
4654
4655
4656
4657
4658
4659
4660
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4652

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



4707
4708
4709
4710
 
# File 'lib/plaid/api/plaid_api.rb', line 4707

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:



4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4717

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution’s OAuth permission manager. API versions 2019-05-29 and earlier return a ‘removed` boolean as part of the response.

Parameters:

  • item_remove_request (ItemRemoveRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4772
4773
4774
4775
 
# File 'lib/plaid/api/plaid_api.rb', line 4772

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. Note that in the Development environment, issuing an &#x60;/item/remove&#x60; request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via &#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



4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4782

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



4837
4838
4839
4840
 
# File 'lib/plaid/api/plaid_api.rb', line 4837

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



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4847

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.

Parameters:

  • liabilities_get_request (LiabilitiesGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4902
4903
4904
4905
 
# File 'lib/plaid/api/plaid_api.rb', line 4902

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/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/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 Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.

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



4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4912

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 link delivery session Use the ‘/link_delivery/create` endpoint to create a Link Delivery session.

Parameters:

Returns:



4967
4968
4969
4970
 
# File 'lib/plaid/api/plaid_api.rb', line 4967

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 link delivery session Use the &#x60;/link_delivery/create&#x60; endpoint to create a Link Delivery session.

Parameters:

Returns:

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

    LinkDeliveryCreateResponse data, response status code and response headers



4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
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
 
# File 'lib/plaid/api/plaid_api.rb', line 4977

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 link delivery session Use the ‘/link_delivery/get` endpoint to get the status of a Link Delivery session.

Parameters:

  • link_delivery_get_request (LinkDeliveryGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5032
5033
5034
5035
 
# File 'lib/plaid/api/plaid_api.rb', line 5032

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 link delivery session Use the &#x60;/link_delivery/get&#x60; endpoint to get the status of a Link Delivery 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



5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
 
# File 'lib/plaid/api/plaid_api.rb', line 5042

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



5097
5098
5099
5100
 
# File 'lib/plaid/api/plaid_api.rb', line 5097

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 &#39;payment_initiation&#39; 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 &#39;link_token&#39;.

Parameters:

Returns:



5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/plaid/api/plaid_api.rb', line 5107

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.

Parameters:

  • link_token_create_request (LinkTokenCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5162
5163
5164
5165
 
# File 'lib/plaid/api/plaid_api.rb', line 5162

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;, which can then be exchanged for an &#x60;access_token&#x60; via &#x60;/item/public_token/exchange&#x60; as part of the main Link flow. 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 flow for tokens with expired credentials, or the Payment Initiation (Europe) 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



5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/plaid/api/plaid_api.rb', line 5172

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.

Parameters:

  • link_token_get_request (LinkTokenGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5227
5228
5229
5230
 
# File 'lib/plaid/api/plaid_api.rb', line 5227

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 previously-created &#x60;link_token&#x60; using the &#x60;/link/token/create&#x60; endpoint. It can be useful for debugging purposes.

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



5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
 
# File 'lib/plaid/api/plaid_api.rb', line 5237

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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.

Parameters:

Returns:



5292
5293
5294
5295
 
# File 'lib/plaid/api/plaid_api.rb', line 5292

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.

Parameters:

Returns:



5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
 
# File 'lib/plaid/api/plaid_api.rb', line 5302

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 Production environment.

Parameters:

Returns:



5357
5358
5359
5360
 
# File 'lib/plaid/api/plaid_api.rb', line 5357

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 Production environment.

Parameters:

Returns:



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
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
 
# File 'lib/plaid/api/plaid_api.rb', line 5367

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



5422
5423
5424
5425
 
# File 'lib/plaid/api/plaid_api.rb', line 5422

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



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
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
 
# File 'lib/plaid/api/plaid_api.rb', line 5432

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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:



5487
5488
5489
5490
 
# File 'lib/plaid/api/plaid_api.rb', line 5487

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:



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
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
 
# File 'lib/plaid/api/plaid_api.rb', line 5497

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



5552
5553
5554
5555
 
# File 'lib/plaid/api/plaid_api.rb', line 5552

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:



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
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
 
# File 'lib/plaid/api/plaid_api.rb', line 5562

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



5617
5618
5619
5620
 
# File 'lib/plaid/api/plaid_api.rb', line 5617

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:



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
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
 
# File 'lib/plaid/api/plaid_api.rb', line 5627

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



5682
5683
5684
5685
 
# File 'lib/plaid/api/plaid_api.rb', line 5682

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:



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
5733
5734
5735
5736
5737
5738
5739
5740
 
# File 'lib/plaid/api/plaid_api.rb', line 5692

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.

Parameters:

Returns:



5747
5748
5749
5750
 
# File 'lib/plaid/api/plaid_api.rb', line 5747

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 or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.

Parameters:

Returns:



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
5801
5802
5803
5804
5805
 
# File 'lib/plaid/api/plaid_api.rb', line 5757

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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.

Parameters:

Returns:



5812
5813
5814
5815
 
# File 'lib/plaid/api/plaid_api.rb', line 5812

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.

Parameters:

Returns:



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
5869
5870
 
# File 'lib/plaid/api/plaid_api.rb', line 5822

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



5877
5878
5879
5880
 
# File 'lib/plaid/api/plaid_api.rb', line 5877

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:



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
 
# File 'lib/plaid/api/plaid_api.rb', line 5887

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use ‘/wallet/transaction/execute`, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.

Parameters:

Returns:



5942
5943
5944
5945
 
# File 'lib/plaid/api/plaid_api.rb', line 5942

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 previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use &#x60;/wallet/transaction/execute&#x60;, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.

Parameters:

Returns:



5952
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
 
# File 'lib/plaid/api/plaid_api.rb', line 5952

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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). 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:



6007
6008
6009
6010
 
# File 'lib/plaid/api/plaid_api.rb', line 6007

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). 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:



6017
6018
6019
6020
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
 
# File 'lib/plaid/api/plaid_api.rb', line 6017

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6072
6073
6074
6075
 
# File 'lib/plaid/api/plaid_api.rb', line 6072

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:



6082
6083
6084
6085
6086
6087
6088
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
 
# File 'lib/plaid/api/plaid_api.rb', line 6082

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6137
6138
6139
6140
 
# File 'lib/plaid/api/plaid_api.rb', line 6137

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:



6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
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
 
# File 'lib/plaid/api/plaid_api.rb', line 6147

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6202
6203
6204
6205
 
# File 'lib/plaid/api/plaid_api.rb', line 6202

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:



6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
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
 
# File 'lib/plaid/api/plaid_api.rb', line 6212

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6267
6268
6269
6270
 
# File 'lib/plaid/api/plaid_api.rb', line 6267

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



6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
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
 
# File 'lib/plaid/api/plaid_api.rb', line 6277

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6332
6333
6334
6335
 
# File 'lib/plaid/api/plaid_api.rb', line 6332

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:



6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
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
 
# File 'lib/plaid/api/plaid_api.rb', line 6342

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



6397
6398
6399
6400
 
# File 'lib/plaid/api/plaid_api.rb', line 6397

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:



6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
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
 
# File 'lib/plaid/api/plaid_api.rb', line 6407

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 or savings account that”s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see [Plaid API versioning](plaid.com/docs/api/versioning/#version-2020-09-14).

Parameters:

Returns:



6462
6463
6464
6465
 
# File 'lib/plaid/api/plaid_api.rb', line 6462

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 or savings 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



6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
 
# File 'lib/plaid/api/plaid_api.rb', line 6472

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6527
6528
6529
6530
 
# File 'lib/plaid/api/plaid_api.rb', line 6527

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



6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
 
# File 'lib/plaid/api/plaid_api.rb', line 6537

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6592
6593
6594
6595
 
# File 'lib/plaid/api/plaid_api.rb', line 6592

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:



6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
 
# File 'lib/plaid/api/plaid_api.rb', line 6602

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6657
6658
6659
6660
 
# File 'lib/plaid/api/plaid_api.rb', line 6657

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:



6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
 
# File 'lib/plaid/api/plaid_api.rb', line 6667

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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`.  Bank account tokens can also be revoked, using `/item/remove`.'

Parameters:

Returns:



6722
6723
6724
6725
 
# File 'lib/plaid/api/plaid_api.rb', line 6722

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;.  Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.&#39;

Parameters:

Returns:



6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
 
# File 'lib/plaid/api/plaid_api.rb', line 6732

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`.

Parameters:

Returns:



6787
6788
6789
6790
 
# File 'lib/plaid/api/plaid_api.rb', line 6787

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. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new &#x60;access_token&#x60;. Processor tokens can also be revoked, using &#x60;/item/remove&#x60;.

Parameters:

Returns:



6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
 
# File 'lib/plaid/api/plaid_api.rb', line 6797

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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:



6852
6853
6854
6855
 
# File 'lib/plaid/api/plaid_api.rb', line 6852

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:



6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
 
# File 'lib/plaid/api/plaid_api.rb', line 6862

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



6917
6918
6919
6920
 
# File 'lib/plaid/api/plaid_api.rb', line 6917

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:



6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
 
# File 'lib/plaid/api/plaid_api.rb', line 6927

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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 an Income webhook in the Sandbox environment.

Parameters:

Returns:



6982
6983
6984
6985
 
# File 'lib/plaid/api/plaid_api.rb', line 6982

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 an Income webhook in the Sandbox environment.

Parameters:

Returns:



6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
 
# File 'lib/plaid/api/plaid_api.rb', line 6992

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `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. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.

Parameters:

Returns:



7047
7048
7049
7050
 
# File 'lib/plaid/api/plaid_api.rb', line 7047

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;: Transactions update 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;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#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. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.

Parameters:

Returns:



7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
 
# File 'lib/plaid/api/plaid_api.rb', line 7057

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



7112
7113
7114
7115
 
# File 'lib/plaid/api/plaid_api.rb', line 7112

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:



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
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
 
# File 'lib/plaid/api/plaid_api.rb', line 7122

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](plaid.com/docs/auth/coverage/testing#).

Parameters:

Returns:



7177
7178
7179
7180
 
# File 'lib/plaid/api/plaid_api.rb', line 7177

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. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](plaid.com/docs/auth/coverage/testing#).

Parameters:

Returns:



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
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
 
# File 'lib/plaid/api/plaid_api.rb', line 7187

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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>) 


7242
7243
7244
7245
 
# File 'lib/plaid/api/plaid_api.rb', line 7242

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



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
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
 
# File 'lib/plaid/api/plaid_api.rb', line 7252

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



7307
7308
7309
7310
 
# File 'lib/plaid/api/plaid_api.rb', line 7307

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 decision_rationale &#x60;PAYMENT_PROFILE_LOGIN_REQUIRED&#x60;&#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:



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
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/plaid/api/plaid_api.rb', line 7317

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



7372
7373
7374
7375
 
# File 'lib/plaid/api/plaid_api.rb', line 7372

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:



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
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
 
# File 'lib/plaid/api/plaid_api.rb', line 7382

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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. `/sandbox/public_token/create` cannot be used with OAuth institutions.

Parameters:

Returns:



7437
7438
7439
7440
 
# File 'lib/plaid/api/plaid_api.rb', line 7437

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. &#x60;/sandbox/public_token/create&#x60; cannot be used with OAuth institutions.

Parameters:

Returns:



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
7488
7489
7490
7491
7492
7493
7494
7495
 
# File 'lib/plaid/api/plaid_api.rb', line 7447

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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 webhook in the Sandbox environment.

Parameters:

Returns:



7502
7503
7504
7505
 
# File 'lib/plaid/api/plaid_api.rb', line 7502

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 Transfer webhook in the Sandbox environment.

Parameters:

Returns:



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
7556
7557
7558
7559
7560
 
# File 'lib/plaid/api/plaid_api.rb', line 7512

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



7567
7568
7569
7570
 
# File 'lib/plaid/api/plaid_api.rb', line 7567

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:



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
7624
7625
 
# File 'lib/plaid/api/plaid_api.rb', line 7577

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



7632
7633
7634
7635
 
# File 'lib/plaid/api/plaid_api.rb', line 7632

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:



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
 
# File 'lib/plaid/api/plaid_api.rb', line 7642

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 `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:



7697
7698
7699
7700
 
# File 'lib/plaid/api/plaid_api.rb', line 7697

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 &#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:



7707
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
 
# File 'lib/plaid/api/plaid_api.rb', line 7707

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#signal_decision_report(signal_decision_report_request, opts = {}) ⇒ SignalDecisionReportResponse

Report whether you initiated an ACH transaction After calling ‘/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.

Parameters:

Returns:



7762
7763
7764
7765
 
# File 'lib/plaid/api/plaid_api.rb', line 7762

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 calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an &#x60;INVALID_REQUEST&#x60; error if called a second time with a different value for &#x60;initiated&#x60;.

Parameters:

Returns:



7772
7773
7774
7775
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
 
# File 'lib/plaid/api/plaid_api.rb', line 7772

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned.

Parameters:

  • signal_evaluate_request (SignalEvaluateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7827
7828
7829
7830
 
# File 'lib/plaid/api/plaid_api.rb', line 7827

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 (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned.

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



7837
7838
7839
7840
7841
7842
7843
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
 
# File 'lib/plaid/api/plaid_api.rb', line 7837

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

Prepare the Signal product before calling ‘/signal/evaluate` Call `/signal/prepare` with Plaid-linked bank account information at least 10 seconds before calling `/signal/evaluate` or as soon as an end-user enters the ACH deposit flow in your application.

Parameters:

  • signal_prepare_request (SignalPrepareRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7892
7893
7894
7895
 
# File 'lib/plaid/api/plaid_api.rb', line 7892

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)>

Prepare the Signal product before calling &#x60;/signal/evaluate&#x60; Call &#x60;/signal/prepare&#x60; with Plaid-linked bank account information at least 10 seconds before calling &#x60;/signal/evaluate&#x60; or as soon as an end-user enters the ACH deposit flow in your application.

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



7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
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
 
# File 'lib/plaid/api/plaid_api.rb', line 7902

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 trend in your portfolio.

Parameters:

Returns:



7957
7958
7959
7960
 
# File 'lib/plaid/api/plaid_api.rb', line 7957

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 trend in your portfolio.

Parameters:

Returns:

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

    SignalReturnReportResponse data, response status code and response headers



7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
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
 
# File 'lib/plaid/api/plaid_api.rb', line 7967

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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:



8022
8023
8024
8025
 
# File 'lib/plaid/api/plaid_api.rb', line 8022

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 &#39;/beta/transactions/v1/enhance&#39; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.

Parameters:

Returns:



8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
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
 
# File 'lib/plaid/api/plaid_api.rb', line 8032

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_get(transactions_get_request, opts = {}) ⇒ TransactionsGetResponse

Get transaction data 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. An Item’s ‘status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn’t. To be alerted when transaction data is ready to be fetched, listen for the [‘INITIAL_UPDATE`](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:



8087
8088
8089
8090
 
# File 'lib/plaid/api/plaid_api.rb', line 8087

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 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. An Item&#39;s &#x60;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



8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
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
 
# File 'lib/plaid/api/plaid_api.rb', line 8097

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 not included by default as part of Transactions. To request access to this endpoint and learn more about pricing, contact your Plaid account manager. Note that unlike `/transactions/get`, `/transactions/recurring/get` will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in `/link/token/create`, or after Link, by calling `/transactions/get`) before calling this endpoint. Data is available to `/transactions/recurring/get` approximately 5 seconds after the [`HISTORICAL_UPDATE`](plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). 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. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.

Parameters:

Returns:



8152
8153
8154
8155
 
# File 'lib/plaid/api/plaid_api.rb', line 8152

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 not included by default as part of Transactions. To request access to this endpoint and learn more about pricing, contact your Plaid account manager. Note that unlike &#x60;/transactions/get&#x60;, &#x60;/transactions/recurring/get&#x60; will not initialize an Item with Transactions. The Item must already have 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;) before calling this endpoint. Data is available to &#x60;/transactions/recurring/get&#x60; approximately 5 seconds after the [&#x60;HISTORICAL_UPDATE&#x60;](plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). 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. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.

Parameters:

Returns:



8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
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
 
# File 'lib/plaid/api/plaid_api.rb', line 8162

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UDPATES_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`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](www.plaid.com/contact) for assistance.

Parameters:

Returns:



8217
8218
8219
8220
 
# File 'lib/plaid/api/plaid_api.rb', line 8217

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 for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UDPATES_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;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](www.plaid.com/contact) for assistance.

Parameters:

Returns:

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

    TransactionsRefreshResponse data, response status code and response headers



8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
 
# File 'lib/plaid/api/plaid_api.rb', line 8227

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 [email protected].

Parameters:

Returns:



8282
8283
8284
8285
 
# File 'lib/plaid/api/plaid_api.rb', line 8282

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 [email protected].

Parameters:

Returns:



8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
 
# File 'lib/plaid/api/plaid_api.rb', line 8292

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



8347
8348
8349
8350
 
# File 'lib/plaid/api/plaid_api.rb', line 8347

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:



8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
 
# File 'lib/plaid/api/plaid_api.rb', line 8357

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



8412
8413
8414
8415
 
# File 'lib/plaid/api/plaid_api.rb', line 8412

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:



8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
 
# File 'lib/plaid/api/plaid_api.rb', line 8422

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 This endpoint replaces ‘/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as "adds"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item’s ‘status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.

Parameters:

Returns:



8477
8478
8479
8480
 
# File 'lib/plaid/api/plaid_api.rb', line 8477

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 This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as &quot;adds&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;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. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#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



8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
 
# File 'lib/plaid/api/plaid_api.rb', line 8487

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#transfer_authorization_create(transfer_authorization_create_request, opts = {}) ⇒ TransferAuthorizationCreateResponse

Create a transfer authorization Use the ‘/transfer/authorization/create` endpoint to determine transfer failure risk. 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 approve a transfer with the rationale code `ITEM_LOGIN_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. `device.ip_address`, `device.user_agent` are required fields. For [Guarantee](www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.

Parameters:

Returns:



8542
8543
8544
8545
 
# File 'lib/plaid/api/plaid_api.rb', line 8542

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 determine transfer failure risk. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with null 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 approve a transfer with the rationale code &#x60;ITEM_LOGIN_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. &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60; are required fields. For [Guarantee](www.plaid.com/docs//transfer/guarantee/), the following fields are required : &#x60;idempotency_key&#x60;, &#x60;user.phone_number&#x60; (optional if &#x60;email_address&#x60; provided), &#x60;user.email_address&#x60; (optional if &#x60;phone_number&#x60; provided), &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60;, and &#x60;user_present&#x60;.

Parameters:

Returns:



8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
 
# File 'lib/plaid/api/plaid_api.rb', line 8552

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



8607
8608
8609
8610
 
# File 'lib/plaid/api/plaid_api.rb', line 8607

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



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
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
 
# File 'lib/plaid/api/plaid_api.rb', line 8617

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_create(transfer_create_request, opts = {}) ⇒ TransferCreateResponse

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

Parameters:

  • transfer_create_request (TransferCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8672
8673
8674
8675
 
# File 'lib/plaid/api/plaid_api.rb', line 8672

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.

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



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
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
 
# File 'lib/plaid/api/plaid_api.rb', line 8682

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



8737
8738
8739
8740
 
# File 'lib/plaid/api/plaid_api.rb', line 8737

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



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
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
 
# File 'lib/plaid/api/plaid_api.rb', line 8747

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 25 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:



8802
8803
8804
8805
 
# File 'lib/plaid/api/plaid_api.rb', line 8802

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 25 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



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
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
 
# File 'lib/plaid/api/plaid_api.rb', line 8812

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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` fetches information about the transfer corresponding to the given `transfer_id`.

Parameters:

  • transfer_get_request (TransferGetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8867
8868
8869
8870
 
# File 'lib/plaid/api/plaid_api.rb', line 8867

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; fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.

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



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
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
 
# File 'lib/plaid/api/plaid_api.rb', line 8877

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



8932
8933
8934
8935
 
# File 'lib/plaid/api/plaid_api.rb', line 8932

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:



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
8984
8985
8986
8987
8988
8989
8990
 
# File 'lib/plaid/api/plaid_api.rb', line 8942

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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(request_body, opts = {}) ⇒ TransferIntentGetResponse

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

Parameters:

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

    the optional parameters

Returns:



8997
8998
8999
9000
 
# File 'lib/plaid/api/plaid_api.rb', line 8997

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

#transfer_intent_get_with_http_info(request_body, 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:

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

    the optional parameters

Returns:

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

    TransferIntentGetResponse data, response status code and response headers



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
9052
9053
9054
9055
 
# File 'lib/plaid/api/plaid_api.rb', line 9007

def transfer_intent_get_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_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.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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] || '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_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:



9062
9063
9064
9065
 
# File 'lib/plaid/api/plaid_api.rb', line 9062

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



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
9120
 
# File 'lib/plaid/api/plaid_api.rb', line 9072

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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 known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.

Parameters:

Returns:



9127
9128
9129
9130
 
# File 'lib/plaid/api/plaid_api.rb', line 9127

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

Parameters:

Returns:



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
 
# File 'lib/plaid/api/plaid_api.rb', line 9137

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_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:



9192
9193
9194
9195
 
# File 'lib/plaid/api/plaid_api.rb', line 9192

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:



9202
9203
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9202

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9257
9258
9259
9260
 
# File 'lib/plaid/api/plaid_api.rb', line 9257

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:



9267
9268
9269
9270
9271
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9267

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9322
9323
9324
9325
 
# File 'lib/plaid/api/plaid_api.rb', line 9322

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



9332
9333
9334
9335
9336
9337
9338
9339
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9332

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9387
9388
9389
9390
 
# File 'lib/plaid/api/plaid_api.rb', line 9387

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



9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9397

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_create(user_create_request, opts = {}) ⇒ UserCreateResponse

Create user This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same ‘client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user’s identifier in your database, as it is not possible to retrieve a previously created ‘user_token`.

Parameters:

  • user_create_request (UserCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9452
9453
9454
9455
 
# File 'lib/plaid/api/plaid_api.rb', line 9452

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 This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.

Parameters:

  • user_create_request (UserCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UserCreateResponse data, response status code and response headers



9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9462

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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

#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:



9517
9518
9519
9520
 
# File 'lib/plaid/api/plaid_api.rb', line 9517

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



9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9527

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9582
9583
9584
9585
 
# File 'lib/plaid/api/plaid_api.rb', line 9582

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



9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9592

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9647
9648
9649
9650
 
# File 'lib/plaid/api/plaid_api.rb', line 9647

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



9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
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
 
# File 'lib/plaid/api/plaid_api.rb', line 9657

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9712
9713
9714
9715
 
# File 'lib/plaid/api/plaid_api.rb', line 9712

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:



9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
 
# File 'lib/plaid/api/plaid_api.rb', line 9722

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9777
9778
9779
9780
 
# File 'lib/plaid/api/plaid_api.rb', line 9777

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:



9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
 
# File 'lib/plaid/api/plaid_api.rb', line 9787

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_transactions_list(wallet_transactions_list_request, opts = {}) ⇒ WalletTransactionsListResponse

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:



9842
9843
9844
9845
 
# File 'lib/plaid/api/plaid_api.rb', line 9842

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

#wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts = {}) ⇒ Array<(WalletTransactionsListResponse, 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:



9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
 
# File 'lib/plaid/api/plaid_api.rb', line 9852

def wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transactions_list ...'
  end
  # verify the required parameter 'wallet_transactions_list_request' is set
  if @api_client.config.client_side_validation && wallet_transactions_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_transactions_list_request' when calling PlaidApi.wallet_transactions_list"
  end
  # resource path
  local_var_path = '/wallet/transactions/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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"PlaidApi.wallet_transactions_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_transactions_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:



9907
9908
9909
9910
 
# File 'lib/plaid/api/plaid_api.rb', line 9907

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:



9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
 
# File 'lib/plaid/api/plaid_api.rb', line 9917

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



9972
9973
9974
9975
 
# File 'lib/plaid/api/plaid_api.rb', line 9972

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:



9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
 
# File 'lib/plaid/api/plaid_api.rb', line 9982

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10037
10038
10039
10040
 
# File 'lib/plaid/api/plaid_api.rb', line 10037

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:



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
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
 
# File 'lib/plaid/api/plaid_api.rb', line 10047

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10102
10103
10104
10105
 
# File 'lib/plaid/api/plaid_api.rb', line 10102

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:



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
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
 
# File 'lib/plaid/api/plaid_api.rb', line 10112

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10167
10168
10169
10170
 
# File 'lib/plaid/api/plaid_api.rb', line 10167

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:



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
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
 
# File 'lib/plaid/api/plaid_api.rb', line 10177

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10232
10233
10234
10235
 
# File 'lib/plaid/api/plaid_api.rb', line 10232

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:



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
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
 
# File 'lib/plaid/api/plaid_api.rb', line 10242

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10297
10298
10299
10300
 
# File 'lib/plaid/api/plaid_api.rb', line 10297

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:



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
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
 
# File 'lib/plaid/api/plaid_api.rb', line 10307

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10362
10363
10364
10365
 
# File 'lib/plaid/api/plaid_api.rb', line 10362

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:



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
10412
10413
10414
10415
10416
10417
10418
10419
10420
 
# File 'lib/plaid/api/plaid_api.rb', line 10372

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10427
10428
10429
10430
 
# File 'lib/plaid/api/plaid_api.rb', line 10427

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:



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
10480
10481
10482
10483
10484
10485
 
# File 'lib/plaid/api/plaid_api.rb', line 10437

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10492
10493
10494
10495
 
# File 'lib/plaid/api/plaid_api.rb', line 10492

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:



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
10548
10549
10550
 
# File 'lib/plaid/api/plaid_api.rb', line 10502

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10557
10558
10559
10560
 
# File 'lib/plaid/api/plaid_api.rb', line 10557

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:



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 10567

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10622
10623
10624
10625
 
# File 'lib/plaid/api/plaid_api.rb', line 10622

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:



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
 
# File 'lib/plaid/api/plaid_api.rb', line 10632

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10687
10688
10689
10690
 
# File 'lib/plaid/api/plaid_api.rb', line 10687

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:



10697
10698
10699
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
 
# File 'lib/plaid/api/plaid_api.rb', line 10697

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10752
10753
10754
10755
 
# File 'lib/plaid/api/plaid_api.rb', line 10752

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:



10762
10763
10764
10765
10766
10767
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
 
# File 'lib/plaid/api/plaid_api.rb', line 10762

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10817
10818
10819
10820
 
# File 'lib/plaid/api/plaid_api.rb', line 10817

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:



10827
10828
10829
10830
10831
10832
10833
10834
10835
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
 
# File 'lib/plaid/api/plaid_api.rb', line 10827

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10882
10883
10884
10885
 
# File 'lib/plaid/api/plaid_api.rb', line 10882

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:



10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
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
 
# File 'lib/plaid/api/plaid_api.rb', line 10892

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



10947
10948
10949
10950
 
# File 'lib/plaid/api/plaid_api.rb', line 10947

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:



10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
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
 
# File 'lib/plaid/api/plaid_api.rb', line 10957

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



11012
11013
11014
11015
 
# File 'lib/plaid/api/plaid_api.rb', line 11012

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:



11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
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
 
# File 'lib/plaid/api/plaid_api.rb', line 11022

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



11077
11078
11079
11080
 
# File 'lib/plaid/api/plaid_api.rb', line 11077

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:



11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
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
 
# File 'lib/plaid/api/plaid_api.rb', line 11087

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



11142
11143
11144
11145
 
# File 'lib/plaid/api/plaid_api.rb', line 11142

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:



11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
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
 
# File 'lib/plaid/api/plaid_api.rb', line 11152

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



11207
11208
11209
11210
 
# File 'lib/plaid/api/plaid_api.rb', line 11207

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:



11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
 
# File 'lib/plaid/api/plaid_api.rb', line 11217

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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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