Class: CyberSource::PaymentInstrumentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of PaymentInstrumentApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_payment_instrument(profile_id, create_payment_instrument_request, opts = {}) ⇒ TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments

Create a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • create_payment_instrument_request —

    Specify the customer's payment details for card or bank account.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 28

def create_payment_instrument(profile_id, create_payment_instrument_request, opts = {})
  data, status_code, headers = create_payment_instrument_with_http_info(profile_id, create_payment_instrument_request, opts)
  return data, status_code, headers
end

#create_payment_instrument_with_http_info(profile_id, create_payment_instrument_request, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments, Fixnum, Hash)>

Create a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • create_payment_instrument_request —

    Specify the customer&#39;s payment details for card or bank account.

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

    the optional parameters

Returns:



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

def create_payment_instrument_with_http_info(profile_id, create_payment_instrument_request, opts = {})
  
	  if @api_client.config.debugging
begin
			raise
@api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.create_payment_instrument ...'
			rescue
puts 'Cannot write to log'
			end
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling PaymentInstrumentApi.create_payment_instrument"
  end
  if @api_client.config.client_side_validation && profile_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.create_payment_instrument, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && profile_id.to_s.length < 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.create_payment_instrument, the character length must be great than or equal to 36.'
  end

  # verify the required parameter 'create_payment_instrument_request' is set
  if @api_client.config.client_side_validation && create_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_payment_instrument_request' when calling PaymentInstrumentApi.create_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v1/paymentinstruments'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = profile_id

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_payment_instrument_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments')
  if @api_client.config.debugging
		begin
		raise
			@api_client.config.logger.debug "API called: PaymentInstrumentApi#create_payment_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
		rescue
			puts 'Cannot write to log'
		end
	  end
  return data, status_code, headers
end

#delete_payment_instrument(profile_id, token_id, opts = {}) ⇒ nil

Delete a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:

  • (nil) 


106
107
108
109
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 106

def delete_payment_instrument(profile_id, token_id, opts = {})
  data, status_code, headers = delete_payment_instrument_with_http_info(profile_id, token_id, opts)
  return data, status_code, headers
end

#delete_payment_instrument_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



116
117
118
119
120
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 116

def delete_payment_instrument_with_http_info(profile_id, token_id, opts = {})
  
	  if @api_client.config.debugging
begin
			raise
@api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.delete_payment_instrument ...'
			rescue
puts 'Cannot write to log'
			end
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling PaymentInstrumentApi.delete_payment_instrument"
  end
  if @api_client.config.client_side_validation && profile_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.delete_payment_instrument, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && profile_id.to_s.length < 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.delete_payment_instrument, the character length must be great than or equal to 36.'
  end

  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling PaymentInstrumentApi.delete_payment_instrument"
  end
  if @api_client.config.client_side_validation && token_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.delete_payment_instrument, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && token_id.to_s.length < 16
    fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.delete_payment_instrument, the character length must be great than or equal to 16.'
  end

  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = profile_id

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
		begin
		raise
			@api_client.config.logger.debug "API called: PaymentInstrumentApi#delete_payment_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
		rescue
			puts 'Cannot write to log'
		end
	  end
  return data, status_code, headers
end

#get_payment_instrument(profile_id, token_id, opts = {}) ⇒ TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments

Retrieve a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:



191
192
193
194
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 191

def get_payment_instrument(profile_id, token_id, opts = {})
  data, status_code, headers = get_payment_instrument_with_http_info(profile_id, token_id, opts)
  return data, status_code, headers
end

#get_payment_instrument_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments, Fixnum, Hash)>

Retrieve a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 201

def get_payment_instrument_with_http_info(profile_id, token_id, opts = {})
  
	  if @api_client.config.debugging
begin
			raise
@api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.get_payment_instrument ...'
			rescue
puts 'Cannot write to log'
			end
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling PaymentInstrumentApi.get_payment_instrument"
  end
  if @api_client.config.client_side_validation && profile_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.get_payment_instrument, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && profile_id.to_s.length < 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.get_payment_instrument, the character length must be great than or equal to 36.'
  end

  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling PaymentInstrumentApi.get_payment_instrument"
  end
  if @api_client.config.client_side_validation && token_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.get_payment_instrument, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && token_id.to_s.length < 16
    fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.get_payment_instrument, the character length must be great than or equal to 16.'
  end

  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = profile_id

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments')
  if @api_client.config.debugging
		begin
		raise
			@api_client.config.logger.debug "API called: PaymentInstrumentApi#get_payment_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
		rescue
			puts 'Cannot write to log'
		end
	  end
  return data, status_code, headers
end

#update_payment_instrument(profile_id, token_id, update_payment_instrument_request, opts = {}) ⇒ TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments

Update a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

  • update_payment_instrument_request —

    Specify the customer&#39;s payment details.

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

    the optional parameters

Returns:



278
279
280
281
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 278

def update_payment_instrument(profile_id, token_id, update_payment_instrument_request, opts = {})
  data, status_code, headers = update_payment_instrument_with_http_info(profile_id, token_id, update_payment_instrument_request, opts)
  return data, status_code, headers
end

#update_payment_instrument_with_http_info(profile_id, token_id, update_payment_instrument_request, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments, Fixnum, Hash)>

Update a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

  • update_payment_instrument_request —

    Specify the customer&#39;s payment details.

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

    the optional parameters

Returns:



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 289

def update_payment_instrument_with_http_info(profile_id, token_id, update_payment_instrument_request, opts = {})
  
	  if @api_client.config.debugging
begin
			raise
@api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.update_payment_instrument ...'
			rescue
puts 'Cannot write to log'
			end
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling PaymentInstrumentApi.update_payment_instrument"
  end
  if @api_client.config.client_side_validation && profile_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.update_payment_instrument, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && profile_id.to_s.length < 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.update_payment_instrument, the character length must be great than or equal to 36.'
  end

  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling PaymentInstrumentApi.update_payment_instrument"
  end
  if @api_client.config.client_side_validation && token_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.update_payment_instrument, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && token_id.to_s.length < 16
    fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.update_payment_instrument, the character length must be great than or equal to 16.'
  end

  # verify the required parameter 'update_payment_instrument_request' is set
  if @api_client.config.client_side_validation && update_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_payment_instrument_request' when calling PaymentInstrumentApi.update_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = profile_id

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(update_payment_instrument_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments')
  if @api_client.config.debugging
		begin
		raise
			@api_client.config.logger.debug "API called: PaymentInstrumentApi#update_payment_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
		rescue
			puts 'Cannot write to log'
		end
	  end
  return data, status_code, headers
end