Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientApis::FundingAccountApi

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/api/funding_account_api.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FundingAccountApi

Returns a new instance of FundingAccountApi.



15
16
17
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 15

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#add_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, add_funding_account_request, opts = {}) ⇒ [FundingAccountResponse, headers]

Add Funding Account This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • add_funding_account_request —

    JSON containing all the attributes of the Funding account to be added to customer.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • ([FundingAccountResponse, headers]) 


33
34
35
36
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 33

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, , opts = {})
  data, _status_code, _headers = (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, , opts)
  [data, _status_code, _headers]
end

#add_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, add_funding_account_request, opts = {}) ⇒ Array<(FundingAccountResponse, Fixnum, Hash)>

Add Funding Account This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • add_funding_account_request —

    JSON containing all the attributes of the Funding account to be added to customer.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • (Array<(FundingAccountResponse, Fixnum, Hash)>) —

    FundingAccountResponse data, response status code and response headers



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 53

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, , opts = {})

  # resource path
  local_var_path = '/customers/{ID_CUSTOMER}/fundingaccounts'
  if  !id_customer.nil? && id_customer.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_CUSTOMER' + '}', id_customer.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_customer' when calling FundingAccountApi.add_funding_account"
  end
  
  # 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'])
  header_params['channel'] = channel
  header_params['client_key'] = client_key
  header_params['product'] = product
  header_params['timestamp'] = timestamp
  header_params['idempotent_request_key'] = idempotent_request_key
  header_params['requestor_type'] = requestor_type
  header_params['requestor'] = opts[:'requestor'] if !opts[:'requestor'].nil?
  header_params['X-OPAY-Headers'] = opts[:'x_opay_headers'] if !opts[:'x_opay_headers'].nil?
  header_params['trace_id'] = opts[:'trace_id'] if !opts[:'trace_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  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 => 'FundingAccountResponse')
  return data, status_code, headers
end

#delete_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, delete_funding_account_request, opts = {}) ⇒ [DeleteResponse, headers]

Delete Funding Account The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • delete_funding_account_request —

    Details of account to be deleted.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • ([DeleteResponse, headers]) 


113
114
115
116
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 113

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts = {})
  data, _status_code, _headers = (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts)
  [data, _status_code, _headers]
end

#delete_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, delete_funding_account_request, opts = {}) ⇒ Array<(DeleteResponse, Fixnum, Hash)>

Delete Funding Account The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • delete_funding_account_request —

    Details of account to be deleted.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • (Array<(DeleteResponse, Fixnum, Hash)>) —

    DeleteResponse data, response status code and response headers



134
135
136
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
176
177
178
179
180
181
182
183
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 134

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts = {})

  # resource path
  local_var_path = '/customers/{ID_CUSTOMER}/fundingaccounts/{ID_FUNDING_ACCOUNT}'
  if  !.nil? && .to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_FUNDING_ACCOUNT' + '}', .to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_funding_account' when calling FundingAccountApi.delete_funding_account"
  end
  
  if  !id_customer.nil? && id_customer.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_CUSTOMER' + '}', id_customer.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_customer' when calling FundingAccountApi.delete_funding_account"
  end
  
  # 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'])
  header_params['channel'] = channel
  header_params['client_key'] = client_key
  header_params['product'] = product
  header_params['timestamp'] = timestamp
  header_params['idempotent_request_key'] = idempotent_request_key
  header_params['requestor_type'] = requestor_type
  header_params['requestor'] = opts[:'requestor'] if !opts[:'requestor'].nil?
  header_params['X-OPAY-Headers'] = opts[:'x_opay_headers'] if !opts[:'x_opay_headers'].nil?
  header_params['trace_id'] = opts[:'trace_id'] if !opts[:'trace_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  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 => 'DeleteResponse')
  return data, status_code, headers
end

#get_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, opts = {}) ⇒ [FundingAccountResponse, headers]

Get Funding Account The Get Funding Account API is used to retrieve the details of the funding account based on the id.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • ([FundingAccountResponse, headers]) 


199
200
201
202
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 199

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, opts = {})
  data, _status_code, _headers = (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, opts)
  [data, _status_code, _headers]
end

#get_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, opts = {}) ⇒ Array<(FundingAccountResponse, Fixnum, Hash)>

Get Funding Account The Get Funding Account API is used to retrieve the details of the funding account based on the id.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • (Array<(FundingAccountResponse, Fixnum, Hash)>) —

    FundingAccountResponse data, response status code and response headers



