Class: WhiteLabelMachineName::CardProcessingService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/card_processing_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CardProcessingService

Returns a new instance of CardProcessingService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/card_processing_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/card_processing_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#process(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {}) ⇒ Transaction

Process The process method will process the transaction with the given card details without using 3-D secure.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which should be processed.

  • payment_method_configuration_id —

    The payment method configuration ID which is applied to the transaction.

  • card_data —

    The card details as JSON in plain which should be used to authorize the payment.

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

    the optional parameters

Returns:



36
37
38
39
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/card_processing_service_api.rb', line 36

def process(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {})
  data, _status_code, _headers = process_with_http_info(space_id, transaction_id, payment_method_configuration_id, card_data, opts)
  return data
end

#process_with3_d_secure(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {}) ⇒ String

Process With 3-D Secure The process method will process the transaction with the given card details by eventually using 3-D secure. The buyer has to be redirect to the URL returned by this method.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which should be processed.

  • payment_method_configuration_id —

    The payment method configuration ID which is applied to the transaction.

  • card_data —

    The card details as JSON in plain which should be used to authorize the payment.

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

    the optional parameters

Returns:

  • (String) 


108
109
110
111
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/card_processing_service_api.rb', line 108

def process_with3_d_secure(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {})
  data, _status_code, _headers = process_with3_d_secure_with_http_info(space_id, transaction_id, payment_method_configuration_id, card_data, opts)
  return data
end

#process_with3_d_secure_with_http_info(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Process With 3-D Secure The process method will process the transaction with the given card details by eventually using 3-D secure. The buyer has to be redirect to the URL returned by this method.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which should be processed.

  • payment_method_configuration_id —

    The payment method configuration ID which is applied to the transaction.

  • card_data —

    The card details as JSON in plain which should be used to authorize the payment.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/card_processing_service_api.rb', line 121

def process_with3_d_secure_with_http_info(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CardProcessingService.process_with3_d_secure ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling CardProcessingService.process_with3_d_secure" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling CardProcessingService.process_with3_d_secure" if transaction_id.nil?
  # verify the required parameter 'payment_method_configuration_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_method_configuration_id' when calling CardProcessingService.process_with3_d_secure" if payment_method_configuration_id.nil?
  # verify the required parameter 'card_data' is set
  fail ArgumentError, "Missing the required parameter 'card_data' when calling CardProcessingService.process_with3_d_secure" if card_data.nil?
  # resource path
  local_var_path = "/card-processing/processWith3DSecure".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id
  query_params[:'paymentMethodConfigurationId'] = payment_method_configuration_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(card_data)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardProcessingService#process_with3_d_secure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#process_with_http_info(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Process The process method will process the transaction with the given card details without using 3-D secure.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which should be processed.

  • payment_method_configuration_id —

    The payment method configuration ID which is applied to the transaction.

  • card_data —

    The card details as JSON in plain which should be used to authorize the payment.

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

    the optional parameters

Returns:

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

    Transaction data, 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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/card_processing_service_api.rb', line 49

def process_with_http_info(space_id, transaction_id, payment_method_configuration_id, card_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CardProcessingService.process ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling CardProcessingService.process" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling CardProcessingService.process" if transaction_id.nil?
  # verify the required parameter 'payment_method_configuration_id' is set
  fail ArgumentError, "Missing the required parameter 'payment_method_configuration_id' when calling CardProcessingService.process" if payment_method_configuration_id.nil?
  # verify the required parameter 'card_data' is set
  fail ArgumentError, "Missing the required parameter 'card_data' when calling CardProcessingService.process" if card_data.nil?
  # resource path
  local_var_path = "/card-processing/process".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id
  query_params[:'paymentMethodConfigurationId'] = payment_method_configuration_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(card_data)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Transaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardProcessingService#process\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end