Class: IntegrationApi::ACHApi

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/api/ach_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ACHApi

Returns a new instance of ACHApi.



19
20
21
# File 'lib/integration_api/api/ach_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/integration_api/api/ach_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_ach_transfer_using_delete(nucleus_funding_id, opts = {}) ⇒ AchTransferResponseVO

Cancel the ACH transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



26
27
28
29
# File 'lib/integration_api/api/ach_api.rb', line 26

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

#cancel_ach_transfer_using_delete_with_http_info(nucleus_funding_id, opts = {}) ⇒ Array<(AchTransferResponseVO, Fixnum, Hash)>

Cancel the ACH transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchTransferResponseVO, Fixnum, Hash)>)

    AchTransferResponseVO data, response status code and response headers



35
36
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
# File 'lib/integration_api/api/ach_api.rb', line 35

def cancel_ach_transfer_using_delete_with_http_info(nucleus_funding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.cancel_ach_transfer_using_delete ...'
  end
  # verify the required parameter 'nucleus_funding_id' is set
  if @api_client.config.client_side_validation && nucleus_funding_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_funding_id' when calling ACHApi.cancel_ach_transfer_using_delete"
  end
  # resource path
  local_var_path = '/ach/{nucleus_funding_id}'.sub('{' + 'nucleus_funding_id' + '}', nucleus_funding_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchTransferResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#cancel_ach_transfer_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_ach_card_link_using_post(card_link_request_co, opts = {}) ⇒ AchCardLinkResponseVO

Create an ACH card link

Parameters:

  • card_link_request_co

    cardLinkRequestCO

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



76
77
78
79
# File 'lib/integration_api/api/ach_api.rb', line 76

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

#create_ach_card_link_using_post_with_http_info(card_link_request_co, opts = {}) ⇒ Array<(AchCardLinkResponseVO, Fixnum, Hash)>

Create an ACH card link

Parameters:

  • card_link_request_co

    cardLinkRequestCO

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchCardLinkResponseVO, Fixnum, Hash)>)

    AchCardLinkResponseVO data, response status code and response headers



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/integration_api/api/ach_api.rb', line 85

def create_ach_card_link_using_post_with_http_info(card_link_request_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.create_ach_card_link_using_post ...'
  end
  # verify the required parameter 'card_link_request_co' is set
  if @api_client.config.client_side_validation && card_link_request_co.nil?
    fail ArgumentError, "Missing the required parameter 'card_link_request_co' when calling ACHApi.create_ach_card_link_using_post"
  end
  # resource path
  local_var_path = '/ach/card_link'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(card_link_request_co)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchCardLinkResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#create_ach_card_link_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bank_link_using_post(ach_bank_link_request_co, opts = {}) ⇒ AchBankLinkResponseVO

Create bank link

Parameters:

  • ach_bank_link_request_co

    achBankLinkRequestCO

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



128
129
130
131
# File 'lib/integration_api/api/ach_api.rb', line 128

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

#create_bank_link_using_post_with_http_info(ach_bank_link_request_co, opts = {}) ⇒ Array<(AchBankLinkResponseVO, Fixnum, Hash)>

Create bank link

Parameters:

  • ach_bank_link_request_co

    achBankLinkRequestCO

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchBankLinkResponseVO, Fixnum, Hash)>)

    AchBankLinkResponseVO data, response status code and response headers



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/integration_api/api/ach_api.rb', line 137

def create_bank_link_using_post_with_http_info(ach_bank_link_request_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.create_bank_link_using_post ...'
  end
  # verify the required parameter 'ach_bank_link_request_co' is set
  if @api_client.config.client_side_validation && ach_bank_link_request_co.nil?
    fail ArgumentError, "Missing the required parameter 'ach_bank_link_request_co' when calling ACHApi.create_bank_link_using_post"
  end
  # resource path
  local_var_path = '/ach/bank_link'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(ach_bank_link_request_co)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchBankLinkResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#create_bank_link_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_business_using_post(business_request, opts = {}) ⇒ BaseResponseVO

Create a business

Parameters:

  • business_request

    businessRequest

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



180
181
182
183
# File 'lib/integration_api/api/ach_api.rb', line 180

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

#create_business_using_post_with_http_info(business_request, opts = {}) ⇒ Array<(BaseResponseVO, Fixnum, Hash)>

Create a business

Parameters:

  • business_request

    businessRequest

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(BaseResponseVO, Fixnum, Hash)>)

    BaseResponseVO data, response status code and response headers



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/integration_api/api/ach_api.rb', line 189

