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.



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

def api_client
  @api_client
end

Instance Method Details

#delete_payment_instrument(payment_instrument_id, opts = {}) ⇒ nil

Delete a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**
A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.
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.
**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|      |**Deleting a Payment Instrument**
Your system can use this API to delete an existing Payment Instrument.
Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.

Parameters:

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


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

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

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

Delete a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**&lt;br&gt;A Payment Instrument represents tokenized payment information such as expiration date, billing address &amp; card type.&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;**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Deleting a Payment Instrument**&lt;br&gt;Your system can use this API to delete an existing Payment Instrument.&lt;br&gt;Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.

Parameters:

  • 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



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

def delete_payment_instrument_with_http_info(payment_instrument_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 '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 PaymentInstrumentApi.delete_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{paymentInstrumentId}'.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
  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(payment_instrument_id, opts = {}) ⇒ PostPaymentInstrumentRequest

Retrieve a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**
A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.
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.
**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Payment Instrument**
Your system can use this API to retrieve an existing Payment Instrument.
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:

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



103
104
105
106
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 103

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

#get_payment_instrument_with_http_info(payment_instrument_id, opts = {}) ⇒ Array<(PostPaymentInstrumentRequest, Fixnum, Hash)>

Retrieve a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**&lt;br&gt;A Payment Instrument represents tokenized payment information such as expiration date, billing address &amp; card type.&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;**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Retrieving a Payment Instrument**&lt;br&gt;Your system can use this API to retrieve an existing Payment Instrument.&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:

  • 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
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
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 114

def get_payment_instrument_with_http_info(payment_instrument_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 '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 PaymentInstrumentApi.get_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{paymentInstrumentId}'.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
  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 => 'PostPaymentInstrumentRequest')
  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

#patch_payment_instrument(payment_instrument_id, patch_payment_instrument_request, opts = {}) ⇒ PatchPaymentInstrumentRequest

Update a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**
A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.
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.
**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Payment Instrument**
Your system can use this API to update an existing Payment Instrument.

Parameters:

  • payment_instrument_id —

    The Id of a payment instrument.

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



179
180
181
182
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 179

def patch_payment_instrument(payment_instrument_id, patch_payment_instrument_request, opts = {})
  data, status_code, headers = patch_payment_instrument_with_http_info(payment_instrument_id, patch_payment_instrument_request, opts)
  return data, status_code, headers
end

#patch_payment_instrument_with_http_info(payment_instrument_id, patch_payment_instrument_request, opts = {}) ⇒ Array<(PatchPaymentInstrumentRequest, Fixnum, Hash)>

Update a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**&lt;br&gt;A Payment Instrument represents tokenized payment information such as expiration date, billing address &amp; card type.&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;**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Updating a Payment Instrument**&lt;br&gt;Your system can use this API to update an existing Payment Instrument.

Parameters:

  • payment_instrument_id —

    The Id of a payment instrument.

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



192
193
194
195
196
197
198
199
200
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
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 192

def patch_payment_instrument_with_http_info(payment_instrument_id, patch_payment_instrument_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.patch_payment_instrument ...'
        rescue
            puts 'Cannot write to log'
        end
  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 PaymentInstrumentApi.patch_payment_instrument"
  end
  # verify the required parameter 'patch_payment_instrument_request' is set
  if @api_client.config.client_side_validation && patch_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'patch_payment_instrument_request' when calling PaymentInstrumentApi.patch_payment_instrument"
  end
  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{paymentInstrumentId}'.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_payment_instrument_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PatchPaymentInstrumentRequest', @api_client.config.host)
  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 => 'PatchPaymentInstrumentRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentInstrumentApi#patch_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_payment_instrument(post_payment_instrument_request, opts = {}) ⇒ PostPaymentInstrumentRequest

Create a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**
A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.
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.
**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**
**Creating a Payment Instrument**
It is recommended you [create a Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_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 Payment Instruments**
To perform a payment with a particular Payment Instrument 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:

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



258
259
260
261
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 258

def post_payment_instrument(post_payment_instrument_request, opts = {})
  data, status_code, headers = post_payment_instrument_with_http_info(post_payment_instrument_request, opts)
  return data, status_code, headers
end

#post_payment_instrument_with_http_info(post_payment_instrument_request, opts = {}) ⇒ Array<(PostPaymentInstrumentRequest, Fixnum, Hash)>

Create a Payment Instrument | | | | | — | — | — | |**Standalone Payment Instruments**&lt;br&gt;A Payment Instrument represents tokenized payment information such as expiration date, billing address &amp; card type.&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;**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**&lt;br&gt;&lt;br&gt;**Creating a Payment Instrument**&lt;br&gt;It is recommended you [create a Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_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 Payment Instruments**&lt;br&gt;To perform a payment with a particular Payment Instrument 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:

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/cybersource_rest_client/api/payment_instrument_api.rb', line 269

def post_payment_instrument_with_http_info(post_payment_instrument_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.post_payment_instrument ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'post_payment_instrument_request' is set
  if @api_client.config.client_side_validation && post_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_payment_instrument_request' when calling PaymentInstrumentApi.post_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'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(post_payment_instrument_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostPaymentInstrumentRequest', @api_client.config.host)
  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 => 'PostPaymentInstrumentRequest')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentInstrumentApi#post_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