219
220
221
222
223
224
225
226
227
228
229
230
231
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
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 219

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, opts = {})

  # resource path
  local_var_path = '/customers/{ID_CUSTOMER}/fundingaccounts/{ID_FUNDING_ACCOUNT}'
  if  !.nil? && .to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_FUNDING_ACCOUNT' + '}', .to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_funding_account' when calling FundingAccountApi.get_funding_account"
  end
  
  if  !id_customer.nil? && id_customer.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_CUSTOMER' + '}', id_customer.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_customer' when calling FundingAccountApi.get_funding_account"
  end
  
  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params['channel'] = channel
  header_params['client_key'] = client_key
  header_params['product'] = product
  header_params['timestamp'] = timestamp
  header_params['idempotent_request_key'] = idempotent_request_key
  header_params['requestor_type'] = requestor_type
  header_params['requestor'] = opts[:'requestor'] if !opts[:'requestor'].nil?
  header_params['X-OPAY-Headers'] = opts[:'x_opay_headers'] if !opts[:'x_opay_headers'].nil?
  header_params['trace_id'] = opts[:'trace_id'] if !opts[:'trace_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'FundingAccountResponse')
  return data, status_code, headers
end

#replace_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, replace_funding_account_request, opts = {}) ⇒ [FundingAccountResponse, headers]

Replace Funding Account The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • replace_funding_account_request —

    JSON containing all the attributes of the Funding account to be replaced.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • ([FundingAccountResponse, headers]) 


283
284
285
286
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 283

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts = {})
  data, _status_code, _headers = (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts)
  [data, _status_code, _headers]
end

#replace_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, replace_funding_account_request, opts = {}) ⇒ Array<(FundingAccountResponse, Fixnum, Hash)>

Replace Funding Account The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • replace_funding_account_request —

    JSON containing all the attributes of the Funding account to be replaced.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • (Array<(FundingAccountResponse, Fixnum, Hash)>) —

    FundingAccountResponse data, response status code and response headers



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
346
347
348
349
350
351
352
353
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 304

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts = {})

  # resource path
  local_var_path = '/customers/{ID_CUSTOMER}/fundingaccounts/{ID_FUNDING_ACCOUNT}/replacement'
  if  !.nil? && .to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_FUNDING_ACCOUNT' + '}', .to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_funding_account' when calling FundingAccountApi.replace_funding_account"
  end
  
  if  !id_customer.nil? && id_customer.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_CUSTOMER' + '}', id_customer.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_customer' when calling FundingAccountApi.replace_funding_account"
  end
  
  # 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'])
  header_params['channel'] = channel
  header_params['client_key'] = client_key
  header_params['product'] = product
  header_params['timestamp'] = timestamp
  header_params['idempotent_request_key'] = idempotent_request_key
  header_params['requestor_type'] = requestor_type
  header_params['requestor'] = opts[:'requestor'] if !opts[:'requestor'].nil?
  header_params['X-OPAY-Headers'] = opts[:'x_opay_headers'] if !opts[:'x_opay_headers'].nil?
  header_params['trace_id'] = opts[:'trace_id'] if !opts[:'trace_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  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 => 'FundingAccountResponse')
  return data, status_code, headers
end

#retrieve_funding_accounts(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, opts = {}) ⇒ [FundingAccountsResponse, headers]

Retrieve Funding Accounts This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

  • :page_size (String) —

    The maximum number of objects returned in the query.

  • :account_number (String) —

    The Account Number to get details of.

  • :status (Array<String>) —

    The status of the funding account in EBPP. This can take multiple values in the format key&#x3D;value1&amp;key&#x3D;value2.…

  • :aba_routing_number (String) —

    The ABA/Routing number for the bank account.

  • :account_type (Array<String>) —

    The type of the funding account. This can take multiple values in the format key&#x3D;value1&amp;key&#x3D;value2.…

  • :account_subtype (String) —

    The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account.

Returns:

  • ([FundingAccountsResponse, headers]) 


374
375
376
377
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 374

def retrieve_funding_accounts(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, opts = {})
  data, _status_code, _headers = retrieve_funding_accounts_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, opts)
  [data, _status_code, _headers]
end

#retrieve_funding_accounts_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, opts = {}) ⇒ [FundingAccountsResponse, headers]

Retrieve Funding Accounts Pagination This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • query_id —

    query id of the Retrieve/Search Accounts lookup.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

  • :page_size (String) —

    The maximum number of objects returned in the query.

  • :from_index (String) —

    To fetch the next set of objects that start after this object

  • :to_index (String) —

    To fetch the previous set of objects that end at this object

Returns:

  • ([FundingAccountsResponse, headers]) 


469
470
471
472
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 469

def retrieve_funding_accounts_page(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, opts = {})
  data, _status_code, _headers = retrieve_funding_accounts_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, opts)
  [data, _status_code, _headers]
end