def create_business_using_post_with_http_info(business_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.create_business_using_post ...'
  end
  # verify the required parameter 'business_request' is set
  if @api_client.config.client_side_validation && business_request.nil?
    fail ArgumentError, "Missing the required parameter 'business_request' when calling ACHApi.create_business_using_post"
  end
  # resource path
  local_var_path = '/ach/business'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(business_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#create_business_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_client_using_post(client_request, opts = {}) ⇒ AchClientResponseVO

Create a client

Parameters:

  • client_request

    clientRequest

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



232
233
234
235
# File 'lib/integration_api/api/ach_api.rb', line 232

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

#create_client_using_post_with_http_info(client_request, opts = {}) ⇒ Array<(AchClientResponseVO, Fixnum, Hash)>

Create a client

Parameters:

  • client_request

    clientRequest

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchClientResponseVO, Fixnum, Hash)>)

    AchClientResponseVO data, response status code and response headers



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
# File 'lib/integration_api/api/ach_api.rb', line 241

def create_client_using_post_with_http_info(client_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.create_client_using_post ...'
  end
  # verify the required parameter 'client_request' is set
  if @api_client.config.client_side_validation && client_request.nil?
    fail ArgumentError, "Missing the required parameter 'client_request' when calling ACHApi.create_client_using_post"
  end
  # resource path
  local_var_path = '/ach/client'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(client_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchClientResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#create_client_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Delete bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



284
285
286
287
# File 'lib/integration_api/api/ach_api.rb', line 284

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

Delete bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchBankLinkResponseVO, Fixnum, Hash)>)

    AchBankLinkResponseVO data, response status code and response headers



293
294
295
296
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
# File 'lib/integration_api/api/ach_api.rb', line 293

def delete_bank_link_using_delete_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.delete_bank_link_using_delete ...'
  end
  # verify the required parameter 'nucleus_bank_link_id' is set
  if @api_client.config.client_side_validation && nucleus_bank_link_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_bank_link_id' when calling ACHApi.delete_bank_link_using_delete"
  end
  # resource path
  local_var_path = '/ach/bank_link/{nucleus_bank_link_id}'.sub('{' + 'nucleus_bank_link_id' + '}', nucleus_bank_link_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchBankLinkResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#delete_bank_link_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ach_transfer_using_get(nucleus_funding_id, opts = {}) ⇒ AchTransferResponseVO

Get the ACH transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



334
335
336
337
# File 'lib/integration_api/api/ach_api.rb', line 334

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

#get_ach_transfer_using_get_with_http_info(nucleus_funding_id, opts = {}) ⇒ Array<(AchTransferResponseVO, Fixnum, Hash)>

Get the ACH transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchTransferResponseVO, Fixnum, Hash)>)

    AchTransferResponseVO data, response status code and response headers



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/integration_api/api/ach_api.rb', line 343

