Class: CyberSource::VoidApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of VoidApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/void_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/void_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#mit_void(mit_void_request, opts = {}) ⇒ PtsV2PaymentsVoidsPost201Response

Timeout Void This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 29

def mit_void(mit_void_request, opts = {})
  data, status_code, headers = mit_void_with_http_info(mit_void_request, opts)
  return data, status_code, headers
end

#mit_void_with_http_info(mit_void_request, opts = {}) ⇒ Array<(PtsV2PaymentsVoidsPost201Response, Fixnum, Hash)>

Timeout Void This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -&gt; transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

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

    the optional parameters

Returns:



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

def mit_void_with_http_info(mit_void_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: VoidApi.mit_void ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'mit_void_request' is set
  if @api_client.config.client_side_validation && mit_void_request.nil?
    fail ArgumentError, "Missing the required parameter 'mit_void_request' when calling VoidApi.mit_void"
  end
  # resource path
  local_var_path = 'pts/v2/voids'

  # 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(mit_void_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'MitVoidRequest', @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, ["mit_void","mit_void_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["mit_void","mit_void_with_http_info"])

  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 => 'PtsV2PaymentsVoidsPost201Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: VoidApi#mit_void\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#void_capture(void_capture_request, id, opts = {}) ⇒ PtsV2PaymentsVoidsPost201Response

Void a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/id/captures](developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to cancel the capture.

Parameters:

  • void_capture_request
  • id —

    The capture ID returned from a previous capture request.

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

    the optional parameters

Returns:



111
112
113
114
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 111

def void_capture(void_capture_request, id, opts = {})
  data, status_code, headers = void_capture_with_http_info(void_capture_request, id, opts)
  return data, status_code, headers
end

#void_capture_with_http_info(void_capture_request, id, opts = {}) ⇒ Array<(PtsV2PaymentsVoidsPost201Response, Fixnum, Hash)>

Void a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/id/captures](developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to cancel the capture.

Parameters:

  • void_capture_request
  • id —

    The capture ID returned from a previous capture 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
182
183
184
185
186
187
188
189
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 122

def void_capture_with_http_info(void_capture_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: VoidApi.void_capture ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'void_capture_request' is set
  if @api_client.config.client_side_validation && void_capture_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_capture_request' when calling VoidApi.void_capture"
  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 VoidApi.void_capture"
  end
  # resource path
  local_var_path = 'pts/v2/captures/{id}/voids'.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(void_capture_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'VoidCaptureRequest', @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, ["void_capture","void_capture_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["void_capture","void_capture_with_http_info"])

  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 => 'PtsV2PaymentsVoidsPost201Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: VoidApi#void_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#void_credit(void_credit_request, id, opts = {}) ⇒ PtsV2PaymentsVoidsPost201Response

Void a Credit Include the credit ID in the POST request to cancel the credit.

Parameters:

  • void_credit_request
  • id —

    The credit ID returned from a previous credit request.

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

    the optional parameters

Returns:



198
199
200
201
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 198

def void_credit(void_credit_request, id, opts = {})
  data, status_code, headers = void_credit_with_http_info(void_credit_request, id, opts)
  return data, status_code, headers
end

#void_credit_with_http_info(void_credit_request, id, opts = {}) ⇒ Array<(PtsV2PaymentsVoidsPost201Response, Fixnum, Hash)>

Void a Credit Include the credit ID in the POST request to cancel the credit.

Parameters:

  • void_credit_request
  • id —

    The credit ID returned from a previous credit request.

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

    the optional parameters

Returns:



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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 209

def void_credit_with_http_info(void_credit_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: VoidApi.void_credit ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'void_credit_request' is set
  if @api_client.config.client_side_validation && void_credit_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_credit_request' when calling VoidApi.void_credit"
  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 VoidApi.void_credit"
  end
  # resource path
  local_var_path = 'pts/v2/credits/{id}/voids'.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(void_credit_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'VoidCreditRequest', @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, ["void_credit","void_credit_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["void_credit","void_credit_with_http_info"])

  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 => 'PtsV2PaymentsVoidsPost201Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: VoidApi#void_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#void_payment(void_payment_request, id, opts = {}) ⇒ PtsV2PaymentsVoidsPost201Response

Void a Payment Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to cancel the payment.

Parameters:

  • void_payment_request
  • id —

    The payment ID returned from a previous payment request.

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 285

def void_payment(void_payment_request, id, opts = {})
  data, status_code, headers = void_payment_with_http_info(void_payment_request, id, opts)
  return data, status_code, headers
end

#void_payment_with_http_info(void_payment_request, id, opts = {}) ⇒ Array<(PtsV2PaymentsVoidsPost201Response, Fixnum, Hash)>

Void a Payment Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to cancel the payment.

Parameters:

  • void_payment_request
  • id —

    The payment ID returned from a previous payment request.

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

    the optional parameters

Returns:



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
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 296

def void_payment_with_http_info(void_payment_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: VoidApi.void_payment ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'void_payment_request' is set
  if @api_client.config.client_side_validation && void_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_payment_request' when calling VoidApi.void_payment"
  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 VoidApi.void_payment"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{id}/voids'.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(void_payment_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'VoidPaymentRequest', @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, ["void_payment","void_payment_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["void_payment","void_payment_with_http_info"])

  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 => 'PtsV2PaymentsVoidsPost201Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: VoidApi#void_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#void_refund(void_refund_request, id, opts = {}) ⇒ PtsV2PaymentsVoidsPost201Response

Void a Refund Include the refund ID in the POST request to cancel the refund.

Parameters:

  • void_refund_request
  • id —

    The refund ID returned from a previous refund request.

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

    the optional parameters

Returns:



372
373
374
375
 
# File 'lib/cybersource_rest_client/api/void_api.rb', line 372

def void_refund(void_refund_request, id, opts = {})
  data, status_code, headers = void_refund_with_http_info(void_refund_request, id, opts)
  return data, status_code, headers
end

#void_refund_with_http_info(void_refund_request, id, opts = {}) ⇒ Array<(PtsV2PaymentsVoidsPost201Response, Fixnum, Hash)>

Void a Refund Include the refund ID in the POST request to cancel the refund.

Parameters:

  • void_refund_request
  • id —

    The refund ID returned from a previous refund request.

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

    the optional parameters

Returns:



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
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/cybersource_rest_client/api/void_api.rb', line 383

def void_refund_with_http_info(void_refund_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: VoidApi.void_refund ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'void_refund_request' is set
  if @api_client.config.client_side_validation && void_refund_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_refund_request' when calling VoidApi.void_refund"
  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 VoidApi.void_refund"
  end
  # resource path
  local_var_path = 'pts/v2/refunds/{id}/voids'.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(void_refund_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'VoidRefundRequest', @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, ["void_refund","void_refund_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["void_refund","void_refund_with_http_info"])

  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 => 'PtsV2PaymentsVoidsPost201Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: VoidApi#void_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end