Class: CyberSource::CustomerPaymentInstrumentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CustomerPaymentInstrumentApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#delete_customer_payment_instrument(customer_id, payment_instrument_id, opts = {}) ⇒ nil

Delete a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**
A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.
A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.
|      |**Deleting a Customers Payment Instrument**
Your system can use this API to delete an existing Payment Instrument for a Customer.
Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.
If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • payment_instrument_id —

    The Id of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:

  • (nil) 


31
32
33
34
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 31

def delete_customer_payment_instrument(customer_id, payment_instrument_id, opts = {})
  data, status_code, headers = delete_customer_payment_instrument_with_http_info(customer_id, payment_instrument_id, opts)
  return data, status_code, headers
end

#delete_customer_payment_instrument_with_http_info(customer_id, payment_instrument_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**&lt;br&gt;A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address &amp; card type.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.&lt;br&gt;A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Deleting a Customers Payment Instrument**&lt;br&gt;Your system can use this API to delete an existing Payment Instrument for a Customer.&lt;br&gt;Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.&lt;br&gt;If a customer has more than one Payment Instrument then the default Payment Instrument cannot be deleted without first selecting a [new default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • payment_instrument_id —

    The Id of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:

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

    nil, response status code and response headers



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

def delete_customer_payment_instrument_with_http_info(customer_id, payment_instrument_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerPaymentInstrumentApi.delete_customer_payment_instrument ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerPaymentInstrumentApi.delete_customer_payment_instrument"
  end
  # verify the required parameter 'payment_instrument_id' is set
  if @api_client.config.client_side_validation && payment_instrument_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_instrument_id' when calling CustomerPaymentInstrumentApi.delete_customer_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'paymentInstrumentId' + '}', payment_instrument_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'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  if 'DELETE' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  is_mle_supported_by_cybs_for_api = false
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, is_mle_supported_by_cybs_for_api, ["delete_customer_payment_instrument","delete_customer_payment_instrument_with_http_info"])
    post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
  end
  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: CustomerPaymentInstrumentApi#delete_customer_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_customer_payment_instrument(customer_id, payment_instrument_id, opts = {}) ⇒ PostCustomerPaymentInstrumentRequest

Retrieve a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**
A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.
A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Payment Instrument**
Your system can use this API to retrieve an existing Payment Instrument for a Customer.
To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • payment_instrument_id —

    The Id of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



114
115
116
117
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 114

def get_customer_payment_instrument(customer_id, payment_instrument_id, opts = {})
  data, status_code, headers = get_customer_payment_instrument_with_http_info(customer_id, payment_instrument_id, opts)
  return data, status_code, headers
end

#get_customer_payment_instrument_with_http_info(customer_id, payment_instrument_id, opts = {}) ⇒ Array<(PostCustomerPaymentInstrumentRequest, Fixnum, Hash)>

Retrieve a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**&lt;br&gt;A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address &amp; card type.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.&lt;br&gt;A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Retrieving a Customer Payment Instrument**&lt;br&gt;Your system can use this API to retrieve an existing Payment Instrument for a Customer.&lt;br&gt;To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • payment_instrument_id —

    The Id of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 126

def get_customer_payment_instrument_with_http_info(customer_id, payment_instrument_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerPaymentInstrumentApi.get_customer_payment_instrument ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerPaymentInstrumentApi.get_customer_payment_instrument"
  end
  # verify the required parameter 'payment_instrument_id' is set
  if @api_client.config.client_side_validation && payment_instrument_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_instrument_id' when calling CustomerPaymentInstrumentApi.get_customer_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'paymentInstrumentId' + '}', payment_instrument_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'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  is_mle_supported_by_cybs_for_api = false
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, is_mle_supported_by_cybs_for_api, ["get_customer_payment_instrument","get_customer_payment_instrument_with_http_info"])
    post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
  end
  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 => 'PostCustomerPaymentInstrumentRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#get_customer_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_customer_payment_instruments_list(customer_id, opts = {}) ⇒ PaymentInstrumentList

List Payment Instruments for a Customer | | | | | — | — | — | |**Customer Payment Instrument**
A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.
A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Payment Instruments**
Your system can use this API to retrieve all existing Payment Instruments for a Customer.

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :offset (Integer) —

    Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (default to 0)

  • :limit (Integer) —

    The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (default to 20)

Returns:



199
200
201
202
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 199

def get_customer_payment_instruments_list(customer_id, opts = {})
  data, status_code, headers = get_customer_payment_instruments_list_with_http_info(customer_id, opts)
  return data, status_code, headers
end

#get_customer_payment_instruments_list_with_http_info(customer_id, opts = {}) ⇒ Array<(PaymentInstrumentList, Fixnum, Hash)>

List Payment Instruments for a Customer | | | | | — | — | — | |**Customer Payment Instrument**&lt;br&gt;A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address &amp; card type.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.&lt;br&gt;A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Retrieving all Customer Payment Instruments**&lt;br&gt;Your system can use this API to retrieve all existing Payment Instruments for a Customer.

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :offset (Integer) —

    Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.

  • :limit (Integer) —

    The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.

Returns:

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

    PaymentInstrumentList data, response status code and response headers



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

def get_customer_payment_instruments_list_with_http_info(customer_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerPaymentInstrumentApi.get_customer_payment_instruments_list ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerPaymentInstrumentApi.get_customer_payment_instruments_list"
  end
  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/payment-instruments'.sub('{' + 'customerId' + '}', customer_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  is_mle_supported_by_cybs_for_api = false
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, is_mle_supported_by_cybs_for_api, ["get_customer_payment_instruments_list","get_customer_payment_instruments_list_with_http_info"])
    post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
  end
  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 => 'PaymentInstrumentList')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#get_customer_payment_instruments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#patch_customers_payment_instrument(customer_id, payment_instrument_id, patch_customer_payment_instrument_request, opts = {}) ⇒ PatchCustomerPaymentInstrumentRequest