def get_ach_transfer_using_get_with_http_info(nucleus_funding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_ach_transfer_using_get ...'
  end
  # verify the required parameter 'nucleus_funding_id' is set
  if @api_client.config.client_side_validation && nucleus_funding_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_funding_id' when calling ACHApi.get_ach_transfer_using_get"
  end
  # resource path
  local_var_path = '/ach/{nucleus_funding_id}'.sub('{' + 'nucleus_funding_id' + '}', nucleus_funding_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchTransferResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_ach_transfer_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_balance_using_get(portfolio_id, opts = {}) ⇒ AchBalanceResponseVO

Get balance

Parameters:

  • portfolio_id

    portfolio_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :end_date (Date)

    end_date

  • :start_date (Date)

    start_date

Returns:



386
387
388
389
# File 'lib/integration_api/api/ach_api.rb', line 386

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

#get_balance_using_get_with_http_info(portfolio_id, opts = {}) ⇒ Array<(AchBalanceResponseVO, Fixnum, Hash)>

Get balance

Parameters:

  • portfolio_id

    portfolio_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :end_date (Date)

    end_date

  • :start_date (Date)

    start_date

Returns:

  • (Array<(AchBalanceResponseVO, Fixnum, Hash)>)

    AchBalanceResponseVO data, response status code and response headers



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
# File 'lib/integration_api/api/ach_api.rb', line 397

def get_balance_using_get_with_http_info(portfolio_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_balance_using_get ...'
  end
  # verify the required parameter 'portfolio_id' is set
  if @api_client.config.client_side_validation && portfolio_id.nil?
    fail ArgumentError, "Missing the required parameter 'portfolio_id' when calling ACHApi.get_balance_using_get"
  end
  # resource path
  local_var_path = '/ach/balance/{portfolio_id}'.sub('{' + 'portfolio_id' + '}', portfolio_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchBalanceResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_balance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Get bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



440
441
442
443
# File 'lib/integration_api/api/ach_api.rb', line 440

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

Get bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchBankLinkResponseVO, Fixnum, Hash)>)

    AchBankLinkResponseVO data, response status code and response headers



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'lib/integration_api/api/ach_api.rb', line 449

def get_bank_link_using_get_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_bank_link_using_get ...'
  end
  # verify the required parameter 'nucleus_bank_link_id' is set
  if @api_client.config.client_side_validation && nucleus_bank_link_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_bank_link_id' when calling ACHApi.get_bank_link_using_get"
  end
  # resource path
  local_var_path = '/ach/bank_link/{nucleus_bank_link_id}'.sub('{' + 'nucleus_bank_link_id' + '}', nucleus_bank_link_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchBankLinkResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_bank_link_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Get bank links for a reserve account

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



489
490
491
492
# File 'lib/integration_api/api/ach_api.rb', line 489

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

Get bank links for a reserve account

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Array<AchBankLinkResponseVO>, Fixnum, Hash)>)

    Array<AchBankLinkResponseVO> data, response status code and response headers



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
# File 'lib/integration_api/api/ach_api.rb', line 497

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_bank_links_for_reserve_account_using_get ...'
  end
  # resource path
  local_var_path = '/ach/bank_link/reserve'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AchBankLinkResponseVO>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_bank_links_for_reserve_account_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Get client bank links

Parameters:

  • nucleus_client_id

    nucleus_client_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



534
535
536
537
# File 'lib/integration_api/api/ach_api.rb', line 534

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

Get client bank links

Parameters:

  • nucleus_client_id

    nucleus_client_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Array<AchBankLinkResponseVO>, Fixnum, Hash)>)

    Array<AchBankLinkResponseVO> data, response status code and response headers



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
# File 'lib/integration_api/api/ach_api.rb', line 543