#retrieve_funding_accounts_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, opts = {}) ⇒ Array<(FundingAccountsResponse, Fixnum, Hash)>

Retrieve Funding Accounts Pagination This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • query_id —

    query id of the Retrieve/Search Accounts lookup.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

  • :page_size (String) —

    The maximum number of objects returned in the query.

  • :from_index (String) —

    To fetch the next set of objects that start after this object

  • :to_index (String) —

    To fetch the previous set of objects that end at this object

Returns:

  • (Array<(FundingAccountsResponse, Fixnum, Hash)>) —

    FundingAccountsResponse 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
541
542
543
544
545
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 492

def retrieve_funding_accounts_page_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, query_id, opts = {})

  # resource path
  local_var_path = '/customers/{ID_CUSTOMER}/fundingaccounts/lists'
  if  !id_customer.nil? && id_customer.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_CUSTOMER' + '}', id_customer.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_customer' when calling FundingAccountApi.retrieve_funding_accounts_page"
  end
  
  # query parameters
  query_params = {}
  if  !query_id.nil? && query_id.to_s.strip != "" 
      query_params[:'query_id'] = query_id
  end
  if !opts[:'page_size'].nil? && opts[:'page_size'].to_s.strip != "" 
      query_params[:'page_size'] = opts[:'page_size']
  end
  if !opts[:'from_index'].nil? && opts[:'from_index'].to_s.strip != "" 
      query_params[:'from_index'] = opts[:'from_index']
  end
  if !opts[:'to_index'].nil? && opts[:'to_index'].to_s.strip != "" 
      query_params[:'to_index'] = opts[:'to_index']
  end

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params['channel'] = channel
  header_params['client_key'] = client_key
  header_params['product'] = product
  header_params['timestamp'] = timestamp
  header_params['idempotent_request_key'] = idempotent_request_key
  header_params['requestor_type'] = requestor_type
  header_params['requestor'] = opts[:'requestor'] if !opts[:'requestor'].nil?
  header_params['X-OPAY-Headers'] = opts[:'x_opay_headers'] if !opts[:'x_opay_headers'].nil?
  header_params['trace_id'] = opts[:'trace_id'] if !opts[:'trace_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'FundingAccountsResponse')
  return data, status_code, headers
end

#retrieve_funding_accounts_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, opts = {}) ⇒ Array<(FundingAccountsResponse, Fixnum, Hash)>

Retrieve Funding Accounts This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

  • :page_size (String) —

    The maximum number of objects returned in the query.

  • :account_number (String) —

    The Account Number to get details of.

  • :status (Array<String>) —

    The status of the funding account in EBPP. This can take multiple values in the format key&#x3D;value1&amp;key&#x3D;value2.…

  • :aba_routing_number (String) —

    The ABA/Routing number for the bank account.

  • :account_type (Array<String>) —

    The type of the funding account. This can take multiple values in the format key&#x3D;value1&amp;key&#x3D;value2.…

  • :account_subtype (String) —

    The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account.

Returns:

  • (Array<(FundingAccountsResponse, Fixnum, Hash)>) —

    FundingAccountsResponse data, response status code and response headers



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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 399

def retrieve_funding_accounts_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, opts = {})

  # resource path
  local_var_path = '/customers/{ID_CUSTOMER}/fundingaccounts/lists'
  if  !id_customer.nil? && id_customer.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_CUSTOMER' + '}', id_customer.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_customer' when calling FundingAccountApi.retrieve_funding_accounts"
  end
  
  # query parameters
  query_params = {}
  if !opts[:'page_size'].nil? && opts[:'page_size'].to_s.strip != "" 
      query_params[:'page_size'] = opts[:'page_size']
  end

  # 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/x-www-form-urlencoded'])
  header_params['channel'] = channel
  header_params['client_key'] = client_key
  header_params['product'] = product
  header_params['timestamp'] = timestamp
  header_params['idempotent_request_key'] = idempotent_request_key
  header_params['requestor_type'] = requestor_type
  header_params['requestor'] = opts[:'requestor'] if !opts[:'requestor'].nil?
  header_params['X-OPAY-Headers'] = opts[:'x_opay_headers'] if !opts[:'x_opay_headers'].nil?
  header_params['trace_id'] = opts[:'trace_id'] if !opts[:'trace_id'].nil?

  # form parameters
  form_params = {}
  form_params['account_number'] = opts[:'account_number'] if !opts[:'account_number'].nil?
  form_params['status'] = @api_client.build_collection_param(opts[:'status'], :multi) if !opts[:'status'].nil?
  form_params['aba_routing_number'] = opts[:'aba_routing_number'] if !opts[:'aba_routing_number'].nil?
  form_params['account_type'] = @api_client.build_collection_param(opts[:'account_type'], :multi) if !opts[:'account_type'].nil?
  form_params['account_subtype'] = opts[:'account_subtype'] if !opts[:'account_subtype'].nil?

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'FundingAccountsResponse')
  return data, status_code, headers
