Class: CyberSource::PaymentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/payments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ PaymentsApi

Returns a new instance of PaymentsApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 18

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_order_request(order_payment_request, id, opts = {}) ⇒ PtsV2PaymentsOrderPost201Response

Create a Payment Order Request Create a Payment Order Request

Parameters:

  • order_payment_request
  • id —

    Request identifier number for the order request.

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

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 30

def create_order_request(order_payment_request, id, opts = {})
  data, status_code, headers = create_order_request_with_http_info(order_payment_request, id, opts)
  return data, status_code, headers
end

#create_order_request_with_http_info(order_payment_request, id, opts = {}) ⇒ Array<(PtsV2PaymentsOrderPost201Response, Fixnum, Hash)>

Create a Payment Order Request Create a Payment Order Request

Parameters:

  • order_payment_request
  • id —

    Request identifier number for the order request.

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

    the optional parameters

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 41

def create_order_request_with_http_info(order_payment_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.create_order_request ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'order_payment_request' is set

  if @api_client.config.client_side_validation && order_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'order_payment_request' when calling PaymentsApi.create_order_request"
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PaymentsApi.create_order_request"
  end
  # resource path

  local_var_path = 'pts/v2/payment-references/{id}/intents'.sub('{' + 'id' + '}', 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/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(order_payment_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'OrderPaymentRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "optional"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["create_order_request","create_order_request_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'PtsV2PaymentsOrderPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#create_order_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#create_payment(create_payment_request, opts = {}) ⇒ PtsV2PaymentsPost201Response

Process a Payment A payment authorizes the amount for the transaction. There are a number of supported payment features, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation.

Parameters:

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

    the optional parameters

Returns:



112
113
114
115
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 112

def create_payment(create_payment_request, opts = {})
  data, status_code, headers = create_payment_with_http_info(create_payment_request, opts)
  return data, status_code, headers
end

#create_payment_with_http_info(create_payment_request, opts = {}) ⇒ Array<(PtsV2PaymentsPost201Response, Fixnum, Hash)>

Process a Payment A payment authorizes the amount for the transaction. There are a number of supported payment features, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation.

Parameters:

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

    the optional parameters

Returns:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 122

def create_payment_with_http_info(create_payment_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.create_payment ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'create_payment_request' is set

  if @api_client.config.client_side_validation && create_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_payment_request' when calling PaymentsApi.create_payment"
  end
  # resource path

  local_var_path = 'pts/v2/payments'

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(create_payment_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'CreatePaymentRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "optional"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["create_payment","create_payment_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'PtsV2PaymentsPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#create_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#create_session_request(create_session_req, opts = {}) ⇒ PtsV2PaymentsPost201Response2

Create Alternative Payments Sessions Request Create Alternative Payments Sessions Request

Parameters:

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 189

def create_session_request(create_session_req, opts = {})
  data, status_code, headers = create_session_request_with_http_info(create_session_req, opts)
  return data, status_code, headers
end

#create_session_request_with_http_info(create_session_req, opts = {}) ⇒ Array<(PtsV2PaymentsPost201Response2, Fixnum, Hash)>

Create Alternative Payments Sessions Request Create Alternative Payments Sessions Request

Parameters:

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

    the optional parameters

Returns:



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
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
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 199

def create_session_request_with_http_info(create_session_req, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.create_session_request ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'create_session_req' is set

  if @api_client.config.client_side_validation && create_session_req.nil?
    fail ArgumentError, "Missing the required parameter 'create_session_req' when calling PaymentsApi.create_session_request"
  end
  # resource path

  local_var_path = 'pts/v2/payment-references'

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(create_session_req)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'CreateSessionReq', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "optional"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["create_session_request","create_session_request_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'PtsV2PaymentsPost201Response2')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#create_session_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#increment_auth(id, increment_auth_request, opts = {}) ⇒ PtsV2IncrementalAuthorizationPatch201Response

Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization.

Parameters:

  • id —

    The ID returned from the original authorization request.

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

    the optional parameters

Returns:



267
268
269
270
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 267

def increment_auth(id, increment_auth_request, opts = {})
  data, status_code, headers = increment_auth_with_http_info(id, increment_auth_request, opts)
  return data, status_code, headers
end

#increment_auth_with_http_info(id, increment_auth_request, opts = {}) ⇒ Array<(PtsV2IncrementalAuthorizationPatch201Response, Fixnum, Hash)>

Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization.

Parameters:

  • id —

    The ID returned from the original authorization request.

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

    the optional parameters

Returns:



278
279
280
281
282
283
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
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 278

def increment_auth_with_http_info(id, increment_auth_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.increment_auth ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PaymentsApi.increment_auth"
  end
  # verify the required parameter 'increment_auth_request' is set

  if @api_client.config.client_side_validation && increment_auth_request.nil?
    fail ArgumentError, "Missing the required parameter 'increment_auth_request' when calling PaymentsApi.increment_auth"
  end
  # resource path

  local_var_path = 'pts/v2/payments/{id}'.sub('{' + 'id' + '}', 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/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(increment_auth_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'IncrementAuthRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "optional"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["increment_auth","increment_auth_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PtsV2IncrementalAuthorizationPatch201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#increment_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#refresh_payment_status(id, refresh_payment_status_request, opts = {}) ⇒ PtsV2PaymentsPost201Response1

Check a Payment Status Checks and updates the payment status

Parameters:

  • id —

    The payment id whose status needs to be checked and updated.

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

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 350

def refresh_payment_status(id, refresh_payment_status_request, opts = {})
  data, status_code, headers = refresh_payment_status_with_http_info(id, refresh_payment_status_request, opts)
  return data, status_code, headers
end

#refresh_payment_status_with_http_info(id, refresh_payment_status_request, opts = {}) ⇒ Array<(PtsV2PaymentsPost201Response1, Fixnum, Hash)>

Check a Payment Status Checks and updates the payment status

Parameters:

  • id —

    The payment id whose status needs to be checked and updated.

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

    the optional parameters

Returns:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 361

def refresh_payment_status_with_http_info(id, refresh_payment_status_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.refresh_payment_status ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PaymentsApi.refresh_payment_status"
  end
  # verify the required parameter 'refresh_payment_status_request' is set

  if @api_client.config.client_side_validation && refresh_payment_status_request.nil?
    fail ArgumentError, "Missing the required parameter 'refresh_payment_status_request' when calling PaymentsApi.refresh_payment_status"
  end
  # resource path

  local_var_path = 'pts/v2/refresh-payment-status/{id}'.sub('{' + 'id' + '}', 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/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(refresh_payment_status_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'RefreshPaymentStatusRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "optional"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["refresh_payment_status","refresh_payment_status_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'PtsV2PaymentsPost201Response1')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#refresh_payment_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#update_session_req(create_session_request, id, opts = {}) ⇒ PtsV2PaymentsPost201Response2

Update Alternative Payments Sessions Request Update Alternative Payments Sessions Request

Parameters:

  • create_session_request
  • id —

    The payment ID. This ID is returned from a previous payment request.

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

    the optional parameters

Returns:



433
434
435
436
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 433

def update_session_req(create_session_request, id, opts = {})
  data, status_code, headers = update_session_req_with_http_info(create_session_request, id, opts)
  return data, status_code, headers
end

#update_session_req_with_http_info(create_session_request, id, opts = {}) ⇒ Array<(PtsV2PaymentsPost201Response2, Fixnum, Hash)>

Update Alternative Payments Sessions Request Update Alternative Payments Sessions Request

Parameters:

  • create_session_request
  • id —

    The payment ID. This ID is returned from a previous payment request.

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

    the optional parameters

Returns:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 444

def update_session_req_with_http_info(create_session_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.update_session_req ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'create_session_request' is set

  if @api_client.config.client_side_validation && create_session_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_session_request' when calling PaymentsApi.update_session_req"
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PaymentsApi.update_session_req"
  end
  # resource path

  local_var_path = 'pts/v2/payment-references/{id}'.sub('{' + 'id' + '}', 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/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(create_session_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'CreateSessionRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "optional"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["update_session_req","update_session_req_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PtsV2PaymentsPost201Response2')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#update_session_req\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end