def get_client_bank_links_using_get_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_client_bank_links_using_get ...'
  end
  # verify the required parameter 'nucleus_client_id' is set
  if @api_client.config.client_side_validation && nucleus_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_client_id' when calling ACHApi.get_client_bank_links_using_get"
  end
  # resource path
  local_var_path = '/ach/bank_link/client/{nucleus_client_id}'.sub('{' + 'nucleus_client_id' + '}', nucleus_client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AchBankLinkResponseVO>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_client_bank_links_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_list_of_client_ach_transfers_using_get(nucleus_client_id, opts = {}) ⇒ PageAchTransferResponseVO

Get a list of client’s ACH transfers

Parameters:

  • nucleus_client_id

    nucleus_client_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page (default to 0)

  • :size (Integer)

    size (default to 25)

Returns:



586
587
588
589
# File 'lib/integration_api/api/ach_api.rb', line 586

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

#get_list_of_client_ach_transfers_using_get_with_http_info(nucleus_client_id, opts = {}) ⇒ Array<(PageAchTransferResponseVO, Fixnum, Hash)>

Get a list of client&#39;s ACH transfers

Parameters:

  • nucleus_client_id

    nucleus_client_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page

  • :size (Integer)

    size

Returns:

  • (Array<(PageAchTransferResponseVO, Fixnum, Hash)>)

    PageAchTransferResponseVO data, response status code and response headers



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
# File 'lib/integration_api/api/ach_api.rb', line 597

def get_list_of_client_ach_transfers_using_get_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_list_of_client_ach_transfers_using_get ...'
  end
  # verify the required parameter 'nucleus_client_id' is set
  if @api_client.config.client_side_validation && nucleus_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_client_id' when calling ACHApi.get_list_of_client_ach_transfers_using_get"
  end
  # resource path
  local_var_path = '/ach/client/{nucleus_client_id}'.sub('{' + 'nucleus_client_id' + '}', nucleus_client_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageAchTransferResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_list_of_client_ach_transfers_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_list_of_tenant_ach_transfers_using_get(opts = {}) ⇒ PageAchTransferResponseVO

Get a list of tenant’s ACH transfers

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :end_date (Date)

    end_date

  • :page (Integer)

    page (default to 0)

  • :size (Integer)

    size (default to 25)

  • :start_date (Date)

    start_date

  • :status (String)

    status

Returns:



644
645
646
647
# File 'lib/integration_api/api/ach_api.rb', line 644

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

#get_list_of_tenant_ach_transfers_using_get_with_http_info(opts = {}) ⇒ Array<(PageAchTransferResponseVO, Fixnum, Hash)>

Get a list of tenant&#39;s ACH transfers

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :end_date (Date)

    end_date

  • :page (Integer)

    page

  • :size (Integer)

    size

  • :start_date (Date)

    start_date

  • :status (String)

    status

Returns:

  • (Array<(PageAchTransferResponseVO, Fixnum, Hash)>)

    PageAchTransferResponseVO data, response status code and response headers



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
# File 'lib/integration_api/api/ach_api.rb', line 657

def get_list_of_tenant_ach_transfers_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_list_of_tenant_ach_transfers_using_get ...'
  end
  # resource path
  local_var_path = '/ach'

  # query parameters
  query_params = {}
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageAchTransferResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_list_of_tenant_ach_transfers_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#submit_ach_transfer_using_post(transfer_request, opts = {}) ⇒ AchTransferResponseVO

Submit an ACH transfer

Parameters:

  • transfer_request

    transferRequest

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



699
700
701
702
# File 'lib/integration_api/api/ach_api.rb', line 699

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

#submit_ach_transfer_using_post_with_http_info(transfer_request, opts = {}) ⇒ Array<(AchTransferResponseVO, Fixnum, Hash)>

Submit an ACH transfer

Parameters:

  • transfer_request

    transferRequest

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchTransferResponseVO, Fixnum, Hash)>)

    AchTransferResponseVO data, response status code and response headers



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
736
737
738
739
740
741
742
743
744
745
746
# File 'lib/integration_api/api/ach_api.rb', line 708

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

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(transfer_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchTransferResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#submit_ach_transfer_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Update bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



751
752
753
754
# File 'lib/integration_api/api/ach_api.rb', line 751

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

Update bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AchBankLinkResponseVO, Fixnum, Hash)>)

    AchBankLinkResponseVO data, response status code and response headers



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
# File 'lib/integration_api/api/ach_api.rb', line 760

def update_bank_link_using_put_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.update_bank_link_using_put ...'
  end
  # verify the required parameter 'nucleus_bank_link_id' is set
  if @api_client.config.client_side_validation && nucleus_bank_link_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_bank_link_id' when calling ACHApi.update_bank_link_using_put"
  end
  # resource path
  local_var_path = '/ach/bank_link/{nucleus_bank_link_id}'.sub('{' + 'nucleus_bank_link_id' + '}', nucleus_bank_link_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AchBankLinkResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#update_bank_link_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end