end

#update_funding_account(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, update_funding_account_request, opts = {}) ⇒ [FundingAccountResponse, headers]

Update Funding Account The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.
Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • update_funding_account_request —

    JSON containing all the attributes of the Funding account to be updated.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • ([FundingAccountResponse, headers]) 


562
563
564
565
 
# File 'lib/orbipay_paymentsapi_client/api/funding_account_api.rb', line 562

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts = {})
  data, _status_code, _headers = (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts)
  [data, _status_code, _headers]
end

#update_funding_account_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_funding_account, id_customer, update_funding_account_request, opts = {}) ⇒ Array<(FundingAccountResponse, Fixnum, Hash)>

Update Funding Account The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. &lt;br&gt;&lt;br&gt; Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ———— | ———— | ———— | | active | deleted| &lt;ul&gt; &lt;li&gt;external_user&lt;/li&gt; &lt;li&gt; client_agent&lt;/li&gt; &lt;li&gt; system&lt;/li&gt; &lt;li&gt; customer&lt;/li&gt;&lt;/ul&gt; | | active | frozen | &lt;ul&gt; &lt;li&gt;external_user &lt;/li&gt; &lt;li&gt; client_agent &lt;/li&gt; &lt;li&gt; system&lt;/li&gt;&lt;/ul&gt; | | active | inactive | &lt;ul&gt; &lt;li&gt;external_user &lt;/li&gt; &lt;li&gt; client_agent &lt;/li&gt; &lt;li&gt; system&lt;/li&gt;&lt;/ul&gt; | | active | unverified | &lt;ul&gt; &lt;li&gt;system&lt;/li&gt;&lt;/ul&gt; | | frozen | active | &lt;ul&gt; &lt;li&gt;external_user &lt;/li&gt; &lt;li&gt; client_agent&lt;/li&gt;&lt;/ul&gt; | | inactive | active | &lt;ul&gt; &lt;li&gt;external_user &lt;/li&gt; &lt;li&gt; client_agent &lt;/li&gt; &lt;li&gt; system&lt;/li&gt;&lt;/ul&gt; |

Parameters:

  • channel —

    The channel through which the API is invoked.

  • client_key —

    The unique identifier assigned by EBPP to the client.

  • product —

    The product identifier corresponding to the API.

  • timestamp —

    The timestamp for the moment when the API request is created.

  • idempotent_request_key —

    The unique token that clients can generate and maintain in order to identify an API request.

  • requestor_type —

    Type of the requestor of the API.

  • id_funding_account —

    The unique identifier assigned by EBPP to the Funding Account.

  • id_customer —

    The unique identifier assigned by EBPP to the customer.

  • update_funding_account_request —

    JSON containing all the attributes of the Funding account to be updated.

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

    the optional parameters

Options Hash (opts):

  • :requestor (String) —

    The identifier for the requestor of the API. If the requestor_type is &lt;b&gt;system&lt;/b&gt;, requestor is optional.

  • :x_opay_headers (String) —

    Intended for the future use.

  • :trace_id (String) —

    The unique reference that can be used for tracing and debugging an API call.

Returns:

  • (Array<(FundingAccountResponse, Fixnum, Hash)>) —

    FundingAccountResponse data, response status code and response headers



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

def (channel, client_key, product, timestamp, idempotent_request_key, requestor_type, , id_customer, , opts = {})

  # resource path
  local_var_path = '/customers/{ID_CUSTOMER}/fundingaccounts/{ID_FUNDING_ACCOUNT}'
  if  !.nil? && .to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_FUNDING_ACCOUNT' + '}', .to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_funding_account' when calling FundingAccountApi.update_funding_account"
  end
  
  if  !id_customer.nil? && id_customer.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_CUSTOMER' + '}', id_customer.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_customer' when calling FundingAccountApi.update_funding_account"
  end
  
  # 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'])
  header_params['channel'] = channel
  header_params['client_key'] = client_key
  header_params['product'] = product
  header_params['timestamp'] = timestamp
  header_params['idempotent_request_key'] = idempotent_request_key
  header_params['requestor_type'] = requestor_type
  header_params['requestor'] = opts[:'requestor'] if !opts[:'requestor'].nil?
  header_params['X-OPAY-Headers'] = opts[:'x_opay_headers'] if !opts[:'x_opay_headers'].nil?
  header_params['trace_id'] = opts[:'trace_id'] if !opts[:'trace_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  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 => 'FundingAccountResponse')
  return data, status_code, headers
end