Class: CyberSource::InstrumentIdentifierApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of InstrumentIdentifierApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_instrument_identifier(instrument_identifier_id, opts = {}) ⇒ nil

Delete an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing
and account numbers.
The same token Id is returned for a specific card number or bank account & routing number allowing the
Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument)
or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|      |**Deleting an Instrument Identifier**
Your system can use this API to delete an existing Instrument Identifier.
An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.
You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

  • 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) 


30
31
32
33
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 30

def delete_instrument_identifier(instrument_identifier_id, opts = {})
  data, status_code, headers = delete_instrument_identifier_with_http_info(instrument_identifier_id, opts)
  return data, status_code, headers
end

#delete_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**&lt;br&gt;An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing &lt;br&gt;and account numbers.&lt;br&gt;The same token Id is returned for a specific card number or bank account &amp; routing number allowing the &lt;br&gt;Instrument Identifier Id to be used for cross-channel payment tracking.&lt;br&gt;An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) &lt;br&gt;or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Deleting an Instrument Identifier**&lt;br&gt;Your system can use this API to delete an existing Instrument Identifier.&lt;br&gt;An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.&lt;br&gt;You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

  • 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



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
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 41

def delete_instrument_identifier_with_http_info(instrument_identifier_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.delete_instrument_identifier ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'instrument_identifier_id' is set
  if @api_client.config.client_side_validation && instrument_identifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.delete_instrument_identifier"
  end
  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_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_instrument_identifier","delete_instrument_identifier_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: InstrumentIdentifierApi#delete_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_instrument_identifier(instrument_identifier_id, opts = {}) ⇒ PostInstrumentIdentifierRequest

Retrieve an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).
**Retrieving an Instrument Identifier**
Your system can use this API to retrieve an Instrument Identifier.
**Note: the actual card data will be masked.**
The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).|&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 Instrument Identifiers**
To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

Returns:



108
109
110
111
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 108

def get_instrument_identifier(instrument_identifier_id, opts = {})
  data, status_code, headers = get_instrument_identifier_with_http_info(instrument_identifier_id, opts)
  return data, status_code, headers
end

#get_instrument_identifier_payment_instruments_list(instrument_identifier_id, opts = {}) ⇒ PaymentInstrumentList1

List Payment Instruments for an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing
and account numbers.
The same token Id is returned for a specific card number or bank account & routing number allowing the
Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument)
or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Payment Instruments associated with an Instrument Identifier**
Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

  • :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:



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

def get_instrument_identifier_payment_instruments_list(instrument_identifier_id, opts = {})
  data, status_code, headers = get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts)
  return data, status_code, headers
end

#get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(PaymentInstrumentList1, Fixnum, Hash)>

List Payment Instruments for an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**&lt;br&gt;An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing &lt;br&gt;and account numbers.&lt;br&gt;The same token Id is returned for a specific card number or bank account &amp; routing number allowing the &lt;br&gt;Instrument Identifier Id to be used for cross-channel payment tracking.&lt;br&gt;An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) &lt;br&gt;or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Retrieving all Payment Instruments associated with an Instrument Identifier**&lt;br&gt;Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

  • :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<(PaymentInstrumentList1, Fixnum, Hash)>) —

    PaymentInstrumentList1 data, response status code and response headers



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
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 205

def get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'instrument_identifier_id' is set
  if @api_client.config.client_side_validation && instrument_identifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list"
  end
  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}/paymentinstruments'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'retrieveBinDetails'] = opts[:'retrieve_bin_details'] if !opts[:'retrieve_bin_details'].nil?
  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_instrument_identifier_payment_instruments_list","get_instrument_identifier_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 => 'PaymentInstrumentList1')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#get_instrument_identifier_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

#get_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(PostInstrumentIdentifierRequest, Fixnum, Hash)>

Retrieve an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**&lt;br&gt;An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;The same token Id is returned for a specific card number or bank account &amp; routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.&lt;br&gt;An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).&lt;br&gt;&lt;br&gt;**Retrieving an Instrument Identifier**&lt;br&gt;Your system can use this API to retrieve an Instrument Identifier.&lt;br&gt;**Note: the actual card data will be masked.**&lt;br&gt;The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).|&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 Instrument Identifiers**&lt;br&gt;To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, &amp; billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).&lt;br&gt;When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.&lt;br&gt;These values will be added for you to future Merchant Initiated Transaction payments.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

Returns:



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
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 120

def get_instrument_identifier_with_http_info(instrument_identifier_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.get_instrument_identifier ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'instrument_identifier_id' is set
  if @api_client.config.client_side_validation && instrument_identifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.get_instrument_identifier"
  end
  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'retrieveBinDetails'] = opts[:'retrieve_bin_details'] if !opts[:'retrieve_bin_details'].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_instrument_identifier","get_instrument_identifier_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 => 'PostInstrumentIdentifierRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#get_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#patch_instrument_identifier(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) ⇒ PatchInstrumentIdentifierRequest

Update an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating an Instrument Identifier**
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments.
Your system can use this API to update these values.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

  • patch_instrument_identifier_request —

    Specify the previous transaction Id to update.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

  • :if_match (String) —

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

Returns:



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

def patch_instrument_identifier(instrument_identifier_id, patch_instrument_identifier_request, opts = {})
  data, status_code, headers = patch_instrument_identifier_with_http_info(instrument_identifier_id, patch_instrument_identifier_request, opts)
  return data, status_code, headers
end

#patch_instrument_identifier_with_http_info(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) ⇒ Array<(PatchInstrumentIdentifierRequest, Fixnum, Hash)>

