Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientApis::RecordedPaymentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/api/recorded_payment_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) ⇒ RecordedPaymentApi

Returns a new instance of RecordedPaymentApi.



15
16
17
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_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/recorded_payment_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#delete_record_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, opts = {}) ⇒ nil

Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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

    The unique identifier assigned by EBPP to the payment.

  • delete_recorded_payment_request —

    Details of payment to be deleted/cancelled

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

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_api.rb', line 32

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

#delete_record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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

    The unique identifier assigned by EBPP to the payment.

  • delete_recorded_payment_request —

    Details of payment to be deleted/cancelled

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

Returns:

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

    nil, response status code and response headers



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

def delete_record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, opts = {})

  # resource path
  local_var_path = '/recordedpayments/{ID_PAYMENT}'
  if  !id_payment.nil? && id_payment.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_PAYMENT' + '}', id_payment.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_payment' when calling RecordedPaymentApi.delete_record_payment"
  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?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(delete_recorded_payment_request)
  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 data, status_code, headers
end

#get_record_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, opts = {}) ⇒ [GetRecordedPaymentResponse, headers]

Get Recorded Payment The API is used to retrieve the details of a payment by 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_payment —

    The unique identifier assigned by EBPP to the payment.

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

Returns:

  • ([GetRecordedPaymentResponse, headers]) 


106
107
108
109
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_api.rb', line 106

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

#get_record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, opts = {}) ⇒ Array<(GetRecordedPaymentResponse, Fixnum, Hash)>

Get Recorded Payment The API is used to retrieve the details of a payment by 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_payment —

    The unique identifier assigned by EBPP to the payment.

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

Returns:

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

    GetRecordedPaymentResponse data, response status code and response headers



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_api.rb', line 124

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

  # resource path
  local_var_path = '/recordedpayments/{ID_PAYMENT}'
  if  !id_payment.nil? && id_payment.to_s.strip != ""
  		local_var_path = local_var_path.sub('{' + 'ID_PAYMENT' + '}', id_payment.to_s)
	  else
	fail ArgumentError, "Missing the required parameter 'id_payment' when calling RecordedPaymentApi.get_record_payment"
  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?

  # 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 => 'GetRecordedPaymentResponse')
  return data, status_code, headers
end

#record_payment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, opts = {}) ⇒ [RecordedPaymentResponse, headers]

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.

  • record_payment_request —

    JSON containing all the fields required to record a payment.

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

Returns:

  • ([RecordedPaymentResponse, headers]) 


178
179
180
181
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_api.rb', line 178

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

#record_payment_with_http_info(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, opts = {}) ⇒ Array<(RecordedPaymentResponse, Fixnum, Hash)>

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.

  • record_payment_request —

    JSON containing all the fields required to record a payment.

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

Returns:

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

    RecordedPaymentResponse data, response status code and response headers



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
228
229
230
231
232
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_api.rb', line 196

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

  # resource path
  local_var_path = '/recordedpayments'
  # 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?

  # form parameters
  form_params = {}

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

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

Retrieve Recorded Payments The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.

  • :id_customer_account (String) —

    The unique identifier assigned by EBPP to the customer account

  • :confirmation_number (String) —

    The confirmation number or reference provided to the customer for the successful payment.

  • :payment_method (Array<String>) —

    The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&amp;key&#x3D;value2.…

  • :status (Array<String>) —

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

  • :from_date (String) —

    The date from which payments, matching the criteria specified, need to be retrieved.

  • :to_date (String) —

    The date upto which payments, matching the criteria specified, need to be retrieved.

  • :page_size (String) —

    The maximum number of objects returned in the query.

  • :query_id (String) —

    query id of the Retrieve/Search Payments lookup.

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

  • ([RecordedPaymentsResponse, headers]) 


256
257
258
259
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_api.rb', line 256

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

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

Retrieve Recorded Payments The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.

  • :id_customer_account (String) —

    The unique identifier assigned by EBPP to the customer account

  • :confirmation_number (String) —

    The confirmation number or reference provided to the customer for the successful payment.

  • :payment_method (Array<String>) —

    The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&amp;key&#x3D;value2.…

  • :status (Array<String>) —

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

  • :from_date (String) —

    The date from which payments, matching the criteria specified, need to be retrieved.

  • :to_date (String) —

    The date upto which payments, matching the criteria specified, need to be retrieved.

  • :page_size (String) —

    The maximum number of objects returned in the query.

  • :query_id (String) —

    query id of the Retrieve/Search Payments lookup.

  • :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<(RecordedPaymentsResponse, Fixnum, Hash)>) —

    RecordedPaymentsResponse data, response status code and response headers



284
285
286
287
288
289
290
291
292
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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/orbipay_paymentsapi_client/api/recorded_payment_api.rb', line 284

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

  # resource path
  local_var_path = '/recordedpayments'
  # query parameters
  query_params = {}
  if  !id_customer.nil? && id_customer.to_s.strip != "" 
      query_params[:'id_customer'] = id_customer
  end
  if !opts[:'id_customer_account'].nil? && opts[:'id_customer_account'].to_s.strip != "" 
      query_params[:'id_customer_account'] = opts[:'id_customer_account']
  end
  if !opts[:'confirmation_number'].nil? && opts[:'confirmation_number'].to_s.strip != "" 
      query_params[:'confirmation_number'] = opts[:'confirmation_number']
  end
  if !opts[:'payment_method'].nil? && opts[:'payment_method'].to_s.strip != "" 
      query_params[:'payment_method'] = @api_client.build_collection_param(opts[:'payment_method'], :multi)
  end
  if !opts[:'status'].nil? && opts[:'status'].to_s.strip != "" 
      query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :multi)
  end
  if !opts[:'from_date'].nil? && opts[:'from_date'].to_s.strip != "" 
      query_params[:'from_date'] = opts[:'from_date']
  end
  if !opts[:'to_date'].nil? && opts[:'to_date'].to_s.strip != "" 
      query_params[:'to_date'] = opts[:'to_date']
  end
  if !opts[:'page_size'].nil? && opts[:'page_size'].to_s.strip != "" 
      query_params[:'page_size'] = opts[:'page_size']
  end
  if !opts[:'query_id'].nil? && opts[:'query_id'].to_s.strip != "" 
      query_params[:'query_id'] = opts[:'query_id']
  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?

  # 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 => 'RecordedPaymentsResponse')
  return data, status_code, headers
end