Update a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**
A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.
A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Payment Instrument**
Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

  • customer_id —

    The Id of a Customer.

  • payment_instrument_id —

    The Id of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :if_match (String) —

    Contains an ETag value from a GET request to make the request conditional.

Returns:



284
285
286
287
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 284

def patch_customers_payment_instrument(customer_id, payment_instrument_id, patch_customer_payment_instrument_request, opts = {})
  data, status_code, headers = patch_customers_payment_instrument_with_http_info(customer_id, payment_instrument_id, patch_customer_payment_instrument_request, opts)
  return data, status_code, headers
end

#patch_customers_payment_instrument_with_http_info(customer_id, payment_instrument_id, patch_customer_payment_instrument_request, opts = {}) ⇒ Array<(PatchCustomerPaymentInstrumentRequest, Fixnum, Hash)>

Update a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**&lt;br&gt;A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address &amp; card type.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.&lt;br&gt;A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Updating a Customers Payment Instrument**&lt;br&gt;Your system can use this API to update an existing Payment Instrument for a Customer, including selecting a [default Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument_samplerequests-dropdown_make-customer-payment-instrument-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

  • customer_id —

    The Id of a Customer.

  • payment_instrument_id —

    The Id of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :if_match (String) —

    Contains an ETag value from a GET request to make the request conditional.

Returns:



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/customer_payment_instrument_api.rb', line 298

def patch_customers_payment_instrument_with_http_info(customer_id, payment_instrument_id, patch_customer_payment_instrument_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerPaymentInstrumentApi.patch_customers_payment_instrument ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerPaymentInstrumentApi.patch_customers_payment_instrument"
  end
  # verify the required parameter 'payment_instrument_id' is set
  if @api_client.config.client_side_validation && payment_instrument_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_instrument_id' when calling CustomerPaymentInstrumentApi.patch_customers_payment_instrument"
  end
  # verify the required parameter 'patch_customer_payment_instrument_request' is set
  if @api_client.config.client_side_validation && patch_customer_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'patch_customer_payment_instrument_request' when calling CustomerPaymentInstrumentApi.patch_customers_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/payment-instruments/{paymentInstrumentId}'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'paymentInstrumentId' + '}', payment_instrument_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'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  header_params[:'if-match'] = opts[:'if_match'] if !opts[:'if_match'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(patch_customer_payment_instrument_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PatchCustomerPaymentInstrumentRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  is_mle_supported_by_cybs_for_api = false
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, is_mle_supported_by_cybs_for_api, ["patch_customers_payment_instrument","patch_customers_payment_instrument_with_http_info"])
    post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
  end
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PatchCustomerPaymentInstrumentRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#patch_customers_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

#post_customer_payment_instrument(customer_id, post_customer_payment_instrument_request, opts = {}) ⇒ PostCustomerPaymentInstrumentRequest

Create a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**
A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.
A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.
**Creating a Customer Payment Instrument**
It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body), this can be for a zero amount.
In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).
For more information about Payment Network Tokens see the Developer Guide.
**Payments with Customers Payment Instrument**
To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



373
374
375
376
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 373

def post_customer_payment_instrument(customer_id, post_customer_payment_instrument_request, opts = {})
  data, status_code, headers = post_customer_payment_instrument_with_http_info(customer_id, post_customer_payment_instrument_request, opts)
  return data, status_code, headers
end

#post_customer_payment_instrument_with_http_info(customer_id, post_customer_payment_instrument_request, opts = {}) ⇒ Array<(PostCustomerPaymentInstrumentRequest, Fixnum, Hash)>

Create a Customer Payment Instrument | | | | | — | — | — | |**Customer Payment Instrument**&lt;br&gt;A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address &amp; card type.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.&lt;br&gt;A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;&lt;br&gt;**Creating a Customer Payment Instrument**&lt;br&gt;It is recommended you [create a Customer Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body), this can be for a zero amount.&lt;br&gt;In Europe: You should perform Payer Authentication alongside the Authorization.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Payment Network Tokens**&lt;br&gt;Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.&lt;br&gt;A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.&lt;br&gt;A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).&lt;br&gt;For more information about Payment Network Tokens see the Developer Guide.&lt;br&gt;&lt;br&gt;**Payments with Customers Payment Instrument**&lt;br&gt;To perform a payment with a particular Payment Instrument or Shipping Address specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 385

def post_customer_payment_instrument_with_http_info(customer_id, post_customer_payment_instrument_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerPaymentInstrumentApi.post_customer_payment_instrument ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerPaymentInstrumentApi.post_customer_payment_instrument"
  end
  # verify the required parameter 'post_customer_payment_instrument_request' is set
  if @api_client.config.client_side_validation && post_customer_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_customer_payment_instrument_request' when calling CustomerPaymentInstrumentApi.post_customer_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/payment-instruments'.sub('{' + 'customerId' + '}', customer_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'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(post_customer_payment_instrument_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostCustomerPaymentInstrumentRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  is_mle_supported_by_cybs_for_api = false
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, is_mle_supported_by_cybs_for_api, ["post_customer_payment_instrument","post_customer_payment_instrument_with_http_info"])
    post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
  end
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PostCustomerPaymentInstrumentRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#post_customer_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