Update an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**&lt;br&gt;An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;The same token Id is returned for a specific card number or bank account &amp; routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.&lt;br&gt;An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Updating an Instrument Identifier**&lt;br&gt;When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.&lt;br&gt;These values will be added for you to future Merchant Initiated Transaction payments.&lt;br&gt;Your system can use this API to update these values.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

  • patch_instrument_identifier_request —

    Specify the previous transaction Id to update.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

  • :if_match (String) —

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

Returns:



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
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 292

def patch_instrument_identifier_with_http_info(instrument_identifier_id, patch_instrument_identifier_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.patch_instrument_identifier ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'instrument_identifier_id' is set
  if @api_client.config.client_side_validation && instrument_identifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.patch_instrument_identifier"
  end
  # verify the required parameter 'patch_instrument_identifier_request' is set
  if @api_client.config.client_side_validation && patch_instrument_identifier_request.nil?
    fail ArgumentError, "Missing the required parameter 'patch_instrument_identifier_request' when calling InstrumentIdentifierApi.patch_instrument_identifier"
  end
  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'retrieveBinDetails'] = opts[:'retrieve_bin_details'] if !opts[:'retrieve_bin_details'].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?
  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_instrument_identifier_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PatchInstrumentIdentifierRequest', @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_instrument_identifier","patch_instrument_identifier_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 => 'PatchInstrumentIdentifierRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#patch_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#post_instrument_identifier(post_instrument_identifier_request, opts = {}) ⇒ PostInstrumentIdentifierRequest

Create an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).
**Creating an Instrument Identifier**
It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.
An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)
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 Instrument Identifiers**
To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments.

Parameters:

  • post_instrument_identifier_request —

    Specify either a Card, Bank Account or Enrollable Card

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

Returns:



364
365
366
367
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 364

def post_instrument_identifier(post_instrument_identifier_request, opts = {})
  data, status_code, headers = post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts)
  return data, status_code, headers
end

#post_instrument_identifier_enrollment(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ nil

Enroll an Instrument Identifier for Payment Network Token | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Enroll an Instrument Identifier for a Payment Network Token**
Your system can use this API to provision a Network token for an existing Instrument Identifier.
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#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) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.
For more information about Payment Network Tokens see the Developer Guide.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

  • post_instrument_identifier_enrollment_request —

    Specify Enrollable Card details

  • 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) 


443
444
445
446
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 443

def post_instrument_identifier_enrollment(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {})
  data, status_code, headers = post_instrument_identifier_enrollment_with_http_info(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts)
  return data, status_code, headers
end

#post_instrument_identifier_enrollment_with_http_info(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Enroll an Instrument Identifier for Payment Network Token | | | | | — | — | — | |**Instrument Identifiers**&lt;br&gt;An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;The same token Id is returned for a specific card number or bank account &amp; routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.&lt;br&gt;An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Enroll an Instrument Identifier for a Payment Network Token**&lt;br&gt;Your system can use this API to provision a Network token for an existing Instrument Identifier.&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 Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#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) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.&lt;br&gt;For more information about Payment Network Tokens see the Developer Guide.

Parameters:

  • instrument_identifier_id —

    The Id of an Instrument Identifier.

  • post_instrument_identifier_enrollment_request —

    Specify Enrollable Card details

  • 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



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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 455

def post_instrument_identifier_enrollment_with_http_info(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.post_instrument_identifier_enrollment ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'instrument_identifier_id' is set
  if @api_client.config.client_side_validation && instrument_identifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment"
  end
  # verify the required parameter 'post_instrument_identifier_enrollment_request' is set
  if @api_client.config.client_side_validation && post_instrument_identifier_enrollment_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_instrument_identifier_enrollment_request' when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment"
  end
  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}/enrollment'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_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_instrument_identifier_enrollment_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostInstrumentIdentifierEnrollmentRequest', @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_instrument_identifier_enrollment","post_instrument_identifier_enrollment_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)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#post_instrument_identifier_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts = {}) ⇒ Array<(PostInstrumentIdentifierRequest, Fixnum, Hash)>

Create an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**&lt;br&gt;An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.&lt;br&gt;The same token Id is returned for a specific card number or bank account &amp; routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.&lt;br&gt;An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).&lt;br&gt;&lt;br&gt;**Creating an Instrument Identifier**&lt;br&gt;It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.&lt;br&gt;An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)&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 Instrument Identifiers**&lt;br&gt;To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, &amp; billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).&lt;br&gt;When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.&lt;br&gt;These values will be added for you to future Merchant Initiated Transaction payments.

Parameters:

  • post_instrument_identifier_request —

    Specify either a Card, Bank Account or Enrollable Card

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :retrieve_bin_details (BOOLEAN) —

    Retrieve the Bin Details of PAN or network token

Returns:



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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 376

def post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.post_instrument_identifier ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'post_instrument_identifier_request' is set
  if @api_client.config.client_side_validation && post_instrument_identifier_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_instrument_identifier_request' when calling InstrumentIdentifierApi.post_instrument_identifier"
  end
  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers'

  # query parameters
  query_params = {}
  query_params[:'retrieveBinDetails'] = opts[:'retrieve_bin_details'] if !opts[:'retrieve_bin_details'].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)
  post_body = @api_client.object_to_http_body(post_instrument_identifier_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostInstrumentIdentifierRequest', @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_instrument_identifier","post_instrument_identifier_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 => 'PostInstrumentIdentifierRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#post_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end