Class: PostfinancecheckoutRubySdk::TransactionsService

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionsService

Returns a new instance of TransactionsService.



28
29
30
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 28

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



25
26
27
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 25

def api_client
  @api_client
end

Instance Method Details

#delete_payment_transactions_by_credentials_credentials_one_click_tokens_id(credentials, id, space, opts = {}) ⇒ nil

Delete a one-click token by credentials

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (nil) 


37
38
39
40
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 37

def delete_payment_transactions_by_credentials_credentials_one_click_tokens_id(credentials, id, space, opts = {})
  delete_payment_transactions_by_credentials_credentials_one_click_tokens_id_with_http_info(credentials, id, space, opts)
  nil
end

#delete_payment_transactions_by_credentials_credentials_one_click_tokens_id_with_http_info(credentials, id, space, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 49

def delete_payment_transactions_by_credentials_credentials_one_click_tokens_id_with_http_info(credentials, id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.delete_payment_transactions_by_credentials_credentials_one_click_tokens_id ...'
  end
  # verify the required parameter 'credentials' is set
  if @api_client.config.client_side_validation && credentials.nil?
    fail ArgumentError, "Missing the required parameter 'credentials' when calling TransactionsService.delete_payment_transactions_by_credentials_credentials_one_click_tokens_id"
  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 TransactionsService.delete_payment_transactions_by_credentials_credentials_one_click_tokens_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.delete_payment_transactions_by_credentials_credentials_one_click_tokens_id"
  end
  # resource path
  local_var_path = '/payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  new_options = opts.merge(
    :operation => :"TransactionsService.delete_payment_transactions_by_credentials_credentials_one_click_tokens_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#delete_payment_transactions_by_credentials_credentials_one_click_tokens_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions(space, opts = {}) ⇒ TransactionListResponse

List all transactions

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:



115
116
117
118
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 115

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

#get_payment_transactions_by_credentials_credentials(credentials, space, opts = {}) ⇒ Transaction

Retrieve a transaction by credentials

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



206
207
208
209
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 206

def get_payment_transactions_by_credentials_credentials(credentials, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_by_credentials_credentials_with_http_info(credentials, space, opts)
  data
end

#get_payment_transactions_by_credentials_credentials_mobile_sdk_url(credentials, space, opts = {}) ⇒ String

Retrieve a Mobile SDK URL by credentials

Parameters:

  • credentials (String) —

    The credentials identify the transaction and contain the security details which grant the access to this operation.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


277
278
279
280
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 277

def get_payment_transactions_by_credentials_credentials_mobile_sdk_url(credentials, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_by_credentials_credentials_mobile_sdk_url_with_http_info(credentials, space, opts)
  data
end

#get_payment_transactions_by_credentials_credentials_mobile_sdk_url_with_http_info(credentials, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • credentials (String) —

    The credentials identify the transaction and contain the security details which grant the access to this operation.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 288

def get_payment_transactions_by_credentials_credentials_mobile_sdk_url_with_http_info(credentials, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_by_credentials_credentials_mobile_sdk_url ...'
  end
  # verify the required parameter 'credentials' is set
  if @api_client.config.client_side_validation && credentials.nil?
    fail ArgumentError, "Missing the required parameter 'credentials' when calling TransactionsService.get_payment_transactions_by_credentials_credentials_mobile_sdk_url"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_by_credentials_credentials_mobile_sdk_url"
  end
  # resource path
  local_var_path = '/payment/transactions/by-credentials/{credentials}/mobile-sdk-url'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_by_credentials_credentials_mobile_sdk_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_by_credentials_credentials_mobile_sdk_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_by_credentials_credentials_one_click_tokens(credentials, space, opts = {}) ⇒ TokenVersionListResponse

List one-click tokens by credentials

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



347
348
349
350
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 347

def get_payment_transactions_by_credentials_credentials_one_click_tokens(credentials, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_by_credentials_credentials_one_click_tokens_with_http_info(credentials, space, opts)
  data
end

#get_payment_transactions_by_credentials_credentials_one_click_tokens_with_http_info(credentials, space, opts = {}) ⇒ Array<(TokenVersionListResponse, Integer, Hash)>

Returns TokenVersionListResponse data, response status code and response headers.

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TokenVersionListResponse, Integer, Hash)>) —

    TokenVersionListResponse data, response status code and response headers



359
360
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
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 359

def get_payment_transactions_by_credentials_credentials_one_click_tokens_with_http_info(credentials, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_by_credentials_credentials_one_click_tokens ...'
  end
  # verify the required parameter 'credentials' is set
  if @api_client.config.client_side_validation && credentials.nil?
    fail ArgumentError, "Missing the required parameter 'credentials' when calling TransactionsService.get_payment_transactions_by_credentials_credentials_one_click_tokens"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_by_credentials_credentials_one_click_tokens"
  end
  # resource path
  local_var_path = '/payment/transactions/by-credentials/{credentials}/one-click-tokens'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TokenVersionListResponse'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_by_credentials_credentials_one_click_tokens",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_by_credentials_credentials_one_click_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_by_credentials_credentials_payment_method_configurations(credentials, integration_mode, space, opts = {}) ⇒ PaymentMethodConfigurationListResponse

List available payment method configurations by credentials

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • integration_mode (String)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



420
421
422
423
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 420

def get_payment_transactions_by_credentials_credentials_payment_method_configurations(credentials, integration_mode, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_by_credentials_credentials_payment_method_configurations_with_http_info(credentials, integration_mode, space, opts)
  data
end

#get_payment_transactions_by_credentials_credentials_payment_method_configurations_with_http_info(credentials, integration_mode, space, opts = {}) ⇒ Array<(PaymentMethodConfigurationListResponse, Integer, Hash)>

Returns PaymentMethodConfigurationListResponse data, response status code and response headers.

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • integration_mode (String)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



433
434
435
436
437
438
439
440
441
442
443
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
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 433

def get_payment_transactions_by_credentials_credentials_payment_method_configurations_with_http_info(credentials, integration_mode, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_by_credentials_credentials_payment_method_configurations ...'
  end
  # verify the required parameter 'credentials' is set
  if @api_client.config.client_side_validation && credentials.nil?
    fail ArgumentError, "Missing the required parameter 'credentials' when calling TransactionsService.get_payment_transactions_by_credentials_credentials_payment_method_configurations"
  end
  # verify the required parameter 'integration_mode' is set
  if @api_client.config.client_side_validation && integration_mode.nil?
    fail ArgumentError, "Missing the required parameter 'integration_mode' when calling TransactionsService.get_payment_transactions_by_credentials_credentials_payment_method_configurations"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_by_credentials_credentials_payment_method_configurations"
  end
  # resource path
  local_var_path = '/payment/transactions/by-credentials/{credentials}/payment-method-configurations'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integrationMode'] = integration_mode
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentMethodConfigurationListResponse'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_by_credentials_credentials_payment_method_configurations",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_by_credentials_credentials_payment_method_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_by_credentials_credentials_with_http_info(credentials, space, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



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
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 218

def get_payment_transactions_by_credentials_credentials_with_http_info(credentials, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_by_credentials_credentials ...'
  end
  # verify the required parameter 'credentials' is set
  if @api_client.config.client_side_validation && credentials.nil?
    fail ArgumentError, "Missing the required parameter 'credentials' when calling TransactionsService.get_payment_transactions_by_credentials_credentials"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_by_credentials_credentials"
  end
  # resource path
  local_var_path = '/payment/transactions/by-credentials/{credentials}'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_by_credentials_credentials",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_by_credentials_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_export(space, opts = {}) ⇒ File

Export transactions

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to be included in the export.

  • :limit (Integer) —

    A limit on the number of objects to be returned. Default is 2,000.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:

  • (File) 


501
502
503
504
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 501

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

#get_payment_transactions_export_with_http_info(space, opts = {}) ⇒ Array<(File, Integer, Hash)>

Export transactions Timeout for this request is: 60 seconds.

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to be included in the export.

  • :limit (Integer) —

    A limit on the number of objects to be returned. Default is 2,000.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 516

def get_payment_transactions_export_with_http_info(space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_export ...'
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_export"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionsService.get_payment_transactions_export, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 100000
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling TransactionsService.get_payment_transactions_export, must be smaller than or equal to 100000.'
  end

  # resource path
  local_var_path = '/payment/transactions/export'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) unless opts[:'fields'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] unless opts[:'offset'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] unless opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = 60

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_export",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id(id, space, opts = {}) ⇒ Transaction

Retrieve a transaction

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



584
585
586
587
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 584

def get_payment_transactions_id(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_charge_flow_payment_page_url(id, space, opts = {}) ⇒ String

Retrieve a charge flow payment page URL

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


655
656
657
658
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 655

def get_payment_transactions_id_charge_flow_payment_page_url(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_charge_flow_payment_page_url_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_charge_flow_payment_page_url_with_http_info(id, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 666

def get_payment_transactions_id_charge_flow_payment_page_url_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_charge_flow_payment_page_url ...'
  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 TransactionsService.get_payment_transactions_id_charge_flow_payment_page_url"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_charge_flow_payment_page_url"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/charge-flow/payment-page-url'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_charge_flow_payment_page_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_charge_flow_payment_page_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_check_token_creation_possible(id, space, opts = {}) ⇒ Boolean

Check if token can be created

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Boolean) 


724
725
726
727
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 724

def get_payment_transactions_id_check_token_creation_possible(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_check_token_creation_possible_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_check_token_creation_possible_with_http_info(id, space, opts = {}) ⇒ Array<(Boolean, Integer, Hash)>

Returns Boolean data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(Boolean, Integer, Hash)>) —

    Boolean data, response status code and response headers



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 735

def get_payment_transactions_id_check_token_creation_possible_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_check_token_creation_possible ...'
  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 TransactionsService.get_payment_transactions_id_check_token_creation_possible"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_check_token_creation_possible"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/check-token-creation-possible'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Boolean'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_check_token_creation_possible",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_check_token_creation_possible\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_credentials(id, space, opts = {}) ⇒ String

Retrieve transaction credentials Generates temporary transaction credentials to delegate access to the REST API for the specified transaction.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


794
795
796
797
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 794

def get_payment_transactions_id_credentials(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_credentials_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_credentials_with_http_info(id, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 806

def get_payment_transactions_id_credentials_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_credentials ...'
  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 TransactionsService.get_payment_transactions_id_credentials"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_credentials"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/credentials'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_credentials",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_iframe_javascript_url(id, space, opts = {}) ⇒ String

Retrieve an iFrame JavaScript URL

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


864
865
866
867
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 864

def get_payment_transactions_id_iframe_javascript_url(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_iframe_javascript_url_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_iframe_javascript_url_with_http_info(id, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 875

def get_payment_transactions_id_iframe_javascript_url_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_iframe_javascript_url ...'
  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 TransactionsService.get_payment_transactions_id_iframe_javascript_url"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_iframe_javascript_url"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/iframe-javascript-url'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_iframe_javascript_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_iframe_javascript_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_invoice_document(id, space, opts = {}) ⇒ RenderedDocument

Retrieve an invoice document

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:



933
934
935
936
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 933

def get_payment_transactions_id_invoice_document(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_invoice_document_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_invoice_document_with_http_info(id, space, opts = {}) ⇒ Array<(RenderedDocument, Integer, Hash)>

Returns RenderedDocument data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(RenderedDocument, Integer, Hash)>) —

    RenderedDocument data, response status code and response headers



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 944

def get_payment_transactions_id_invoice_document_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_invoice_document ...'
  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 TransactionsService.get_payment_transactions_id_invoice_document"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_invoice_document"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/invoice-document'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RenderedDocument'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_invoice_document",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_invoice_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_latest_line_item_version(id, space, opts = {}) ⇒ TransactionLineItemVersion

Retrieve the latest line item version

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1003
1004
1005
1006
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1003

def get_payment_transactions_id_latest_line_item_version(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_latest_line_item_version_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_latest_line_item_version_with_http_info(id, space, opts = {}) ⇒ Array<(TransactionLineItemVersion, Integer, Hash)>

Returns TransactionLineItemVersion data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TransactionLineItemVersion, Integer, Hash)>) —

    TransactionLineItemVersion data, response status code and response headers



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1015

def get_payment_transactions_id_latest_line_item_version_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_latest_line_item_version ...'
  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 TransactionsService.get_payment_transactions_id_latest_line_item_version"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_latest_line_item_version"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/latest-line-item-version'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionLineItemVersion'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_latest_line_item_version",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_latest_line_item_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_lightbox_javascript_url(id, space, opts = {}) ⇒ String

Retrieve a Lightbox JavaScript URL

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


1074
1075
1076
1077
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1074

def get_payment_transactions_id_lightbox_javascript_url(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_lightbox_javascript_url_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_lightbox_javascript_url_with_http_info(id, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1085

def get_payment_transactions_id_lightbox_javascript_url_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_lightbox_javascript_url ...'
  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 TransactionsService.get_payment_transactions_id_lightbox_javascript_url"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_lightbox_javascript_url"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/lightbox-javascript-url'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_lightbox_javascript_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_lightbox_javascript_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_packing_slip_document(id, space, opts = {}) ⇒ RenderedDocument

Retrieve a packing slip document

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:



1143
1144
1145
1146
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1143

def get_payment_transactions_id_packing_slip_document(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_packing_slip_document_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_packing_slip_document_with_http_info(id, space, opts = {}) ⇒ Array<(RenderedDocument, Integer, Hash)>

Returns RenderedDocument data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(RenderedDocument, Integer, Hash)>) —

    RenderedDocument data, response status code and response headers



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1154

def get_payment_transactions_id_packing_slip_document_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_packing_slip_document ...'
  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 TransactionsService.get_payment_transactions_id_packing_slip_document"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_packing_slip_document"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/packing-slip-document'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RenderedDocument'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_packing_slip_document",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_packing_slip_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_payment_method_configurations(id, integration_mode, space, opts = {}) ⇒ PaymentMethodConfigurationListResponse

List available payment method configurations

Parameters:

  • id (Integer)
  • integration_mode (String)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1214
1215
1216
1217
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1214

def get_payment_transactions_id_payment_method_configurations(id, integration_mode, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_payment_method_configurations_with_http_info(id, integration_mode, space, opts)
  data
end

#get_payment_transactions_id_payment_method_configurations_with_http_info(id, integration_mode, space, opts = {}) ⇒ Array<(PaymentMethodConfigurationListResponse, Integer, Hash)>

Returns PaymentMethodConfigurationListResponse data, response status code and response headers.

Parameters:

  • id (Integer)
  • integration_mode (String)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1227

def get_payment_transactions_id_payment_method_configurations_with_http_info(id, integration_mode, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_payment_method_configurations ...'
  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 TransactionsService.get_payment_transactions_id_payment_method_configurations"
  end
  # verify the required parameter 'integration_mode' is set
  if @api_client.config.client_side_validation && integration_mode.nil?
    fail ArgumentError, "Missing the required parameter 'integration_mode' when calling TransactionsService.get_payment_transactions_id_payment_method_configurations"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_payment_method_configurations"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/payment-method-configurations'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integrationMode'] = integration_mode
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentMethodConfigurationListResponse'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_payment_method_configurations",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_payment_method_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_payment_page_url(id, space, opts = {}) ⇒ String

Retrieve a payment page URL

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


1291
1292
1293
1294
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1291

def get_payment_transactions_id_payment_page_url(id, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_payment_page_url_with_http_info(id, space, opts)
  data
end

#get_payment_transactions_id_payment_page_url_with_http_info(id, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1302

def get_payment_transactions_id_payment_page_url_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_payment_page_url ...'
  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 TransactionsService.get_payment_transactions_id_payment_page_url"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_payment_page_url"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/payment-page-url'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_payment_page_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_payment_page_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_terminal_receipts(id, format, width, space, opts = {}) ⇒ RenderedTerminalReceiptListResponse

List terminal receipts

Parameters:

  • id (Integer)
  • format (TerminalReceiptFormat) —

    The format specifies how the receipts will be presented in the response.

  • width (Integer) —

    The width defines the dimensions for rendering the document. For PDF format, the width is specified in millimeters, while for text format, it represents the number of characters per line.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:



1362
1363
1364
1365
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1362

def get_payment_transactions_id_terminal_receipts(id, format, width, space, opts = {})
  data, _status_code, _headers = get_payment_transactions_id_terminal_receipts_with_http_info(id, format, width, space, opts)
  data
end

#get_payment_transactions_id_terminal_receipts_with_http_info(id, format, width, space, opts = {}) ⇒ Array<(RenderedTerminalReceiptListResponse, Integer, Hash)>

Returns RenderedTerminalReceiptListResponse data, response status code and response headers.

Parameters:

  • id (Integer)
  • format (TerminalReceiptFormat) —

    The format specifies how the receipts will be presented in the response.

  • width (Integer) —

    The width defines the dimensions for rendering the document. For PDF format, the width is specified in millimeters, while for text format, it represents the number of characters per line.

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1375

def get_payment_transactions_id_terminal_receipts_with_http_info(id, format, width, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id_terminal_receipts ...'
  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 TransactionsService.get_payment_transactions_id_terminal_receipts"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling TransactionsService.get_payment_transactions_id_terminal_receipts"
  end
  # verify the required parameter 'width' is set
  if @api_client.config.client_side_validation && width.nil?
    fail ArgumentError, "Missing the required parameter 'width' when calling TransactionsService.get_payment_transactions_id_terminal_receipts"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id_terminal_receipts"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/terminal-receipts'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'format'] = format
  query_params[:'width'] = width

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RenderedTerminalReceiptListResponse'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id_terminal_receipts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id_terminal_receipts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_id_with_http_info(id, space, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 596

def get_payment_transactions_id_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_id ...'
  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 TransactionsService.get_payment_transactions_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_id"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_search(space, opts = {}) ⇒ TransactionSearchResponse

Search transactions

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:



1447
1448
1449
1450
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1447

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

#get_payment_transactions_search_with_http_info(space, opts = {}) ⇒ Array<(TransactionSearchResponse, Integer, Hash)>

Returns TransactionSearchResponse data, response status code and response headers.

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:

  • (Array<(TransactionSearchResponse, Integer, Hash)>) —

    TransactionSearchResponse data, response status code and response headers



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1462

def get_payment_transactions_search_with_http_info(space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions_search ...'
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions_search"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionsService.get_payment_transactions_search, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionsService.get_payment_transactions_search, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling TransactionsService.get_payment_transactions_search, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = '/payment/transactions/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] unless opts[:'offset'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] unless opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionSearchResponse'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_payment_transactions_with_http_info(space, opts = {}) ⇒ Array<(TransactionListResponse, Integer, Hash)>

Returns TransactionListResponse data, response status code and response headers.

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:

  • (Array<(TransactionListResponse, Integer, Hash)>) —

    TransactionListResponse data, response status code and response headers



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
190
191
192
193
194
195
196
197
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 130

def get_payment_transactions_with_http_info(space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.get_payment_transactions ...'
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.get_payment_transactions"
  end
  if @api_client.config.client_side_validation && !opts[:'after'].nil? && opts[:'after'] < 1
    fail ArgumentError, 'invalid value for "opts[:"after"]" when calling TransactionsService.get_payment_transactions, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'before'].nil? && opts[:'before'] < 1
    fail ArgumentError, 'invalid value for "opts[:"before"]" when calling TransactionsService.get_payment_transactions, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionsService.get_payment_transactions, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionsService.get_payment_transactions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/payment/transactions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] unless opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] unless opts[:'before'].nil?
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionListResponse'

  new_options = opts.merge(
    :operation => :"TransactionsService.get_payment_transactions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#get_payment_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#patch_payment_transactions_id(id, space, transaction_pending, opts = {}) ⇒ Transaction

Update a transaction

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1535
1536
1537
1538
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1535

def patch_payment_transactions_id(id, space, transaction_pending, opts = {})
  data, _status_code, _headers = patch_payment_transactions_id_with_http_info(id, space, transaction_pending, opts)
  data
end

#patch_payment_transactions_id_with_http_info(id, space, transaction_pending, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1548

def patch_payment_transactions_id_with_http_info(id, space, transaction_pending, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.patch_payment_transactions_id ...'
  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 TransactionsService.patch_payment_transactions_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.patch_payment_transactions_id"
  end
  # verify the required parameter 'transaction_pending' is set
  if @api_client.config.client_side_validation && transaction_pending.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_pending' when calling TransactionsService.patch_payment_transactions_id"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_pending)

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.patch_payment_transactions_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#patch_payment_transactions_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions(space, transaction_create, opts = {}) ⇒ Transaction

Create a transaction

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1617
1618
1619
1620
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1617

def post_payment_transactions(space, transaction_create, opts = {})
  data, _status_code, _headers = post_payment_transactions_with_http_info(space, transaction_create, opts)
  data
end

#post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process(credentials, id, space, opts = {}) ⇒ String

Process via one-click token by credentials Assigns the provided token to the transaction, processes it, and returns a URL for customer redirection to complete the transaction.

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


1695
1696
1697
1698
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1695

def post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process(credentials, id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process_with_http_info(credentials, id, space, opts)
  data
end

#post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process_with_http_info(credentials, id, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • credentials (String) —

    Identifies the transaction and includes the security details required to authorize access to this operation.

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1708

def post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process_with_http_info(credentials, id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process ...'
  end
  # verify the required parameter 'credentials' is set
  if @api_client.config.client_side_validation && credentials.nil?
    fail ArgumentError, "Missing the required parameter 'credentials' when calling TransactionsService.post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process"
  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 TransactionsService.post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process"
  end
  # resource path
  local_var_path = '/payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}/process'.sub('{' + 'credentials' + '}', CGI.escape(credentials.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_charge_flow_apply(id, space, opts = {}) ⇒ Transaction

Process a transaction via charge flow

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1771
1772
1773
1774
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1771

def post_payment_transactions_id_charge_flow_apply(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_charge_flow_apply_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_charge_flow_apply_with_http_info(id, space, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1783

def post_payment_transactions_id_charge_flow_apply_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_charge_flow_apply ...'
  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 TransactionsService.post_payment_transactions_id_charge_flow_apply"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_charge_flow_apply"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/charge-flow/apply'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_charge_flow_apply",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_charge_flow_apply\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_charge_flow_cancel(id, space, opts = {}) ⇒ Transaction

Cancel a charge flow

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1843
1844
1845
1846
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1843

def post_payment_transactions_id_charge_flow_cancel(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_charge_flow_cancel_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_charge_flow_cancel_with_http_info(id, space, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1855

def post_payment_transactions_id_charge_flow_cancel_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_charge_flow_cancel ...'
  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 TransactionsService.post_payment_transactions_id_charge_flow_cancel"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_charge_flow_cancel"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/charge-flow/cancel'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_charge_flow_cancel",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_charge_flow_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_charge_flow_update_recipient(id, type, recipient, space, opts = {}) ⇒ nil

Update a charge flow recipient

Parameters:

  • id (Integer)
  • type (Integer)
  • recipient (String)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (nil) 


1916
1917
1918
1919
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1916

def post_payment_transactions_id_charge_flow_update_recipient(id, type, recipient, space, opts = {})
  post_payment_transactions_id_charge_flow_update_recipient_with_http_info(id, type, recipient, space, opts)
  nil
end

#post_payment_transactions_id_charge_flow_update_recipient_with_http_info(id, type, recipient, space, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • id (Integer)
  • type (Integer)
  • recipient (String)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1929

def post_payment_transactions_id_charge_flow_update_recipient_with_http_info(id, type, recipient, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_charge_flow_update_recipient ...'
  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 TransactionsService.post_payment_transactions_id_charge_flow_update_recipient"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling TransactionsService.post_payment_transactions_id_charge_flow_update_recipient"
  end
  # verify the required parameter 'recipient' is set
  if @api_client.config.client_side_validation && recipient.nil?
    fail ArgumentError, "Missing the required parameter 'recipient' when calling TransactionsService.post_payment_transactions_id_charge_flow_update_recipient"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_charge_flow_update_recipient"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/charge-flow/update-recipient'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = type
  query_params[:'recipient'] = recipient

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_charge_flow_update_recipient",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_charge_flow_update_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_complete_offline(id, space, opts = {}) ⇒ TransactionCompletion

Complete a transaction offline

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



1998
1999
2000
2001
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1998

def post_payment_transactions_id_complete_offline(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_complete_offline_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_complete_offline_with_http_info(id, space, opts = {}) ⇒ Array<(TransactionCompletion, Integer, Hash)>

Returns TransactionCompletion data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TransactionCompletion, Integer, Hash)>) —

    TransactionCompletion data, response status code and response headers



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2010

def post_payment_transactions_id_complete_offline_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_complete_offline ...'
  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 TransactionsService.post_payment_transactions_id_complete_offline"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_complete_offline"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/complete-offline'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionCompletion'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_complete_offline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_complete_offline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_complete_online(id, space, opts = {}) ⇒ TransactionCompletion

Complete a transaction online

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2070
2071
2072
2073
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2070

def post_payment_transactions_id_complete_online(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_complete_online_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_complete_online_with_http_info(id, space, opts = {}) ⇒ Array<(TransactionCompletion, Integer, Hash)>

Returns TransactionCompletion data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TransactionCompletion, Integer, Hash)>) —

    TransactionCompletion data, response status code and response headers



2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2082

def post_payment_transactions_id_complete_online_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_complete_online ...'
  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 TransactionsService.post_payment_transactions_id_complete_online"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_complete_online"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/complete-online'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionCompletion'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_complete_online",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_complete_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_complete_partially_offline(id, space, transaction_completion_details, opts = {}) ⇒ TransactionCompletion

Complete a transaction offline partially

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2143
2144
2145
2146
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2143

def post_payment_transactions_id_complete_partially_offline(id, space, transaction_completion_details, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_complete_partially_offline_with_http_info(id, space, transaction_completion_details, opts)
  data
end

#post_payment_transactions_id_complete_partially_offline_with_http_info(id, space, transaction_completion_details, opts = {}) ⇒ Array<(TransactionCompletion, Integer, Hash)>

Returns TransactionCompletion data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TransactionCompletion, Integer, Hash)>) —

    TransactionCompletion data, response status code and response headers



2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2156

def post_payment_transactions_id_complete_partially_offline_with_http_info(id, space, transaction_completion_details, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_complete_partially_offline ...'
  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 TransactionsService.post_payment_transactions_id_complete_partially_offline"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_complete_partially_offline"
  end
  # verify the required parameter 'transaction_completion_details' is set
  if @api_client.config.client_side_validation && transaction_completion_details.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_completion_details' when calling TransactionsService.post_payment_transactions_id_complete_partially_offline"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/complete-partially-offline'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_completion_details)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionCompletion'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_complete_partially_offline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_complete_partially_offline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_complete_partially_online(id, space, transaction_completion_details, opts = {}) ⇒ TransactionCompletion

Complete a transaction online partially

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2226
2227
2228
2229
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2226

def post_payment_transactions_id_complete_partially_online(id, space, transaction_completion_details, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_complete_partially_online_with_http_info(id, space, transaction_completion_details, opts)
  data
end

#post_payment_transactions_id_complete_partially_online_with_http_info(id, space, transaction_completion_details, opts = {}) ⇒ Array<(TransactionCompletion, Integer, Hash)>

Returns TransactionCompletion data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TransactionCompletion, Integer, Hash)>) —

    TransactionCompletion data, response status code and response headers



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2239

def post_payment_transactions_id_complete_partially_online_with_http_info(id, space, transaction_completion_details, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_complete_partially_online ...'
  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 TransactionsService.post_payment_transactions_id_complete_partially_online"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_complete_partially_online"
  end
  # verify the required parameter 'transaction_completion_details' is set
  if @api_client.config.client_side_validation && transaction_completion_details.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_completion_details' when calling TransactionsService.post_payment_transactions_id_complete_partially_online"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/complete-partially-online'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_completion_details)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionCompletion'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_complete_partially_online",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_complete_partially_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_confirm(id, space, transaction_pending, opts = {}) ⇒ Transaction

Confirm a transaction

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2309
2310
2311
2312
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2309

def post_payment_transactions_id_confirm(id, space, transaction_pending, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_confirm_with_http_info(id, space, transaction_pending, opts)
  data
end

#post_payment_transactions_id_confirm_with_http_info(id, space, transaction_pending, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2322

def post_payment_transactions_id_confirm_with_http_info(id, space, transaction_pending, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_confirm ...'
  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 TransactionsService.post_payment_transactions_id_confirm"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_confirm"
  end
  # verify the required parameter 'transaction_pending' is set
  if @api_client.config.client_side_validation && transaction_pending.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_pending' when calling TransactionsService.post_payment_transactions_id_confirm"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/confirm'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_pending)

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_confirm",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_process_card_details(id, space, authenticated_card_request, opts = {}) ⇒ Transaction

Process a card transaction

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2392
2393
2394
2395
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2392

def post_payment_transactions_id_process_card_details(id, space, authenticated_card_request, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_process_card_details_with_http_info(id, space, authenticated_card_request, opts)
  data
end

#post_payment_transactions_id_process_card_details_threed(id, space, tokenized_card_request, opts = {}) ⇒ String

Process a card transaction with 3-D Secure Processes the transaction using the provided card details, potentially utilizing 3-D Secure. Returns a URL where the buyer must be redirected to complete the transaction.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


2475
2476
2477
2478
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2475

def post_payment_transactions_id_process_card_details_threed(id, space, tokenized_card_request, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_process_card_details_threed_with_http_info(id, space, tokenized_card_request, opts)
  data
end

#post_payment_transactions_id_process_card_details_threed_with_http_info(id, space, tokenized_card_request, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2488

def post_payment_transactions_id_process_card_details_threed_with_http_info(id, space, tokenized_card_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_process_card_details_threed ...'
  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 TransactionsService.post_payment_transactions_id_process_card_details_threed"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_process_card_details_threed"
  end
  # verify the required parameter 'tokenized_card_request' is set
  if @api_client.config.client_side_validation && tokenized_card_request.nil?
    fail ArgumentError, "Missing the required parameter 'tokenized_card_request' when calling TransactionsService.post_payment_transactions_id_process_card_details_threed"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/process-card-details-threed'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(tokenized_card_request)

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_process_card_details_threed",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_process_card_details_threed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_process_card_details_with_http_info(id, space, authenticated_card_request, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2405

def post_payment_transactions_id_process_card_details_with_http_info(id, space, authenticated_card_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_process_card_details ...'
  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 TransactionsService.post_payment_transactions_id_process_card_details"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_process_card_details"
  end
  # verify the required parameter 'authenticated_card_request' is set
  if @api_client.config.client_side_validation && authenticated_card_request.nil?
    fail ArgumentError, "Missing the required parameter 'authenticated_card_request' when calling TransactionsService.post_payment_transactions_id_process_card_details"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/process-card-details'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(authenticated_card_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_process_card_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_process_card_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_process_with_token(id, space, opts = {}) ⇒ Charge

Process a transaction via token

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2556
2557
2558
2559
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2556

def post_payment_transactions_id_process_with_token(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_process_with_token_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_process_with_token_with_http_info(id, space, opts = {}) ⇒ Array<(Charge, Integer, Hash)>

Returns Charge data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Charge, Integer, Hash)>) —

    Charge data, response status code and response headers



2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2568

def post_payment_transactions_id_process_with_token_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_process_with_token ...'
  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 TransactionsService.post_payment_transactions_id_process_with_token"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_process_with_token"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/process-with-token'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Charge'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_process_with_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_process_with_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_process_without_interaction(id, space, opts = {}) ⇒ Transaction

Process a transaction without user-interaction

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2628
2629
2630
2631
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2628

def post_payment_transactions_id_process_without_interaction(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_process_without_interaction_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_process_without_interaction_with_http_info(id, space, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2640

def post_payment_transactions_id_process_without_interaction_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_process_without_interaction ...'
  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 TransactionsService.post_payment_transactions_id_process_without_interaction"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_process_without_interaction"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/process-without-interaction'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_process_without_interaction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_process_without_interaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_void_offline(id, space, opts = {}) ⇒ TransactionVoid

Void a transaction offline

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2700
2701
2702
2703
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2700

def post_payment_transactions_id_void_offline(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_void_offline_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_void_offline_with_http_info(id, space, opts = {}) ⇒ Array<(TransactionVoid, Integer, Hash)>

Returns TransactionVoid data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TransactionVoid, Integer, Hash)>) —

    TransactionVoid data, response status code and response headers



2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2712

def post_payment_transactions_id_void_offline_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_void_offline ...'
  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 TransactionsService.post_payment_transactions_id_void_offline"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_void_offline"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/void-offline'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionVoid'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_void_offline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_void_offline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_id_void_online(id, space, opts = {}) ⇒ TransactionVoid

Void a transaction online

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



2772
2773
2774
2775
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2772

def post_payment_transactions_id_void_online(id, space, opts = {})
  data, _status_code, _headers = post_payment_transactions_id_void_online_with_http_info(id, space, opts)
  data
end

#post_payment_transactions_id_void_online_with_http_info(id, space, opts = {}) ⇒ Array<(TransactionVoid, Integer, Hash)>

Returns TransactionVoid data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(TransactionVoid, Integer, Hash)>) —

    TransactionVoid data, response status code and response headers



2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 2784

def post_payment_transactions_id_void_online_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions_id_void_online ...'
  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 TransactionsService.post_payment_transactions_id_void_online"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions_id_void_online"
  end
  # resource path
  local_var_path = '/payment/transactions/{id}/void-online'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionVoid'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions_id_void_online",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions_id_void_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_payment_transactions_with_http_info(space, transaction_create, opts = {}) ⇒ Array<(Transaction, Integer, Hash)>

Returns Transaction data, response status code and response headers.

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

  • (Array<(Transaction, Integer, Hash)>) —

    Transaction data, response status code and response headers



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'lib/postfinancecheckout-ruby-sdk/service/transactions_service.rb', line 1629

def post_payment_transactions_with_http_info(space, transaction_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsService.post_payment_transactions ...'
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling TransactionsService.post_payment_transactions"
  end
  # verify the required parameter 'transaction_create' is set
  if @api_client.config.client_side_validation && transaction_create.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_create' when calling TransactionsService.post_payment_transactions"
  end
  # resource path
  local_var_path = '/payment/transactions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

  # form parameters
  form_params = opts[:form_params] || {}

  # connection timeout
  connection_timeout = @api_client.config.timeout

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_create)

  # return_type
  return_type = opts[:debug_return_type] || 'Transaction'

  new_options = opts.merge(
    :operation => :"TransactionsService.post_payment_transactions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsService#post_payment_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end